Back to index
Summary
Evaluates and runs a CloudBees CD/RO domain-specific language (DSL) script.dslStringrequiredThe DSL text. applicationNameStringoptionalThe name of the application container of the property sheet that owns the property. applicationTierNameStringoptionalThe name of the application tier container of the property sheet that owns the property. archiveConnectorNameStringoptionalThe name of the archive connector of the property sheet that owns the property. artifactNameStringoptionalThe name of the artifact container of the property sheet that owns the property. artifactVersionNameStringoptionalThe name of the artifactVersion container of the property sheet that owns the property. catalogItemRunIdStringoptionalThe primary key of the CatalogItemRun container of the property sheet that owns the property. catalogNameStringoptionalThe name of the catalog of the property sheet that owns the property. ciBuildDetailNameStringoptionalThe name of the CI build detail of the property sheet that owns the property. clusterNameStringoptionalThe name of the cluster which owns property sheet. componentNameStringoptionalThe name of the component container of the property sheet that owns the property. configNameStringoptionalThe name of the emailConfig container that owns the property. credentialNameStringoptionalThe name of the credential container of the property sheet that owns the property. dashboardNameStringoptionalThe name of the dashboard of the property sheet that owns the property. dataRetentionPolicyNameStringoptionalThe name of the data retention policy of the property sheet that owns the property. debugBooleanoptionalTrue to include debug output. describeBooleanoptionalTrue to return help description for the DSL text. disableAllValidationsBooleanoptionalTo disable all validation checks, pass '1'. environmentNameStringoptionalThe name of the environment container of the property sheet that owns the property. environmentTemplateNameStringoptionalThe name of the environment template container of the property sheet that owns the property. environmentTemplateTierNameStringoptionalThe name of the environment template tier container of the property sheet that owns the property. environmentTierNameStringoptionalThe name of the environment tier container of the property sheet that owns the property. flowNameStringoptionalThe name of the flow container of the property sheet that owns the property. flowRuntimeIdStringoptionalThe primary key or name of the flowRuntime container of the property sheet that owns the property. flowRuntimeNameStringoptionalThe name of the flow runtime container of the property sheet that owns the property. flowRuntimeStateIdStringoptionalThe primary key or name of the flowRuntimeState container of the property sheet that owns the property. flowRuntimeStateNameStringoptionalThe name of the flow state container of the property sheet that owns the property. flowStateNameStringoptionalThe name of the flow state container of the property sheet that owns the property. flowTransitionNameStringoptionalThe name of the flow transition container of the property sheet that owns the property. formatStringoptionalFormat to use for the DSL. Defaults to groovy format.Possible values: "groovy" , "yaml" gateTypeStringoptionalThe type of the gate which owns property sheet. Possible values: "POST" , "PRE" gatewayNameStringoptionalThe name of the gateway container of the property sheet. groupNameStringoptionalThe name of the group container of the property sheet that owns the property. helpFormatStringoptionalFormat to use for the DSL help content. Possible values: "asciidoc" , "html" , "openapi" , "structured" , "text" , "yamlSchema" , "yamlSchema_nested" , "yamlText" jobIdStringoptionalThe primary key or name of the job container of the property sheet that owns the property. jobStepIdUUIDoptionalThe primary key of the job-step container of the property sheet that owns the property. microserviceNameStringoptionalThe name of the microservice container of the property sheet. notifierNameStringoptionalThe name of the notifier container of the property sheet that owns the property. objectIdStringoptionalThe object ID as returned by FindObjects. overwriteBooleanoptionalTrue to use overwrite mode. If the object exists, all existing attributes of the object will be overwritten by the values in the DSL.parametersStringoptionalJSON text which is parsed and passed to the DSL as a map. pathStringoptionalProperty path string. pipelineNameStringoptionalThe name of the pipeline container of the property sheet that owns the property. pluginConfigurationNameStringoptionalThe name of the plugin configuration container of the property sheet that owns the property. pluginNameStringoptionalThe name of the plugin container of the property sheet that owns the property. procedureNameStringoptionalThe name of the procedure container of the property sheet that owns the property. processNameStringoptionalThe name of the process, if the container is a process or process step. processStepNameStringoptionalThe name of the process step, if the container is a process step. projectNameStringoptionalThe name of the project container of the property sheet that owns the property. propertySheetIdUUIDoptionalThe primary key of the property sheet that owns the property. releaseNameStringoptionalThe name of the release container of the property sheet that owns the property. reportNameStringoptionalThe name of the report of the property sheet that owns the property. reportObjectTypeNameStringoptionalThe name of the report object type of the property sheet that owns the property. repositoryNameStringoptionalThe name of the repository container of the property sheet that owns the property. resourceNameStringoptionalThe name of the resource container of the property sheet that owns the property. resourcePoolNameStringoptionalThe name of the resource pool container of the property sheet that owns the property. resourceTemplateNameStringoptionalThe name of the resource template container of the property sheet that owns the property. scheduleNameStringoptionalThe name of the schedule container of the property sheet. scmSyncNameStringoptionalThe name of the SCM Sync container of the property sheet that owns the property. searchFilterNameStringoptionalThe name of the search filter container of the property sheet. serverLibraryPathStringoptionalPath to the server directory that contains jar files and classes to be added to the classpath when evaluating the DSL text. serviceAccountNameStringoptionalRetrieves the name of the service account container of the property sheet. sessionPasswordStringoptionalSession user's password. Used to re-verify identity before changing user passwords in the system. skipOverwriteTypesStringoptionalpreviewThis argument is in preview mode, and therefore subject to change. JSON containing lists of parent object types and child types as 'parentTypes' and 'childTypes' respectively that will not be overwritten in the DSL when overwrite mode is used.snapshotNameStringoptionalThe name of the snapshot container of the property sheet that owns the property. stageNameStringoptionalThe name of the stage container of the property sheet that owns the property. stateDefinitionNameStringoptionalThe name of the state definition container of the property sheet that owns the property. stateNameStringoptionalThe name of the state container of the property sheet that owns the property. stepNameStringoptionalThe name of the step container of the property sheet that owns the property. systemObjectNameStringoptionalThe system object. Possible values: "admin" , "analyticsServerConfigurations" , "archiveConnectors" , "artifacts" , "ciConfigurations" , "ciEventsSchemaConfiguration" , "ciJobDetails" , "ciLoginHistory" , "complianceConfiguration" , "dataRetentionPolicies" , "devOpsForesight" , "devOpsInsightServerConfigurations" , "directory" , "dslClientFiles" , "emailConfigs" , "forceAbort" , "licensing" , "log" , "personaCategories" , "personaPages" , "personas" , "plugins" , "priority" , "projects" , "reportObjectTypes" , "repositories" , "resources" , "searchFilters" , "server" , "session" , "ssoConfiguration" , "ssoLoginHistory" , "statsdConfiguration" , "tags" , "test" , "workspaces" , "zonesAndGateways" taskNameStringoptionalThe name of the task which owns property sheet. timeoutLongoptionalMaximum duration of execution for the given DSL, in seconds. Defaults to maxDslDuration server setting.transitionDefinitionNameStringoptionalThe name of the transition definition container of the property sheet that owns the property. transitionNameStringoptionalThe name of the transition container of the property sheet that owns the property. triggerNameStringoptionalThe name of the trigger which owns property sheet. userNameStringoptionalThe name of the user container of the property sheet that owns the property. widgetNameStringoptionalThe name of the widget of the property sheet that owns the property. workflowDefinitionNameStringoptionalThe name of the workflow definition container of the property sheet that owns the property. workflowNameStringoptionalThe name of the workflow container of the property sheet that owns the property. workspaceNameStringoptionalThe name of the workspace container of the property sheet. zoneNameStringoptionalThe name of the zone container of the property sheet. |
Usage
Perl
$cmdr->evalDsl( "test-dsl" # dsl # optionals );
ectool
ectool evalDsl \ "test-dsl" `# dsl` \ # optionals