CloudBees CD/RO supports these DSL methods:
Name | Description |
---|---|
An access control list; controls access to domain objects. |
|
An individual access control list entry; allows or denies a privilege on a domain object. |
|
A name/value pair that is passed to a procedure when it is invoked. |
|
A username/password stored in the server as encrypted data. Typically used in an agent context to authenticate with a third-party system. The password is <em>not</em> available in the web context for security reasons, so this object has no getPassword method. |
|
Application representation. |
|
Represents a application dependency on other applications or service |
|
A logical grouping of a components that are part of an application and the resources they should be deployed on |
|
Archive Connector. |
|
Encapsulates various metadata about Artifacts. |
|
Encapsulates various metadata about ArtifactVersions. |
|
Self Service dashboard catalog, the container of catalog items. |
|
Self Service dashboard catalog item |
|
CI configuration. |
|
Represents a pool of resources on the cloud |
|
A component of an application architecture. |
|
A username/password stored in the server as encrypted data. Typically used in an agent context to authenticate with a third-party system. The password value is not available in the web context for security reasons, so this object has no getPassword method. |
|
Credential provider. |
|
Report dashboard, the container of report widgets. |
|
Data Retention Policy. |
|
Represents an application that will be deployed as part of deployer used in a release |
|
Contains configuration for an application to be deployed in a release |
|
A DevOps Insight data source object. |
|
Contains information about the configuration used to communicate with an external directory service (LDAP or ActiveDirectory). |
|
Encapsulates all of the mail server configuration information necessary for the Commander server to send an outbound e-mail message. |
|
E-mail notification to be sent when a particular event occurs. |
|
The environment to which an application is deployed. |
|
The environment template. |
|
The environment template tier belonging to an environment template. |
|
A map to hold mappings between application and an environment template tiers. |
|
A mapping between an application tier and an environment template tier. |
|
The environment tier belonging to an environment. |
|
A name and value pair that is passed to create an output parameter on procedure/process/pipeline. |
|
An unbound parameter defined on a procedure, workflow definition, etc. |
|
Tasks container belonging to stage |
|
A secured connection between two zones for sharing or transferring information between the zones. |
|
A group of users. |
|
A resource template hook that stores a reference to a procedure in an ElectricFlow project or plugin project. When a resource template is used to create a resource pool, these procedures are invoked. |
|
An instance of a procedure run. |
|
A step in a job. |
|
Kerberos keytab representation |
|
License data in XML format that describes the usage to which you are entitled. |
|
A microservice representation |
|
A mapping between an microservice and an environment cluster |
|
An api that allows to create or modify notes on an object. |
|
OpenIDConnect Configuration representation |
|
A persona for a user or group. |
|
A persona category. |
|
A persona page. |
|
pipeline representation. |
|
An add-on program used by CloudBees CD/RO to integrate with third-party tools, custom dashboards, and unique user experiences based on roles. |
|
Plugin configuration. |
|
Container for steps that execute some task. |
|
An application or component process. |
|
Represents a dependency between process steps. |
|
A step in an application or component process. |
|
Container for a group of related procedures and schedules. |
|
A custom attribute attached to any CloudBees CD/RO object. This may be a key, string-value pair or a complex structure, where the value is a reference to a property sheet containing nested properties. |
|
Release object |
|
DevOps Insight Report object |
|
Report object association. |
|
Report object attribute. |
|
Report object type. |
|
Reporting filter. |
|
Encapsulates various metadata about Repositories. |
|
The reservation |
|
Abstract reference to an agent, responsible for running step commands. |
|
A collection of resources with a ordering policy. |
|
A template with the required information to provision and later spin up cloud resources on an on-demand basis. |
|
Represents a rolling deploy phase |
|
SAML Identity Provider Configuration representation |
|
Saml Service Provider Configuration representation |
|
This object is responsible for launching a procedure at some time in the future, possibly on a regular interval. |
|
Represents a Git Synchronization configuration |
|
Search filter representation. |
|
A service account object. |
|
A version of an application or service with specific artifact versions and the state of the application or service at any point in time. |
|
Logical grouping of pipeline tasks |
|
A state definition in a workflow definition. Each workflow can contain one or more states. |
|
A unit of logic that will execute on an agent. |
|
Categorize objects using tags |
|
A representation of task within a stage or gate. |
|
A map to hold mappings between application and an environment tiers. |
|
A mapping between an application tier and an environment tier. |
|
Defines how a workflow must transition from one state to another. |
|
The object responsible for triggering objects by some events |
|
A user object. |
|
User email address. |
|
Utility resource representation. |
|
Represents a dependency defined on a stage or task. |
|
Dashboard widget |
|
Widget filter override. |
|
A top-level workflow object, which is a container for states, and transitions, and other information defining your workflow. |
|
File system directory in which a JobStep’s logs and often its artifactVersions are stored. |
|
A zone or top-level network created as a way to partition a collection of agents to secure them from use by other groups. |
acl
An access control list; controls access to domain objects.
Optional Arguments
Name | Description |
---|---|
applicationName |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
The name of the catalog of the property sheet that owns the property. |
ciBuildDetailName |
The name of the CI build detail of the property sheet that owns the property. |
ciConfigurationName |
The name of the CI Configuration. |
clusterName |
The name of the cluster which owns property sheet. |
componentName |
The name of the component container of the property sheet that owns the property. |
configName |
The name of the emailConfig container that owns the property. |
credentialName |
The name of the credential container of the property sheet that owns the property. |
credentialProviderName |
Unique name of the credential provider within the project. |
dashboardName |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
The name of the data retention policy of the property sheet that owns the property. |
environmentName |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
The name of the environment tier container of the property sheet that owns the property. |
flowName |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
The type of the gate which owns property sheet. |
gatewayName |
The name of the gateway container of the property sheet. |
groupName |
The name of the group container of the property sheet that owns the property. |
jobId |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
The primary key of the job-step container of the property sheet that owns the property. |
kerberosKeytabName |
The name of the kerberos keytab. |
microserviceName |
The name of the microservice container of the property sheet. |
notifierName |
The name of the notifier container of the property sheet that owns the property. |
objectId |
The object ID as returned by FindObjects. |
objectType |
The type of object protected by the access control |
path |
Property path string. |
personaName |
The name of the persona. |
pipelineName |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
The name of the procedure container of the property sheet that owns the property. |
processName |
The name of the process, if the container is a process or process step. |
processStepName |
The name of the process step, if the container is a process step. |
projectName |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
The primary key of the property sheet that owns the property. |
releaseName |
The name of the release container of the property sheet that owns the property. |
reportName |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
The name of the repository container of the property sheet that owns the property. |
resourceName |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
The name of the schedule container of the property sheet. |
scmSyncName |
The name of the Scm Sync container of the property sheet that owns the property. |
searchFilterName |
The name of the search filter container of the property sheet. |
serviceAccountName |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
The name of the state definition container of the property sheet that owns the property. |
stateName |
The name of the state container of the property sheet that owns the property. |
stepName |
The name of the step container of the property sheet that owns the property. |
systemObjectName |
The system object. |
tagName |
The name of the tag. |
taskName |
The name of the task which owns property sheet. |
transitionDefinitionName |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
The name of the transition container of the property sheet that owns the property. |
triggerName |
The name of the trigger which owns property sheet. |
userName |
The name of the user container of the property sheet that owns the property. |
widgetName |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
The name of the workspace container of the property sheet. |
zoneName |
The name of the zone container of the property sheet. |
aclEntry
An individual access control list entry; allows or denies a privilege on a domain object.
Required Arguments
Name | Description |
---|---|
principalName |
Name of the user or group for this access control entry. |
principalType |
Type of principal for this access control entry (user or group). |
Optional Arguments
Name | Description |
---|---|
applicationName |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
The name of the catalog of the property sheet that owns the property. |
changePermissionsPrivilege |
Determines whether the principal can modify access control for the object. |
ciBuildDetailName |
The name of the CI build detail of the property sheet that owns the property. |
ciConfigurationName |
The name of the CI Configuration. |
clusterName |
The name of the cluster which owns property sheet. |
componentName |
The name of the component container of the property sheet that owns the property. |
configName |
The name of the emailConfig container that owns the property. |
credentialName |
The name of the credential container of the property sheet that owns the property. |
credentialProviderName |
Unique name of the credential provider within the project. |
dashboardName |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
The name of the data retention policy of the property sheet that owns the property. |
environmentName |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
The name of the environment tier container of the property sheet that owns the property. |
executePrivilege |
Determines whether the principal can invoke this object as part of a job; this privilege is only relevant for a few objects such as procedures and procedure steps. |
flowName |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
The type of the gate which owns property sheet. |
gatewayName |
The name of the gateway container of the property sheet. |
groupName |
The name of the group container of the property sheet that owns the property. |
jobId |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
The primary key of the job-step container of the property sheet that owns the property. |
kerberosKeytabName |
The name of the kerberos keytab. |
microserviceName |
The name of the microservice container of the property sheet. |
modifyPrivilege |
Determines whether the principal can change the contents of the object. |
notifierName |
The name of the notifier container of the property sheet that owns the property. |
objectId |
The object ID as returned by FindObjects. |
objectType |
The type of object protected by the access control |
path |
Property path string. |
personaName |
The name of the persona. |
pipelineName |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
The name of the procedure container of the property sheet that owns the property. |
processName |
The name of the process, if the container is a process or process step. |
processStepName |
The name of the process step, if the container is a process step. |
projectName |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
The primary key of the property sheet that owns the property. |
readPrivilege |
Determines whether the principal can examine the contents of the object. |
releaseName |
The name of the release container of the property sheet that owns the property. |
reportName |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
The name of the repository container of the property sheet that owns the property. |
resourceName |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
The name of the schedule container of the property sheet. |
scmSyncName |
The name of the Scm Sync container of the property sheet that owns the property. |
searchFilterName |
The name of the search filter container of the property sheet. |
serviceAccountName |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
The name of the state definition container of the property sheet that owns the property. |
stateName |
The name of the state container of the property sheet that owns the property. |
stepName |
The name of the step container of the property sheet that owns the property. |
systemObjectName |
The system object. |
tagName |
The name of the tag. |
taskName |
The name of the task which owns property sheet. |
transitionDefinitionName |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
The name of the transition container of the property sheet that owns the property. |
triggerName |
The name of the trigger which owns property sheet. |
userName |
The name of the user container of the property sheet that owns the property. |
widgetName |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
The name of the workspace container of the property sheet. |
zoneName |
The name of the zone container of the property sheet. |
actualParameter
A name/value pair that is passed to a procedure when it is invoked.
Required Arguments
Name | Description |
---|---|
actualParameterName |
The name of the parameter to create/modify/delete. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
applicationName |
The name of the application, if the actual parameter is on an application process step. |
archiveConnectorName |
The name of the archive connector. |
catalogItemName |
The name of the catalog item. |
catalogItemRunId |
The ID of the catalog item run, if the actual parameter is on a catalog item run. |
catalogName |
The name of the catalog. |
componentName |
The name of the component, if the actual parameter is on a component process step. |
dashboardName |
The name of the dashboard. |
flowName |
The name of the flow to which the flow state belongs to. |
flowStateName |
The name of the flow state, if the formal parameter is on a flow state. |
newName |
The new name for an existing object that is being renamed. |
pipelineName |
The name of the pipeline. |
procedureName |
The name of the procedure. |
processName |
The name of the process, if the actual parameter is on a process step. |
processStepName |
The name of the process step, if the actual parameter is on a process step. |
releaseName |
The name of the release, if the actual parameter is on a release. |
scheduleName |
The name of the schedule. |
stateDefinitionName |
The name of the state definition. |
stepName |
The name of the step. |
tierMapName |
The name of the tier map. |
transitionDefinitionName |
The name of the state definition. |
triggerName |
The name of the trigger. |
value |
The value of the actual parameter, if creating or modifying. |
widgetName |
The name of the widget. |
workflowDefinitionName |
The name of the workflow definition. |
addCredential
A username/password stored in the server as encrypted data. Typically used in an agent context to authenticate with a third-party system. The password is <em>not</em> available in the web context for security reasons, so this object has no getPassword method.
Required Arguments
Name | Description |
---|---|
credentialName |
The name of the credential. |
pluginConfigurationName |
Unique name of the plugin configuration within the project. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
credentialProviderName |
Name of the credential provider where the credential secret is stored. |
credentialProviderProjectName |
Name of the credential provider project, if different from the credential project. |
credentialType |
Credential type. Default is LOCAL. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
password |
The password for the credential. Can also be a certificate or any other chunk of data. |
passwordRecoveryAllowed |
If true, recovering the password by invoking getFullCredential from a job step is allowed. |
pluginKey |
The plugin key. |
pluginProjectName |
The name for the plugin’s project. |
secretPath |
Name of the folder where the password is stored. |
test |
Applicable if credentialProviderName is specified. Whether to test that the credential exists in the secret management system prior to saving. Defaults to true. |
userName |
The user name for the credential. |
virtualUserName |
Applicable for |
application
Application representation.
Required Arguments
Name | Description |
---|---|
applicationName |
The name of the application. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
applicationType |
The type of the application. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
applicationDependency
Represents a application dependency on other applications or service
Required Arguments
Name | Description |
---|---|
applicationName |
The name of the application. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
applicationDependencyName |
The name of application dependency. If not specified, a system generated guid is used. |
dependentApplicationName |
The name of application which this application depends on. |
dependentProjectName |
The name the project containing the dependent application. |
dependentSnapshotName |
The name of snapshot of the dependent application. |
effectiveDate |
The date when this dependency is applicable (for example, 2006-05-15). |
newName |
The new name for an existing object that is being renamed. |
snapshotName |
Name of the snapshot; must be unique within the application. |
applicationTier
A logical grouping of a components that are part of an application and the resources they should be deployed on
Required Arguments
Name | Description |
---|---|
applicationName |
The name of the application. |
applicationTierName |
Name of the tier; must be unique within the application. |
projectName |
The name for the project that must be unique among all projects. |
archiveConnector
Archive Connector.
Optional Arguments
Name | Description |
---|---|
actualParameters |
Actual parameter values for the configured archive connector. (Alternate argument name 'actualParameter') |
archiveDataFormat |
The data format that the connector consumes the archived data in. |
archiveScript |
Script registered to connect to the archive system and store the data being archived. |
clearActualParameters |
True if the archive connector should remove all actual parameters. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
enabled |
Whether the connector is enabled. If true, then any previously enabled archive connector will be disabled. |
newName |
The new name for an existing object that is being renamed. |
artifact
Encapsulates various metadata about Artifacts.
Optional Arguments
Name | Description |
---|---|
artifactKey |
The artifactKey component of the GAV (GroupId/ArtifactKey/Version) coordinates. |
artifactName |
The name of the artifact. |
artifactVersionNameTemplate |
The artifactVersion name template. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
groupId |
The groupId component of the GAV (GroupId/ArtifactKey/Version) coordinates. |
artifactVersion
Encapsulates various metadata about ArtifactVersions.
Optional Arguments
Name | Description |
---|---|
artifactKey |
The artifactKey component of the GAV (GroupId/ArtifactVersionId/Version) coordinates. |
artifactName |
The name of the artifact containing the artifactVersion. |
artifactVersionName |
The name of the artifact version. |
artifactVersionState |
The state of the artifact version. |
dependentArtifactVersions |
The set of artifactVersions on which this artifactVersion depends. (Alternate argument name 'dependentArtifactVersion') |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
groupId |
The groupId component of the GAV (GroupId/ArtifactVersionId/Version) coordinates. |
jobStepId |
The ID of the job step; used to make a project association. |
newName |
The new name for an existing object that is being renamed. |
removeAllDependentArtifactVersions |
If true then all dependencies will be removed. |
repositoryName |
The name of the artifact repository. |
version |
The version component of the GAV (GroupId/ArtifactVersionId/Version) coordinates. |
catalog
Self Service dashboard catalog, the container of catalog items.
Required Arguments
Name | Description |
---|---|
catalogName |
The name of the catalog. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
iconUrl |
Set icon url for a catalog. |
newName |
The new name for an existing object that is being renamed. |
catalogItem
Self Service dashboard catalog item
Required Arguments
Name | Description |
---|---|
catalogItemName |
The name of the catalog item. |
catalogName |
The name of the catalog. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
afterItem |
If specified, the catalog item will be placed after the named catalog item. |
allowScheduling |
If specified, the schedules/triggers creation is allowed for a catalog item. |
beforeItem |
If specified, the catalog item will be placed before the named catalog item. |
buttonLabel |
The name of the button label. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
dslParamForm |
The DSL Parameter form Metadata. |
dslString |
The dsl string that is evaluated for the catalog item. |
endTargetJson |
The JSON derived end target object. |
firstItem |
True to make a catalog item the first in a catalog. |
iconUrl |
The URL for the icon to be used in UI. |
newName |
The new name for an existing object that is being renamed. |
subpluginKey |
The name of the procedure’s pluginKey. |
subprocedure |
The name of the sub procedure. |
subproject |
The name of the project that contains the sub procedure or sub process. |
templateObjectType |
The template object type. |
useFormalParameter |
If true catalog item uses formalParameters data, if false formXml will be used. |
ciConfiguration
CI configuration.
Optional Arguments
Name | Description |
---|---|
ciConfigurationType |
The type of CI configuration. |
credentialName |
The name of the credential. |
credentialProjectName |
The name of the project containing specified credential. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
isDefault |
Set as default CI Configuration. |
newName |
The new name for an existing object that is being renamed. |
overrideDefault |
If |
password |
The password for authenticating with the CI server. |
publicKey |
Public key for the CI controller. Use this argument to specify the public key for the CI controller if the server is unable to retrieve the controller’s public key due to network topology. |
refCIConfiguration |
References the CI configuration to use the |
serverUrl |
URL to connect to the CI server. |
testConnection |
Specifies if the connection to the CI server should be tested before saving the configuration. The default is |
userName |
The user name for authenticating with the CI server. |
cluster
Represents a pool of resources on the cloud
Required Arguments
Name | Description |
---|---|
clusterName |
The name of the cluster. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
definitionParameters |
Cluster definition parameter. (Alternate argument name 'definitionParameter') |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
environmentName |
Name of the environment which owns this cluster. |
newName |
New name for an existing object that is being renamed. |
pluginConfigurationName |
Name of the plugin configuration. |
pluginKey |
Name of the plugin key. |
pluginProjectName |
Plugin project name. |
providerClusterName |
Name of the cluster on the provider platform. |
providerProjectName |
Name of the project on the provider platform. |
provisionParameters |
Provision parameter. (Alternate argument name 'provisionParameter') |
provisionProcedure |
Provision procedure name. |
component
A component of an application architecture.
Required Arguments
Name | Description |
---|---|
componentName |
The name of the component. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
actualParameters |
Parameters passed as arguments to the application component. (Alternate argument name 'actualParameter') |
applicationName |
The name of an application to scope this component to. |
clearActualParameters |
If |
credentialName |
The name of a credential to attach to this component. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
pluginKey |
The key of the plugin. |
pluginName |
The name of the plugin. |
pluginParameters |
List of plugin parameters. (Alternate argument name 'pluginParameter') |
reference |
If |
sourceApplicationName |
The name of the source application. |
sourceComponentName |
The name of new component. |
sourceProjectName |
The name of source project. |
credential
A username/password stored in the server as encrypted data. Typically used in an agent context to authenticate with a third-party system. The password value is not available in the web context for security reasons, so this object has no getPassword method.
Required Arguments
Name | Description |
---|---|
credentialName |
The name of the credential. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
credentialProviderName |
Name of the credential provider where the credential secret is stored. |
credentialProviderProjectName |
Name of the credential provider project, if different from the credential project. |
credentialType |
Credential type. Default is LOCAL. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
password |
The password for the credential. Can also be a certificate or any other chunk of data. |
passwordRecoveryAllowed |
If true, recovering the password by invoking getFullCredential from a job step is allowed. |
secretPath |
Name of the folder where the password is stored. |
test |
Applicable if credentialProviderName is specified. Whether to test that the credential exists in the secret management system prior to saving. Defaults to true. |
userName |
The user name for the credential. |
virtualUserName |
Applicable for |
credentialProvider
Credential provider.
Required Arguments
Name | Description |
---|---|
credentialProviderName |
Unique name of the credential provider within the project. |
projectName |
Name of the project that the credential provider belongs to. |
Optional Arguments
Name | Description |
---|---|
accountName |
Applicable for |
applicationId |
Applicable for |
authMethodsMapping |
Applicable for |
cyberarkProvider |
Applicable for |
cyberarkSafe |
Applicable for |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
keyPassword |
Applicable for |
namespace |
Applicable for |
newName |
The new name for an existing object that is being renamed. |
password |
Applicable for |
providerType |
Credential provider type. |
reason |
Applicable for |
roleId |
Applicable for |
secretEnginePath |
Applicable for |
secretEngineType |
Applicable for |
secretId |
Applicable for |
serverUrl |
Applicable for |
store |
Applicable for |
storePassword |
Applicable for |
testConnection |
Specifies if the connection to the CI server should be tested before saving the configuration. The default is |
testSecret |
Applicable for |
token |
Applicable for |
useResponseWrapping |
If true, the secretID will be unwrapped before saving. Defaults to false. |
userName |
Applicable for |
dashboard
Report dashboard, the container of report widgets.
Required Arguments
Name | Description |
---|---|
dashboardName |
Unique name of the dashboard within the project. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
clearColumns |
Whether or not to clear columns for the dashboard. |
columns |
List of the columns to display for the dashboard of type COMMAND_CENTER. (Alternate argument name 'column') |
customize |
Set to true to create a custom copy of the out-of-the-box Release Command Center dashboard. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
layout |
Layout to use for adding the widgets to the dashboard. |
newName |
The new name for an existing object that is being renamed. |
type |
Type of the dashboard. |
dataRetentionPolicy
Data Retention Policy.
Required Arguments
Name | Description |
---|---|
dataRetentionPolicyName |
Unique name of the data retention policy. |
Optional Arguments
Name | Description |
---|---|
action |
The action to take on the data that matches the criteria for the data retention rule. |
additionalFilters |
Additional filter criteria for the object type similar to search filters. (Alternate argument name 'additionalFilter') |
age |
Minimum age of the data to qualify for the data retention rule. |
ageUnit |
Time unit for age. |
associatedTags |
List of tags that the object can be associated with. (Alternate argument name 'associatedTag') |
cleanupAssociatedWorkspace |
Whether or not to cleanup the associated workspace directory with the job or deployment being purged. |
cleanupDatabase |
Whether or not to delete the jobs from the database. If set to |
clearAdditionalFilters |
Whether or not to clear additional filters for the data retention policy. |
clearAssociatedTags |
Whether or not to clear associated tags for the data retention policy. |
clearProjectNames |
Whether or not to clear project names for the data retention policy. |
clearStatuses |
Whether or not to clear statuses for the data retention policy. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
enabled |
True to enable the data retention policy. Defaults to true when creating the data retention policy. |
includeSubreleases |
If the data retention rule is defined for releases, then whether to automatically include the subreleases for the releases matching the data retention rule. Defaults to false. |
newName |
The new name for an existing object that is being renamed. |
objectType |
Type of object for which the retention rule is defined. |
projectNames |
List of projects that the object can belong to. (Alternate argument name 'projectName') |
statuses |
List of statuses for the object such as job status, release status, pipeline run status, or deployment status. (Alternate argument name 'status') |
deployerApplication
Represents an application that will be deployed as part of deployer used in a release
Required Arguments
Name | Description |
---|---|
applicationName |
The name of the application. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
afterLastRetry |
Specify continue or stop pipeline execution after last unsuccessful retry or a task. |
applicationProjectName |
The name of the project containing specified application. If not specified, it is defaulted to the release project name. |
enforceDependencies |
Enforce dependencies flag to be used during runProcess for the application. |
errorHandling |
Specifies error handling for the deployer application. |
orderIndex |
Specifies the application deployment order (starts from 1). |
processName |
The name of the application process. |
releaseName |
The name of the release. |
retryApprovers |
A list of retry approvers who receive the notification. (Alternate argument name 'retryApprover') |
retryCount |
If the retry is auto, specify the maximum number of times retry should occur. |
retryInterval |
If the retry is auto, specify the number of seconds to wait until the next retry should occur. |
retryNotificationTemplate |
Email retry notification template for application. |
retryType |
Type of retry when process step or task fails. Is one of |
smartDeploy |
Smart deploy flag to be used during runProcess for the application. |
snapshotName |
The name of the snapshot. |
stageArtifacts |
Stage artifacts for the application process. |
deployerConfiguration
Contains configuration for an application to be deployed in a release
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
actualParameters |
Actual parameters. (Alternate argument name 'actualParameter') |
applicationName |
The name of the application. |
applicationProjectName |
The name of the project containing specified application. If not specified, it is defaulted to the release project name. |
clearActualParameters |
True if the task should remove all actual parameters. |
deployerConfigurationName |
The name of deployer configuration. If not specified, a system generated guid is used. |
deployerTaskName |
The name of the deployer task defined in the provided stage. |
environmentName |
The name of the environment. |
environmentProjectName |
The name of the project containing specified environment or environment template. If not specified, it is defaulted to the release project name. |
environmentTemplateName |
The name of the environment template. |
environmentTemplateProjectName |
The name of the project containing specified environment template. If not specified, it is defaulted to the environment project name. |
insertRollingDeployManualStep |
True to indicate a manual step needs to be injected after each phase or batch. |
newName |
The new name for an existing object that is being renamed. |
processName |
The name of the application process. |
releaseName |
The name of the release. |
rollingDeployEnabled |
Perform rolling deployment. |
rollingDeployManualStepAssignees |
A list of assignees who receive the notification when rolling deploy iteration completes. (Alternate argument name 'rollingDeployManualStepAssignee') |
rollingDeployManualStepCondition |
Defines run condition on manual step created during rolling deployment. (Alternate argument name 'rollingDeployManualStepCondition') |
rollingDeployPhases |
One or more rolling deploy phases to be used for deployment. (Alternate argument name 'rollingDeployPhase') |
skipDeploy |
True to skip deployment to an environment. |
snapshotName |
The name of the snapshot. |
stageName |
The name of the stage of a pipeline attached to a release if specified. |
devOpsInsightDataSource
A DevOps Insight data source object.
Required Arguments
Name | Description |
---|---|
devOpsInsightDataSourceName |
The DevOps Insight data source name. |
projectName |
The name for the project that must be unique among all projects. |
releaseName |
The name of the release. |
Optional Arguments
Name | Description |
---|---|
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
pluginKey |
The plugin key. For example, EC-MyPlugin. |
pluginParameters |
The plugin parameters to be passed to the plugin for creating the required schedule and polling procedure. (Alternate argument name 'pluginParameter') |
reportObjectTypeName |
The name of a report object type. |
directoryProvider
Contains information about the configuration used to communicate with an external directory service (LDAP or ActiveDirectory).
Required Arguments
Name | Description |
---|---|
providerName |
Name for a LDAP directory provider; must be unique. |
Optional Arguments
Name | Description |
---|---|
allowNestedGroupsApprovers |
Specifies if users in nested LDAP groups should be allowed to approve a manual task when a parent LDAP group is assigned as an approver for the task and recursive traversal of group hierarchy is enabled for the directory provider. |
commonGroupNameAttribute |
The attribute in a group record that contains the common name of the group. If specified, it is only used when searching for groups from an external provider. Typically used when the group name attribute is set to distinguishedName, because that field is not searchable. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
domainName |
The domain from which the Active Directory server(s) are automatically discovered. |
emailAttribute |
The attribute in a LDAP user record that contains the user’s email. |
enableGroups |
Determines whether or not to enable external groups for the directory provider. |
fullUserNameAttribute |
The attribute in a user record that contains the user’s full name (first and last). |
groupBase |
String prepended to the base DN to construct the DN of the directory that contains group records. |
groupMemberAttributes |
Comma separated list of attribute names that can identify a member of a group. |
groupMemberFilter |
LDAP query string for the groups directory to find groups that contain a given user as a member. |
groupNameAttribute |
The attribute in a group record that contains the name of the group. |
groupSearchFilter |
LDAP query string used in group directory to enumerate group records. |
managerDn |
The name of a user who has read-only access to the LDAP or Active Directory server. Typically a DN (distinguished name). A simple name may be used when the Active Directory server’s URL is being auto-discovered via DNS. |
managerPassword |
Secret value used to identify the account for the query user. |
membershipAttribute |
Attribute defined on an LDAP user or group entry used by the LDAP provider for specifying the group membership. |
membershipFilter |
LDAP filter to search for groups that an LDAP user or group belongs to. |
nestedGroupDepthLimit |
Maximum number of group hierarchy levels that will be traversed for retrieving nested group membership information. |
newName |
The new name for an existing object that is being renamed. |
notifyUsersInNestedGroups |
Whether users in nested LDAP groups should be included when sending notifications for a parent LDAP group and recursive traversal of group hierarchy is enabled for the directory provider. |
providerType |
Type string for a directory provider. Should be |
realm |
The realm of the LDAP directory provider. This is used to create unique user names when there are multiple providers. |
traverseHierarchy |
Whether or not to enable recursive traversal of group hierarchy for nested group membership information. |
url |
The url of the LDAP Directory Provider server. |
useSSL |
True means SSL is used for communication. |
userBase |
Used to construct the DN of the directory that contain user records. |
userNameAttribute |
The attribute in a user record that contains the user’s account name. |
userSearchFilter |
RFC 2254 LDAP query to search for a user by name. |
userSearchSubtree |
If true recursively search the subtree below the user base. |
emailConfig
Encapsulates all of the mail server configuration information necessary for the Commander server to send an outbound e-mail message.
Optional Arguments
Name | Description |
---|---|
credentialName |
The name of the credential that contains the email password for the user from which CloudBees CD/RO sends email notifications. |
credentialProjectName |
The name of the credential project that contains the email password for the user from which CloudBees CD/RO sends email notifications. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
mailFrom |
The email address used as the email sender address for CloudBees CD/RO notifications. |
mailHost |
Name of the email server host. |
mailPort |
The port number for the email service on the server. |
mailProtocol |
Name of the email transport protocol. Supported protocol names: |
mailUser |
Name of the email user on behalf of which CloudBees CD/RO sends email notifications. |
mailUserPassword |
Password of the email user on behalf of which CloudBees CD/RO sends email notifications. |
newName |
The new name for an existing object that is being renamed. |
emailNotifier
E-mail notification to be sent when a particular event occurs.
Optional Arguments
Name | Description |
---|---|
applicationName |
The name of the application which is related to the target email container (Process/ProcessStep). |
componentName |
The name of the component which is related to the target email container (Process/ProcessStep). |
condition |
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a |
configName |
Name for an email configuration; or a text that - through property expansion - results into such an email configuration name. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
destinations |
A list of space-separated user names, email addresses or email aliases or a text that - through property expansion - results into such a list. |
environmentNames |
Name of the environments. (Alternate argument name 'environmentName') |
eventType |
An enumeration of valid event categories recognized by the email notifiers. |
flowName |
The name of the flow container of the email notifier. |
flowRuntimeId |
The primary key or name of the flowRuntime container of the email notifier. |
flowRuntimeStateId |
The primary key or name of the flowRuntimeState container of the email notifier. |
flowStateName |
The name of the flow container of the email notifier. |
formattingTemplate |
String containing email formatting instructions for generating notifications. |
gateType |
The type of the gate. |
groupNames |
A list of names of the groups which receives the notification. (Alternate argument name 'groupName') |
jobId |
The primary key or name of the job container of the email notifier. |
jobStepId |
The primary key of the job-step container of the email notifier. |
newName |
The new name for an existing object that is being renamed. |
notificationType |
The notification type which will be stored to the ec_notificationType property. |
pipelineName |
The name of the pipeline container of the email notifier. |
procedureName |
The name of the procedure container of the email notifier. |
processName |
The name of the process container of the email notifier. |
processStepName |
The name of the process step container of the email notifier. |
projectName |
The name of the project container of the email notifier. |
releaseName |
The name of the release containing the pipeline. |
stageName |
The name of the stage container of the email notifier. |
stateDefinitionName |
The name of the state definition container of the email notifier. |
stateName |
The name of the state container of the email notifier. |
stepName |
The name of the step container of the email notifier. |
userNames |
A list of names of the users who receives the notification. (Alternate argument name 'userName') |
workflowDefinitionName |
The name of the workflow definition container of the email notifier. |
workflowName |
The name of the workflow container of the email notifier. |
environment
The environment to which an application is deployed.
Required Arguments
Name | Description |
---|---|
environmentName |
The name of the environment. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
applicationName |
Create environment from the specified application. |
applicationProjectName |
The application’s project name. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
environmentEnabled |
True to enable the environment. |
newName |
The new name for an existing object that is being renamed. |
reservationRequired |
True to allow run using reservation only. |
rollingDeployEnabled |
True to enable support for rolling deploy on this environment. |
rollingDeployType |
The type of rolling deploy type supported by the environment. |
environmentTemplate
The environment template.
Required Arguments
Name | Description |
---|---|
environmentTemplateName |
The name of the environment template. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
environmentTemplateTier
The environment template tier belonging to an environment template.
Required Arguments
Name | Description |
---|---|
environmentTemplateName |
The name of the environment template. |
environmentTemplateTierName |
Name for the environment template tier; must be unique among all tiers for the environment template. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
resourceCount |
The number of resources to be spun from a given resource template. |
resourceNames |
List of resources to add to the environment tier. (Alternate argument name 'resourceName') |
resourceTemplateName |
Name for the resource template; must be unique among all resource templates. |
resourceTemplateProjectName |
Name for the project to which the resource template belongs to. |
environmentTemplateTierMap
A map to hold mappings between application and an environment template tiers.
Required Arguments
Name | Description |
---|---|
applicationName |
The name of the application. |
environmentProjectName |
The name of the environment’s project name. |
environmentTemplateName |
The name of the environment template. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
applicationEntityRevisionId |
The revision ID of the versioned object. |
tierMapName |
The name of the environment template tier map. If not specified the operation will assume a hyphenated application and environment name. |
tierMappings |
The list of mappings between the application tiers and the environment template tiers. (Alternate argument name 'tierMapping') |
environmentTemplateTierMapping
A mapping between an application tier and an environment template tier.
Required Arguments
Name | Description |
---|---|
applicationName |
The name of the application. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
applicationEntityRevisionId |
The revision ID of the versioned object. |
applicationTierName |
Name of the application tier. |
environmentProjectName |
The name of the environment template’s project name. |
environmentTemplateName |
The name of the environment template. |
environmentTemplateTierMapName |
The name of the environment template tier map. |
environmentTemplateTierMappingName |
The name of the environment template tier mapping. If not specified the operation will assume a UUID string. |
environmentTemplateTierName |
Name of the environment template tier. |
newName |
The new name for an existing object that is being renamed. |
environmentTier
The environment tier belonging to an environment.
Required Arguments
Name | Description |
---|---|
environmentName |
The name of the environment. |
environmentTierName |
Name for the environment tier; must be unique among all tiers for the environment. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
batchSize |
The size of the batch supported by the environment tier. |
batchSizeType |
The type of batch size supported by the environment tier. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
resourceNames |
List of resources to add to the environment tier. (Alternate argument name 'resourceName') |
resourcePhaseMappings |
A map of resource and rolling deploy phase. (Alternate argument name 'resourcePhaseMapping') |
resourcePoolNames |
List of resource pools to add to the environment tier. (Alternate argument name 'resourcePoolName') |
resourcePoolPhaseMappings |
A map of resource pool and rolling deploy phase. (Alternate argument name 'resourcePoolPhaseMapping') |
formalOutputParameter
A name and value pair that is passed to create an output parameter on procedure/process/pipeline.
Required Arguments
Name | Description |
---|---|
formalOutputParameterName |
Name for this parameter; used when the procedure is invoked to specify a value for the parameter. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
applicationName |
The name of the application, if the formal output parameter is on an application process. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
pipelineName |
The name of the pipeline, if the formal output parameter is on a pipeline. |
procedureName |
The name of the procedure. |
processName |
The name of the process, if the formal output parameter is on a process. |
releaseName |
The name of the release, where pipeline is located. |
formalParameter
An unbound parameter defined on a procedure, workflow definition, etc.
Required Arguments
Name | Description |
---|---|
formalParameterName |
Name for this parameter; used when the procedure is invoked to specify a value for the parameter. |
Optional Arguments
Name | Description |
---|---|
applicationName |
The name of the application, if the formal parameter is on an application process. |
archiveConnectorName |
The name of the archive connector, if the formal parameter is on an archive connector. |
catalogItemName |
The name of the catalog item, if the formal parameter is on a catalog item. |
catalogName |
The name of the catalog to which the catalog item belongs to. |
checkedValue |
Parameter value when the checkbox used to render the parameter is checked. Applicable only for |
clearOptions |
Whether or not to clear options for formal parameter. |
componentName |
The name of the component, if the formal parameter is on a component process. |
dashboardName |
The name of the dashboard, if the formal parameter is on a dashboard. |
defaultValue |
If no value is provided for the parameter when the procedure is invoked, this value will be used. |
defaultValueDsl |
DSL for default value. |
dependsOn |
Comma-separated list of formal parameters that this parameter depends on. Use with cascading drop-down ( |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
expansionDeferred |
True means expansion for this parameter should be deferred: the parameter value will not be expanded when the procedure call is expanded, but can be expanded from a command step instead. |
flowName |
The name of the flow to which the flow state belongs to. |
flowStateName |
The name of the flow state, if the formal parameter is on a flow state. |
gateType |
The type of the gate which contains the task, if the formal parameter is belongs to a task. |
label |
Specifies the display label. |
microserviceName |
The name of the microservice. |
multiSelect |
Whether or not to use multiselect instead of select. |
newName |
The new name for an existing object that is being renamed. |
options |
Ordered list of options. (Alternate argument name 'option') |
optionsDsl |
DSL for populating drop-down options for |
optionsFromPropertySheet |
Path to the property sheet containing the options. |
orderIndex |
Specifies the display order index (starts from 1). |
pipelineName |
The name of the pipeline, if the formal parameter is on a pipeline. |
procedureName |
The name of the procedure. |
processName |
The name of the process, if the formal parameter is on a process. |
processStepName |
The name of the process step, if the formal parameter is on a process step. |
projectFormalParameterName |
Used when rendering the formal parameter to identify the formal parameter to use in order to get the owning project name. Applicable only for |
projectName |
The name for the project that must be unique among all projects. |
propertyReference |
Property or property sheet to use for displaying options. |
propertyReferenceType |
Whether the |
releaseName |
The name of the release, if the formal parameter is on a release-scoped pipeline. |
renderCondition |
Condition for rendering the formal parameter. |
reportName |
The name of the report, if the formal parameter is on a report. |
required |
True means this parameter is required: the procedure will not execute unless a value is given for the parameter. |
simpleList |
Pipe-separated list of options, e.g., option1 |
option2 |
option3. |
stageName |
The name of the stage which contains the task, if the formal parameter is belongs to a task. |
stateDefinitionName |
The name of the state definition. |
stateName |
The name of a workflow state. |
taskName |
The name of the task, if the formal parameter is belongs to a task. |
type |
The type of a formal parameter. |
uncheckedValue |
Parameter value when the checkbox used to render the parameter is unchecked. Applicable only for |
updateFormXml |
Whether the parameter form XML stored in the procedure property |
validationDsl |
DSL for validating the formal parameter. |
workflowDefinitionName |
The name of the workflow definition. |
workflowName |
The name of a workflow. |
gate
Tasks container belonging to stage
Required Arguments
Name | Description |
---|---|
gateType |
The type of the gate. |
projectName |
The name for the project that must be unique among all projects. |
stageName |
Name of the stage to which this task belongs to. |
Optional Arguments
Name | Description |
---|---|
condition |
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
pipelineName |
The name of the pipeline. |
precondition |
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a |
releaseName |
The name of the release. |
gateway
A secured connection between two zones for sharing or transferring information between the zones.
Optional Arguments
Name | Description |
---|---|
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
gatewayDisabled |
True means this artifact repository is disabled. |
hostName1 |
The domain name or IP address resourceName2 uses to send messages to resourceName1. |
hostName2 |
The domain name or IP address resourceName1 uses to send messages to resourceName2. |
newName |
The new name for an existing object that is being renamed. |
port1 |
Port number resourceName2 uses to send messages to resourceName1. |
port2 |
Port number resourceName1 uses to send messages to resourceName2. |
resourceName1 |
The name of the first resource in a gateway specification. Other resources in this resource’s zone forward messages through this resource to agents in resourceName2’s zone. |
resourceName2 |
The name of the second resource in a gateway specification. Other resources in this resource’s zone forward messages through this resource to agents in resourceName1’s zone. |
group
A group of users.
Optional Arguments
Name | Description |
---|---|
clearPersonas |
Clear personas for group, if modifying. |
migrateSettings |
New group name to which settings will be migrated. |
newName |
The new name for an existing object that is being renamed. |
personas |
List of personas that this group has. (Alternate argument name 'persona') |
removeAllUsers |
True to remove all users from this group. |
userNames |
List of users in the group. (Alternate argument name 'userName') |
hook
A resource template hook that stores a reference to a procedure in an ElectricFlow project or plugin project. When a resource template is used to create a resource pool, these procedures are invoked.
Optional Arguments
Name | Description |
---|---|
broadcast |
Broadcast flag. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
hookParameters |
Hook parameters. (Alternate argument name 'hookParameter') |
hookType |
Hook type. |
newName |
The new name for an existing object that is being renamed. |
procedureName |
Hook procedure name. |
procedurePluginKey |
Procedure plugin key. |
procedureProjectName |
Procedure project name. |
projectName |
ProjectName of the entity that owns the hook. |
resourceTemplateName |
Name of the resource template. |
job
An instance of a procedure run.
Optional Arguments
Name | Description |
---|---|
destinationProject |
The project that will own the job. |
jobId |
The primary key of the job, or the name of the job. |
jobNameTemplate |
Template used to determine the default name of jobs launched from a procedure. |
procedureName |
The name of the procedure that should |
projectName |
The name of the project is destinationProject is not specified. |
status |
The starting status for the job. |
jobStep
A step in a job.
Optional Arguments
Name | Description |
---|---|
actualParameters |
Actual parameters passed to an invoked subprocedure. (Alternate argument name 'actualParameter') |
alwaysRun |
True means this step will run even if preceding steps fail in a way that aborts the job. |
broadcast |
True means replicate this step to execute (in parallel) on each of the specified resources (that is, for a pool, run the step on each of the resources in the pool). |
command |
Script to execute the functions of this step; passed to the step’s shell for execution. |
comment |
Script to execute the functions of this step; passed to the step’s shell for execution. |
condition |
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a |
credentialName |
The name of the credential to be used for impersonation. |
credentials |
The list of runtime credentials attached to the job step. (Alternate argument name 'credential') |
errorHandling |
Specifies error handling for this step. |
exclusive |
True means the resource acquired for this step will be retained for the exclusive use of this job. This means 2 things: first, no other job will be able to use that resource, regardless of its step limit, until this job completes; second, future steps for this job will use the resource in preference to other resources, if this resource meets the needs of the steps and its step limit is not exceeded. |
exclusiveMode |
Determines the mode to use when the step acquires a resource. If set to |
external |
True if the step is externally managed (no state machine). |
jobStepId |
The primary key of the job step. |
jobStepName |
The name for the new step. If omitted, a default name will be generated. |
logFileName |
Name of the log file for a step; specified relative to the root directory in the job’s workspace. |
parallel |
True means this step and all adjacent steps with the flag set will run in parallel. |
parentPath |
Path to the parent job step. If a parent step is not specified, the current job step is used. |
postProcessor |
This command runs in parallel with the main command for the step; it analyzes the log for the step and collects diagnostic information. |
precondition |
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a |
procedureName |
The name of the procedure that should |
projectName |
The name of the project for procedureName. |
releaseExclusive |
True means the resource acquired for this step will be no longer be retained for the exclusive use of this job when this step completes. |
releaseMode |
Determines the mode to use when the step releases its resource. If set to |
resourceName |
Name for the resource; must be unique among all resources. |
shell |
Name of the shell program that will execute the command and postprocessor for the step. |
status |
The starting status for the step. |
stepName |
The name of the procedure step that should |
subprocedure |
Name of a procedure to invoke during this step. |
subproject |
Name of the project containing the procedure to invoke during this step. |
timeLimit |
Maximum amount of time the step can execute; abort if it exceeds this time. |
timeLimitUnits |
Units for step time limit: seconds, minutes, or hours. |
workingDirectory |
Working directory in which to execute the command for this step. A relative name is interpreted relative to the root directory for the job’s workspace. |
workspaceName |
The name of the workspace. |
kerberosKeytab
Kerberos keytab representation
Optional Arguments
Name | Description |
---|---|
content |
The content of the Kerberos keytab. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
type |
The type of the Kerberos keytab. |
license
microservice
A microservice representation
Required Arguments
Name | Description |
---|---|
applicationName |
The name of the application. |
microserviceName |
The name of the microservice. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
addDeployProcess |
If set to true,then a microservice process is also created. |
definitionSource |
Enum representing the source of the microservice definition. |
definitionSourceParameters |
Parameters to resolve the source of the artifact representing microservice definition. (Alternate argument name 'definitionSourceParameter') |
definitionType |
Microservice definition type. |
deployParameters |
Parameters to supply to deploy procedure of microservice definition type provider. (Alternate argument name 'deployParameter') |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
rollbackParameters |
Parameters to store microservice definition rollback parameters. (Alternate argument name 'rollbackParameter') |
microserviceMapping
A mapping between an microservice and an environment cluster
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
applicationName |
The name of the application. |
clusterName |
The name of the cluster. |
clusterProjectName |
The name of the project which contains the cluster. |
environmentName |
Name of the environment which owns this cluster. |
microserviceMappingName |
The name of the microservice mapping. |
microserviceName |
The name of the microservice. |
newName |
The new name for an existing object that is being renamed. |
tierMapName |
The name of the tier map. |
openIDConnectConfiguration
OpenIDConnect Configuration representation
Required Arguments
Name | Description |
---|---|
clientId |
Client ID used to uniquely identify the SDA server with the OIDC provider. |
openIDConnectConfigurationName |
The name of the OpenID Connect provider. |
serverUrl |
URL for the service host. |
Optional Arguments
Name | Description |
---|---|
authorizationEndpoint |
URL for the authorization end-point. |
clientSecret |
Secret used to request token ID for the authenticated used from the OIDC provider. |
configurationUrl |
The OpenID Connect provider’s well-known configuration endpoint. If specified, then the other end-points will be dynamically discovered when refreshConfiguration is set to true. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
emailIdTokenClaim |
Claim name in the token ID used to retrieve the user email. |
enableSingleLogout |
Whether the user will be logged out from the OIDC provider when the user logs out of SDA. |
enabled |
Whether this OpenID Connect configuration is enabled. Defaults to true. |
fullUserNameIdTokenClaim |
Claim name in the token ID used to retrieve the user full name. |
jwkProviderEndpoint |
URL for the JWK keys end-point. |
logoutEndpoint |
URL for the logout end-point. |
newName |
The new name for an existing object that is being renamed. |
refreshConfiguration |
Whether the endpoint attributes such as authorizationEndpoint, tokenEndpoint and other configuration details should be updated using the configurationURL. If true, then configurationURL must be set. |
ssoProvider |
Used to identify the SSO provider for displaying the branded SSO button on the login page. |
tokenEndpoint |
URL for the token end-point. |
userGroupsIdTokenClaim |
Claim name in the token ID used to retrieve the groups that the user belongs to. |
userNameIdTokenClaim |
Claim name in the token ID used to retrieve the user name. |
persona
A persona for a user or group.
Optional Arguments
Name | Description |
---|---|
clearDetails |
Clears persona details, if modifying. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
homePageName |
The default home page. |
isDefault |
Set as default persona. |
newName |
The new name for an existing object that is being renamed. |
personaDetails |
The details of the persona, if creating. |
personaCategory
A persona category.
Optional Arguments
Name | Description |
---|---|
afterCategory |
If specified, the category will be placed after the named category. |
beforeCategory |
If specified, the category will be placed before the named category. |
clearPages |
Clears persona pages for the category, if modifying. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
enabled |
Whether to enable the PersonaCategory. |
newName |
The new name for an existing object that is being renamed. |
personaPages |
A list of pages in a persona category. (Alternate argument name 'personaPage') |
pipeline
pipeline representation.
Required Arguments
Name | Description |
---|---|
pipelineName |
The name of the pipeline. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
assigneesForSkipStage |
A list of users who can skip stages at runtime. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
disableMultipleActiveRuns |
Boolean flag showing if option to run multiple pipelines simultaneously is disabled. |
disableRestart |
True to disable restart the pipeline. |
enabled |
True to enable the pipeline. |
newName |
New name for an existing object that is being renamed. |
overrideWorkspace |
If true and workspaceName is not null, then all tasks use pipeline’s workspace. |
pipelineRunNameTemplate |
Template used to determine the default name for pipelines on startup. |
releaseName |
The name of the release. |
skipStageMode |
The flag to indicate if stages can be skipped at runtime. |
type |
Type of pipeline. |
workspaceName |
The name of the default workspace for this pipeline. |
plugin
An add-on program used by CloudBees CD/RO to integrate with third-party tools, custom dashboards, and unique user experiences based on roles.
Optional Arguments
Name | Description |
---|---|
author |
The name of the plugin author. |
authorUrl |
The Url of the plugin author. |
category |
The category of the plugin. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
extensionVersion |
An extension version number should be used when modifying or extending a CloudBees provided plugin. This allows the system to differentiate between the product plugin versions and plugin versions modified or customized by you. |
key |
Version independent name for the plugin. |
label |
Label to display in lists for the plugin. |
pluginName |
The name of the plugin. |
pluginWizardBased |
Whether the plugin is based on Plugin Wizard. |
projectName |
The name of the project. |
repositoryUrl |
The URL of plugin’s repository. |
supportLevel |
The support level for the plugin. |
supportsConfigurations |
Whether the plugin supports plugin configurations. If true, then the plugin configuration procedures, CreateConfiguration and DeleteConfiguration will be automatically created. |
version |
The version of the plugin. |
pluginConfiguration
Plugin configuration.
Required Arguments
Name | Description |
---|---|
pluginConfigurationName |
Unique name of the plugin configuration within the project. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
clearCredentialNames |
Collection of existing credential names to be cleared for the plugin configuration. (Alternate argument name 'clearCredentialName') |
clearCredentials |
Whether or not to clear existing credentials for the plugin configuration. |
clearFields |
Whether or not to clear fields for the plugin configuration. |
credentialReferenceParameters |
List of credential parameters with references to existing credentials as parameter values. If the parameter value is a property reference then the credential would be resolved at runtime. (Alternate argument name 'credentialReferenceParameter') |
credentials |
Credentials to be used by the plugin config. (Alternate argument name 'credential') |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
fields |
Fields for plugin configuration. (Alternate argument name 'field') |
newName |
The new name for an existing object that is being renamed. |
pluginKey |
The plugin key. |
pluginProjectName |
The name for the plugin’s project. |
procedure
Container for steps that execute some task.
Required Arguments
Name | Description |
---|---|
procedureName |
Name for the procedure; must be unique within the project. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
credentialName |
The name of a credential to attach to this procedure. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
jobNameTemplate |
Template used to determine the default name of jobs launched from a procedure. |
newName |
The new name for an existing object that is being renamed. |
resourceName |
The name of the default resource for this procedure. |
timeLimit |
Maximum amount of time the step can execute; abort if it exceeds this time. |
timeLimitUnits |
Units for step time limit: seconds, minutes, or hours. |
workspaceName |
The name of the default workspace for this procedure. |
process
An application or component process.
Required Arguments
Name | Description |
---|---|
processName |
The name of the process. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
applicationName |
The name of the application, if the process is owned by an application. |
componentApplicationName |
If specified, the component is scoped to this application not the project. |
componentName |
The name of the component, if the process is owned by a component. |
credentialName |
The name of a credential to attach to this process. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
exclusiveEnvironment |
True if environment is exclusive to the application or service process. |
microserviceApplicationName |
If specified, the microservice is scoped to an application. |
microserviceName |
The name of the microservice, if the process is owned by a microservice. |
newName |
The new name for an existing object that is being renamed. |
processType |
Defines type of action performed by the process. |
smartUndeployEnabled |
True if smart deploy should be enabled for the undeploy component process. |
timeLimit |
Maximum amount of time the step can execute; abort if it exceeds this time. |
timeLimitUnits |
Units for step time limit: seconds, minutes, or hours. |
workingDirectory |
Working directory in which to execute the command for this process. A relative name is interpreted relative to the root directory for the job’s workspace. |
workspaceName |
The name of the default workspace for this process. |
processDependency
Represents a dependency between process steps.
Required Arguments
Name | Description |
---|---|
processName |
The name of the process. |
processStepName |
The name of the process step. |
projectName |
The name for the project that must be unique among all projects. |
targetProcessStepName |
The name of the target process step. |
Optional Arguments
Name | Description |
---|---|
applicationName |
The name of the application, if the process is owned by an application. |
branchCondition |
Branch Condition. |
branchConditionName |
Branch Condition Name. |
branchConditionType |
Branch Condition Type. |
branchType |
Branch Type. |
componentApplicationName |
If specified, the component is scoped to this application not the project. |
componentName |
The name of the component, if the process is owned by a component. |
microserviceApplicationName |
Name of the application containing the microservice. |
microserviceName |
The name of the microservice, if the process is owned by a microservice. |
processStep
A step in an application or component process.
Required Arguments
Name | Description |
---|---|
processName |
The name of the process. |
processStepName |
The name of the process step. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
actionLabelText |
The Json derived action label text. |
actualParameters |
Actual parameters passed to an invoked subprocedure or process. (Alternate argument name 'actualParameter') |
afterLastRetry |
Specifies error handling for the auto retry step. |
afterProcessStep |
If specified, the process step will be placed after the named process step. |
allowSkip |
When enabled, manual process step can be skipped. |
alwaysRun |
True means this step will run even if preceding steps fail in a way that aborts the job. |
applicationName |
The name of the application, if the process is owned by an application. |
applicationTierName |
If references an application tier, the name of the application tier. |
assignees |
A list of assignees who receive the notification. (Alternate argument name 'assignee') |
beforeProcessStep |
If specified, the process step will be placed before the named process step. |
clearActualParameters |
If |
componentApplicationName |
If specified, the component is scoped to this application not the project. |
componentName |
The name of the component, if the process is owned by a component. |
componentRollback |
When enabled, rollback will be performed only for the components that were not deployed successfully. |
credentialName |
The name of the credential object. |
dependencyJoinType |
Join type for incoming dependencies. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
disableFailure |
True means a manual process step cannot be failed. |
emailConfigName |
The name of email configuration. |
errorHandling |
Specifies error handling for this step. |
includeCompParameterRef |
True if the actual parameters should be generated from component properties. Works for artifact components only. |
instruction |
Instruction associated with the manual process step. |
microserviceApplicationName |
If specified, the microservice is scoped to an application. |
microserviceName |
The name of the microservice, if the process is owned by a microservice. |
newName |
The new name for an existing object that is being renamed. |
notificationEnabled |
True means this email notification is enabled, false otherwise. |
notificationTemplate |
Email notification template for process step. |
processStepType |
Defines type of the process step. |
retryCount |
If the retry is auto, specify the maximum number of times retry should occur. |
retryInterval |
If the retry is auto, specify the interval in seconds after which retry should be attempted. |
retryType |
Type of retry when process step fails. Is one of |
rollbackSnapshot |
Name of Snapshot to be used for rollback. |
rollbackType |
The type of the rollback. |
rollbackUndeployProcess |
Name of the undeploy process to be used during rollback. |
skipRollbackIfUndeployFails |
When enabled, rollback will be performed only for the components that were successfully undeployed. |
smartRollback |
Smart deploy flag to be used during rollback is triggered. |
subcomponent |
If referencing a component process, the name of the component. |
subcomponentApplicationName |
If referencing a component process, the name of the component application (if not project scoped). |
subcomponentProcess |
If referencing a component process, the name of the component process. |
submicroservice |
If referencing a microservice, the name of the microservice. |
submicroserviceProcess |
If referencing a microservice process, the name of the microservice process. |
subprocedure |
If referencing a procedure, the name of the procedure. |
subproject |
If referencing a procedure, the name of the procedure’s project. |
timeLimit |
Maximum amount of time the step can execute; abort if it exceeds this time. |
timeLimitUnits |
Units for step time limit: seconds, minutes, or hours. |
useUtilityResource |
True means that step will run on utility resource instead of a tier. |
utilityResourceName |
Utility resource name. |
workingDirectory |
Working directory in which to execute the command for this step. A relative name is interpreted relative to the root directory for the job’s workspace. |
workspaceName |
The name of the workspace. |
project
Container for a group of related procedures and schedules.
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
credentialName |
The name of the credential object. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
resourceName |
Name for the resource; must be unique among all resources. |
tracked |
True to enable change tracking for this project. |
workspaceName |
The name of the workspace. |
property
A custom attribute attached to any CloudBees CD/RO object. This may be a key, string-value pair or a complex structure, where the value is a reference to a property sheet containing nested properties.
Required Arguments
Name | Description |
---|---|
propertyName |
Name for the property; must be unique within the property sheet. |
Optional Arguments
Name | Description |
---|---|
applicationName |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
The name of the catalog of the property sheet that owns the property. |
ciBuildDetailName |
The name of the CI build detail of the property sheet that owns the property. |
clusterName |
The name of the cluster which owns property sheet. |
componentName |
The name of the component container of the property sheet that owns the property. |
configName |
The name of the emailConfig container that owns the property. |
credentialName |
The name of the credential container of the property sheet that owns the property. |
credentialProtected |
If true, then permissions requiring modify privileges on the property sheet being manipulated will also require execute privileges on credentials attached to the property sheet owner. |
dashboardName |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
The name of the data retention policy of the property sheet that owns the property. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
environmentName |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
The name of the environment tier container of the property sheet that owns the property. |
expandable |
Whether or not the property is recursively expandable. |
extendedContextSearch |
For simple property names, whether or not to search objects in the hierarchy to find the desired property. |
flowName |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
The type of the gate which owns property sheet. |
gatewayName |
The name of the gateway container of the property sheet. |
groupName |
The name of the group container of the property sheet that owns the property. |
jobId |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
The primary key of the job-step container of the property sheet that owns the property. |
microserviceName |
The name of the microservice container of the property sheet. |
newName |
The new name for an existing object that is being renamed. |
notifierName |
The name of the notifier container of the property sheet that owns the property. |
objectId |
The object ID as returned by FindObjects. |
path |
Property path string. |
pipelineName |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
The name of the procedure container of the property sheet that owns the property. |
processName |
The name of the process, if the container is a process or process step. |
processStepName |
The name of the process step, if the container is a process step. |
projectName |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
The primary key of the property sheet that owns the property. |
propertyType |
Type of property. |
releaseName |
The name of the release container of the property sheet that owns the property. |
reportName |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
The name of the repository container of the property sheet that owns the property. |
resourceName |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
The name of the schedule container of the property sheet. |
scmSyncName |
The name of the Scm Sync container of the property sheet that owns the property. |
searchFilterName |
The name of the search filter container of the property sheet. |
serviceAccountName |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
The name of the state definition container of the property sheet that owns the property. |
stateName |
The name of the state container of the property sheet that owns the property. |
stepName |
The name of the step container of the property sheet that owns the property. |
suppressValueTracking |
If true, then change tracking will ignore changes that only affect the value of the property, and exports of past states and force imports will preserve the current value. |
systemObjectName |
The system object. |
taskName |
The name of the task which owns property sheet. |
transitionDefinitionName |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
The name of the transition container of the property sheet that owns the property. |
triggerName |
The name of the trigger which owns property sheet. |
userName |
The name of the user container of the property sheet that owns the property. |
value |
The value of the property. |
widgetName |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
The name of the workspace container of the property sheet. |
zoneName |
The name of the zone container of the property sheet. |
release
Release object
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
releaseName |
The name of the release. |
Optional Arguments
Name | Description |
---|---|
actualParameters |
Values for formal parameters that are defined in the release pipeline. If the release is started using the |
clearActualParameters |
True if the task should remove all actual parameters. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
disableMultipleActiveRuns |
Boolean flag showing if option to run multiple pipelines simultaneously is disabled. |
disablePipelineRestart |
True to disable restart release pipeline. |
newName |
The new name for an existing object that is being renamed. |
overrideWorkspace |
If true and workspaceName is not null, then all tasks use pipeline’s workspace. |
pipelineName |
The name of the pipeline. |
pipelineProjectName |
The name of the project containing specified pipeline. If not specified, it is defaulted to the release project name. |
pipelineWorkspaceName |
The name of the workspace used by pipeline. |
plannedEndDate |
The date when this release is expected to end (for example, 2006-05-15). |
plannedStartDate |
The date when this release is expected to begin (for example, 2006-05-15). |
timeZone |
The time zone to use when interpreting times. |
report
DevOps Insight Report object
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
reportName |
The name of the report. |
Optional Arguments
Name | Description |
---|---|
definition |
The Elasticsearch query definition to use for retrieving report data. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
parameters |
Input parameters in JSON format accepted by the report definition. |
reportObjectTypeForSourceType |
The report object type name to use to determine the source type for the report. Set this if the sourceType of the report’s reportObjectType is different from the actual source of the report data. |
reportObjectTypeName |
Report object type name. |
reportQuery |
The report query in JSON format. It will be translated to the Elasticsearch query definition when retrieving report data. |
title |
The title of report. |
uri |
An advanced mode option for identifying the Elasticsearch URI to use for retrieving report data. By default, the reportObjectTypeName argument will be used to construct the URI based on the Elasticsearch index for the report object, e.g., |
reportObjectAssociation
Report object association.
Required Arguments
Name | Description |
---|---|
associatedType |
The name of the associated type. |
reportObjectTypeName |
Report object type for which this association is defined. The association is owned by the specified report object type. |
Optional Arguments
Name | Description |
---|---|
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
required |
Whether the association between the report object type and associated type is always present. |
sourceFields |
Comma-separated list of fields in the report object type that should match the fields in the target or associated object type in order to establish a correlation between the two types. |
targetFields |
Comma-separated list of fields in the associated object type that should match the fields in the source report object type in order to establish a correlation between the two types. |
reportObjectAttribute
Report object attribute.
Required Arguments
Name | Description |
---|---|
reportObjectAttributeName |
The name of the report object attribute. |
reportObjectTypeName |
Report object type for which this attribute is defined. The attribute is owned by the specified report object type. |
Optional Arguments
Name | Description |
---|---|
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
displayName |
Display name of report object attribute. |
enumerationValues |
Enumeration values of report object attribute. |
newName |
The new name for an existing object that is being renamed. |
required |
Whether the association between the report object type and attribute is always present. |
type |
Type of report object attribute. |
reportObjectType
Report object type.
Optional Arguments
Name | Description |
---|---|
colorCode |
The color associated with the report object type, in hexcode format |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
displayName |
Display name of report object type. |
newName |
New name for an existing object that is being renamed. |
sourceType |
Category of the third-party tool that data for the given report object type is obtained from. |
sourceTypeDescription |
Description of the category of the third-party tool that may be displayed on the UI. |
storagePattern |
Storage pattern for report object type. |
reportingFilter
Reporting filter.
Required Arguments
Name | Description |
---|---|
dashboardName |
Unique name of the dashboard within the project. |
projectName |
The name for the project that must be unique among all projects. |
reportingFilterName |
The name of the reporting filter. |
Optional Arguments
Name | Description |
---|---|
actualParameters |
Parameters passed reporting filter. (Alternate argument name 'actualParameter') |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
filters |
String representation of CompositeFilter object used for additional attribute values filtering. |
newName |
The new name for an existing object that is being renamed. |
operator |
The operator is allowed to use in a reporting filter. |
orderIndex |
Order that the reporting filter should be displayed. |
parameterName |
The parameter name to filter on it. |
reportObjectTypeName |
The name of the report object type, if the reporting filter is a custom filter. |
required |
The flag to see is this reporting filter required to be used. |
type |
The type of the field value. |
widgetName |
The name of the widget this reporting filter is scoped to. |
repository
Encapsulates various metadata about Repositories.
Optional Arguments
Name | Description |
---|---|
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
repositoryDisabled |
Whether or not to disable the repository. |
url |
The url for contacting the repository. |
zoneName |
The zone name. |
reservation
The reservation
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
reservationName |
The name of the environment reservation. |
Optional Arguments
Name | Description |
---|---|
applicationName |
The name of the application. |
beginDate |
Date of beginning reservation. |
blackout |
Do not allow executions against an environment at specified period. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
endDate |
The date when reservation event ends. |
environmentName |
The name of the environment. |
environmentProjectName |
The name of the environment project name. |
environmentTierName |
The name of the environment tier. |
monthDays |
A list of numbers from 1-31 separated by spaces, indicating zero or more days of the month. |
newName |
The new name for an existing object that is being renamed. |
overlap |
Allow to overlap the reservation. |
pipelineName |
The name of the pipeline. |
recurrence |
Recurrence reservation. |
recurrenceEndDate |
Date of beginning reservation. |
releaseName |
The name of the release. |
timeZone |
The time zone to use when interpreting times. |
weekDays |
Days of the week: any number of names such as Monday or Tuesday, separated by spaces. |
resource
Abstract reference to an agent, responsible for running step commands.
Required Arguments
Name | Description |
---|---|
resourceName |
Name for the resource; must be unique among all resources. |
Optional Arguments
Name | Description |
---|---|
artifactCacheDirectory |
Artifact cache directory for this resource. |
block |
True to block on the agent ping before returning. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
hostName |
The domain name or IP address of the server machine corresponding to this resource. |
hostType |
The type of the host. |
newName |
The new name for an existing object that is being renamed. |
pools |
[Deprecated] A list of arbitrary names separated by spaces, indicating the pools with which this resource is associated. |
port |
Port number to use when connecting to the agent for this resource; defaults to server default. |
proxyCustomization |
Proxy specific customization data; defaults to none. |
proxyHostName |
The domain name or IP address of the proxy agent machine corresponding to this resource. |
proxyPort |
Port number to use when connecting to the proxy agent for this resource; defaults to server default. |
proxyProtocol |
The protocol to use when proxying to this resource; defaults to none. |
repositoryNames |
A newline delimited list of repositories to retrieve artifacts from. |
resourceDisabled |
True means this resource will not be allocated to job steps, regardless of its step limit. |
resourcePools |
A list of arbitrary names separated by comma, indicating the pools with which this resource is associated. |
shell |
Name of the shell program that will execute the command and postprocessor for the step. |
stepLimit |
The maximum number of steps that may execute simultaneously using this resource. |
trusted |
True means the agent can speak to all other trusted agents in its zone. An untrusted agent can only speak to gateway agents. |
useSSL |
True means SSL is used for communication. |
workspaceName |
The name of the workspace. |
zoneName |
Name for the zone; must be unique among all zones. |
resourcePool
A collection of resources with a ordering policy.
Required Arguments
Name | Description |
---|---|
resourcePoolName |
Name for the resource pool; must be unique among all resource pools. |
Optional Arguments
Name | Description |
---|---|
autoDelete |
If true, the pool is deleted when the last resource is deleted. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
orderingFilter |
JavaScript fragment that returns custom ordering of resources in a pool. |
resourceNames |
List of resources to add/remove from the pool. (Alternate argument name 'resourceName') |
resourcePoolDisabled |
True means the resourcePool will not be allocated to job steps. |
resourceTemplate
A template with the required information to provision and later spin up cloud resources on an on-demand basis.
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
resourceTemplateName |
Name for the resource template; must be unique among all resource templates. |
Optional Arguments
Name | Description |
---|---|
cfgMgrParameters |
Configuration manager plugin parameters. (Alternate argument name 'cfgMgrParameter') |
cfgMgrPluginKey |
Configuration manager plugin key. |
cfgMgrProcedure |
Configuration manager plugin method name. |
cfgMgrProjectName |
Configuration manager plugin project name. |
cloudProviderParameters |
Cloud provider plugin parameters. (Alternate argument name 'cloudProviderParameter') |
cloudProviderPluginKey |
Cloud provider plugin key. |
cloudProviderProcedure |
Cloud provider plugin method name. |
cloudProviderProjectName |
Cloud provider plugin project name. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
rollingDeployPhase
Represents a rolling deploy phase
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
rollingDeployPhaseName |
The name of the rolling deploy phase. |
Optional Arguments
Name | Description |
---|---|
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
environmentName |
The name of the environment. |
newName |
The new name for an existing object that is being renamed. |
orderIndex |
Specifies the phase order (starts from 1). |
phaseExpression |
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a |
rollingDeployPhaseType |
The type of rolling deploy phase. |
samlIdentityProvider
SAML Identity Provider Configuration representation
Required Arguments
Name | Description |
---|---|
samlIdentityProviderName |
The name of the SAML Identity Provider. |
Optional Arguments
Name | Description |
---|---|
colorCode |
[DEPRECATED]: The argument is no longer used |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
enabled |
If true, enables SAML Identity Provider. |
label |
[DEPRECATED]: The argument is no longer used |
metadata |
The metadata of the SAML identity provider. |
newName |
The new name for an existing object that is being renamed. |
ssoProvider |
Used to identify the SSO provider for displaying the branded SSO button on the login page. |
samlServiceProvider
Saml Service Provider Configuration representation
Required Arguments
Name | Description |
---|---|
entityId |
Service Provider entity ID (usually URI). |
serverUrl |
URL for the service provider host. |
Optional Arguments
Name | Description |
---|---|
authnRequestsSigned |
Metadata will have AuthnRequestsSigned= |
digestAlgorithm |
SAML digest algorithm. |
enabled |
If true, enables SAML Service Provider. |
groupClaimAttribute |
Security group claim attribute in the SAML response that contains the user groups. |
mdSigningEnabled |
If true, sign service provider metadata. |
mdSigningPassphrase |
Passphrase use for SP metadata signing private key. |
mdSigningPrivateKey |
SP metadata signing private key. |
mdSigningPublicCertificate |
SP metadata signing public certificate. |
nameIdFormat |
NameID format like urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified. |
passphrase |
Passphrase use for SP private key. |
privateKey |
SP private key. |
publicCertificate |
SP’s public certificate. |
samlServiceProviderName |
The name of the SAML Service Provider. |
signatureAlgorithm |
SAML signature algorithm. |
userEmailAttribute |
The mapping for the user email attribute in the SAML response. |
userFullNameAttribute |
The mapping for the full user name attribute in the SAML response. |
wantAssertionsSigned |
Metadata will have WantAssertionsSigned= |
schedule
This object is responsible for launching a procedure at some time in the future, possibly on a regular interval.
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
scheduleName |
Name for the schedule; must be unique among all schedules for the project. |
Optional Arguments
Name | Description |
---|---|
actualParameters |
Parameters passed to the invoked procedure/pipeline/process/release/workflow. (Alternate argument name 'actualParameter') |
applicationName |
The name of the application that owns the process. |
applicationProjectName |
Name for the project to which the application belongs to. |
beginDate |
The date when this schedule will begin (for example, 2006-05-15). |
catalogItemName |
Name of the catalog item to invoke. |
catalogName |
Name of the catalog containing the catalog item to invoke. |
clearActualParameters |
Whether or not to clear actual parameters for this object. |
clearPipelineParameters |
Whether or not to clear pipeline parameters for the schedule. |
credentialName |
The name of the credential to use for impersonation. |
dataRetentionPolicyName |
The name of the data retention policy to invoke. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
endDate |
The date when this schedule will end (for example, 2006-05-15). The end date is not included in the range of dates. |
environmentName |
The name of the environment used to determine where to run the process. |
environmentProjectName |
Name for the project to which the environment or environment template belongs to. |
environmentTemplateName |
The name of the environment template used to determine the environment where to run the process. |
environmentTemplateProjectName |
Name for the project to which the environment template belongs to. |
environmentTemplateTierMapName |
The name of the environment template tier map used to determine how to spin up the environment which will be used to run the process. |
insertRollingDeployManualStep |
True to indicate a manual step needs to be injected after each phase or batch. |
interval |
If specified, the procedure/pipeline/process/release/workflow will be rescheduled over and over again at intervals of this length. |
intervalUnits |
Units for the interval of rescheduling. |
misfirePolicy |
Specifies the misfire policy for a schedule. |
monthDays |
A list of numbers from 1-31 separated by spaces, indicating zero or more days of the month. |
newName |
The new name for an existing object that is being renamed. |
pipelineName |
Name of the pipeline to invoke. |
pipelineParameters |
Pipeline parameters used by a release schedule to override the default parameters configured in the release. (Alternate argument name 'pipelineParameter') |
pluginKey |
Name for the project to which the schedule belongs to. |
priority |
The priority of the job. |
procedureName |
The name of the procedure to invoke. |
processName |
The name of the application process to invoke. |
releaseName |
Name of the release to invoke. |
rollingDeployEnabled |
Perform rolling deployment. |
rollingDeployManualStepAssignees |
A list of assignees who receive the notification when rolling deploy iteration completes. (Alternate argument name 'rollingDeployManualStepAssignee') |
rollingDeployManualStepCondition |
Defines run condition on manual step created during rolling deployment. (Alternate argument name 'rollingDeployManualStepCondition') |
rollingDeployPhases |
One or more rolling deploy phases to be used for deployment. (Alternate argument name 'rollingDeployPhase') |
scheduleDisabled |
If this box is |
snapshotName |
The name of the snapshot to be used to invoke the application process. |
stagesToRun |
One or more stages to run in a pipeline. (Alternate argument name 'stagesToRun') |
startTime |
The time of day to begin invoking this schedule’s procedure/pipeline/process/release/workflow (24-hour clock, for example, 17:00). |
startingStage |
Name of the starting stage in pipeline. |
startingStateName |
The name of the starting state of the workflow. |
stopTime |
The time of day to stop invoking this schedule’s procedure/pipeline/process/release/workflow (don’t start a new job after this time); time values use a 24-hour clock, for example, 17:00. |
subproject |
Name for the project to which the schedule target object belongs to. |
tierMapName |
The name of the tier map used to determine where to run the process. |
tierResourceCounts |
Resource count per resource template tier. (Alternate argument name 'tierResourceCount') |
timeZone |
The time zone to use when interpreting times. |
weekDays |
Days of the week: any number of names such as Monday or Tuesday, separated by spaces. |
workflowName |
The name of the workflow to invoke. |
scmSync
Represents a Git Synchronization configuration
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
scmSyncName |
Name of Scm Sync. |
Optional Arguments
Name | Description |
---|---|
branch |
Branch |
clearExcludeObjects |
Whether or not to clear exclude objects for this object. |
clearIncludeObjects |
Whether or not to clear include objects for this object. |
configurationName |
Configuration name. |
configurationProjectName |
Configuration project name. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
destinationDir |
Destination directory on the agent where local SCM repository will be located. |
excludeObjects |
List of paths to the objects that should not be synchronized (Alternate argument name 'excludeObject') |
exportParameters |
List of export parameters. (Alternate argument name 'exportParameter') |
importParameters |
List of import parameters. (Alternate argument name 'importParameter') |
includeObjects |
List of paths to the objects that should be synchronized. (Alternate argument name 'includeObject') |
newName |
The new name for an existing object that is being renamed. |
relativePath |
Relative path. |
repository |
Scm repository. |
resourceName |
Resource name. |
scmType |
Specify the type of SCM. |
syncType |
Specify whether it’s a sync from SCM or to SCM. |
triggerEnabled |
True if trigger configured and enabled, false otherwise. |
searchFilter
Search filter representation.
Optional Arguments
Name | Description |
---|---|
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
newObjectType |
Search filter entity type. |
searchQuery |
Search filter query CLOB. |
shared |
Flag indicating whether the filter is public or private |
userName |
Search filter user name. |
serviceAccount
snapshot
A version of an application or service with specific artifact versions and the state of the application or service at any point in time.
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
snapshotName |
Name of the snapshot; must be unique within the snapshot container. |
Optional Arguments
Name | Description |
---|---|
applicationName |
The name of application from which the snapshot should be created. |
componentVersions |
Component names and version used for snapshot. Use keyword |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
environmentName |
The name of environment from which snapshot be created. |
environmentProjectName |
Name for the project to which the environment or environment template belongs to. |
newName |
The new name for an existing object that is being renamed. |
stage
Logical grouping of pipeline tasks
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
stageName |
The name of the stage. |
Optional Arguments
Name | Description |
---|---|
afterStage |
If specified, the stage will be placed after the named stage. |
beforeStage |
If specified, the stage will be placed before the named stage. |
colorCode |
The hexadecimal value of the color to be used with an entity. |
completed |
Set true to complete and false to incomplete a stage with manual completion type. A stage with auto completion type ignores this argument. |
completionType |
The stage completion type: auto (be default) or manual. |
condition |
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
duration |
Duration in minutes for which the stage or task should relative to |
incompletePostStages |
If True then in case off specified stage inclompletion all post stages are incompleted too. |
newName |
The new name for an existing object that is being renamed. |
parallelToPrevious |
If TRUE, the flow state will be run in parallel to the previous flow state. |
pipelineName |
The name of the pipeline. |
plannedEndDate |
The date when this stage or task is expected to end. |
plannedStartDate |
The date when this stage or task is expected to start. |
precondition |
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a |
releaseName |
The name of the release. |
resourceName |
The name of the default resource for this stage. |
timeZone |
The time zone to use when interpreting times. |
waitForPlannedStartDate |
True to enable waiting for planned start date. |
stateDefinition
A state definition in a workflow definition. Each workflow can contain one or more states.
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
stateDefinitionName |
The name used for the state definition. |
workflowDefinitionName |
The name of the workflow definition. |
Optional Arguments
Name | Description |
---|---|
actualParameters |
The actual parameters to the state definition’s process. (Alternate argument name 'actualParameter') |
clearActualParameters |
True if the state definition should remove all actual parameters to the process. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
startable |
True if the workflow can begin in this state. |
subprocedure |
The name of the sub procedure. |
subproject |
The name of the project that contains the sub procedure. |
substartingState |
The name of the starting state to use in the subworkflowDefinition. |
subworkflowDefinition |
The name of the subworkflowDefinition. |
step
A unit of logic that will execute on an agent.
Required Arguments
Name | Description |
---|---|
procedureName |
Name for the procedure; must be unique within the project. |
projectName |
The name for the project that must be unique among all projects. |
stepName |
Name of the step; must be unique within the procedure. |
Optional Arguments
Name | Description |
---|---|
actualParameters |
Actual parameters passed to an invoked subprocedure. (Alternate argument name 'actualParameter') |
afterProcedureStep |
If specified, the procedure step will be placed after the named procedure step. |
alwaysRun |
True means this step will run even if preceding steps fail in a way that aborts the job. |
beforeProcedureStep |
If specified, the procedure step will be placed before the named procedure step. |
broadcast |
True means replicate this step to execute (in parallel) on each of the specified resources (that is, for a pool, run the step on each of the resources in the pool). |
clearActualParameters |
If |
command |
Script to execute the functions of this step; passed to the step’s shell for execution. |
comment |
Script to execute the functions of this step; passed to the step’s shell for execution. |
condition |
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a |
credentialName |
The name of the credential object. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
errorHandling |
Specifies error handling for this step. |
exclusive |
True means the resource acquired for this step will be retained for the exclusive use of this job. This means 2 things: first, no other job will be able to use that resource, regardless of its step limit, until this job completes; second, future steps for this job will use the resource in preference to other resources, if this resource meets the needs of the steps and its step limit is not exceeded. |
exclusiveMode |
Determines the mode to use when the step acquires a resource. If set to |
logFileName |
Name of the log file for a step; specified relative to the root directory in the job’s workspace. |
newName |
The new name for an existing object that is being renamed. |
parallel |
True means this step and all adjacent steps with the flag set will run in parallel. |
postProcessor |
This command runs in parallel with the main command for the step; it analyzes the log for the step and collects diagnostic information. |
precondition |
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a |
releaseExclusive |
True means the resource acquired for this step will be no longer be retained for the exclusive use of this job when this step completes. |
releaseMode |
Determines the mode to use when the step releases its resource. If set to |
resourceName |
Name for the resource; must be unique among all resources. |
shell |
Name of the shell program that will execute the command and postprocessor for the step. |
subprocedure |
Name of a procedure to invoke during this step. |
subproject |
Name of the project containing the procedure to invoke during this step. |
timeLimit |
Maximum amount of time the step can execute; abort if it exceeds this time. |
timeLimitUnits |
Units for step time limit: seconds, minutes, or hours. |
workingDirectory |
Working directory in which to execute the command for this step. A relative name is interpreted relative to the root directory for the job’s workspace. |
workspaceName |
The name of the workspace. |
task
A representation of task within a stage or gate.
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
taskName |
The name of the task. |
Optional Arguments
Name | Description |
---|---|
actionLabelText |
The Json derived action label text. |
actualParameters |
Actual parameters passed to an invoked subprocedure. (Alternate argument name 'actualParameter') |
advancedMode |
True to enable advanced mode so as to templatize snapshotName. |
afterLastRetry |
Specify continue or stop pipeline execution after last unsuccessful retry or a task. |
afterTask |
If specified, the task will be placed after the named task. |
allowOutOfOrderRun |
If True, allow to run a task out of order. |
allowSkip |
When enabled, manual task or gate rule can be skipped. |
alwaysRun |
True means this task will run even if preceding tasks fail in a way that aborts the pipeline. |
applicationName |
The name of the application used in sub task |
applicationProjectName |
Name for the project to which the application belongs to. |
applicationVersion |
Application version to be deployed by a sub task. |
approvers |
A list of task approvers who receive the notification. (Alternate argument name 'approver') |
artifacts |
If specified, the task will be placed before the named task. |
beforeTask |
If specified, the task will be placed before the named task. |
ciConfigurationName |
The CI configuration name. |
ciControllerFolder |
Path to the folder on the CI controller referenced by the CloudBees Operation Center that contains the specified CI controller. Must be in format folder1/folder2/folder3/… . |
ciControllerName |
[DEPRECATED]: Deprecated in favour of ciEndpoint argument |
ciEndpoint |
Endpoint value configured for CI controller |
ciJobBranchName |
Name of the CI Job Branch. |
ciJobFolder |
Path to the folder on the CI server referenced by the CI configuration that contains the specified CI job. Must be in format folder1/folder2/folder3/… . |
ciJobName |
Name of the CI job. |
clearActualParameters |
True if the task should remove all actual parameters. |
clearOutOfOrderRunAssignees |
True if the task should clean up all outOfOrderRunAssignees. |
clearStageSummaryParameters |
True if the task should remove all stage summary parameters. |
condition |
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a |
customLabel |
Custom display name for sub pipelines or releases. |
deployerExpression |
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a |
deployerRunType |
The type of the deployer run for deployer type of task. If parallel then all applications are deployed in parallel. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
disableFailure |
True means a manual task cannot be failed. |
duration |
Duration in minutes for which the stage or task should relative to |
emailConfigName |
The name of email configuration. |
enabled |
True to enable the task. |
environmentName |
Environment name to create from template. |
environmentProjectName |
Name for the project to which the environment or environment template belongs to. |
environmentTemplateName |
Environment template name. |
environmentTemplateProjectName |
Name for the project to which the environment template belongs to. |
errorHandling |
Specifies error handling for this task. |
firstTask |
True to make a task first in a stage. |
gateCondition |
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a |
gateType |
The type of the gate. |
groupName |
The name of the group of task. |
groupRunType |
The type of the sub task run for a group task. If serial then all tasks are run in serial, otherwise - in parallel (by default). |
insertRollingDeployManualStep |
True to indicate a manual step needs to be injected after each phase or batch. |
instruction |
Instruction associated with the task. |
keepOnError |
True to keep environment on error (default is false). |
newName |
The new name for an existing object that is being renamed. |
notificationEnabled |
True means this email notification is enabled, false otherwise. |
notificationTemplate |
String containing email formatting instructions for generating notifications. |
outOfOrderRunAssignees |
A list of users who can run a task out of order. (Alternate argument name 'outOfOrderRunAssignee') |
parallelToPrevious |
If TRUE, the flow state will be run in parallel to the previous flow state. |
pipelineName |
The name of the pipeline. |
plannedEndDate |
The date when this stage or task is expected to end. |
plannedStartDate |
The date when this stage or task is expected to start. |
precondition |
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a |
releaseName |
The name of the release. |
requiredApprovalsCount |
The number of users from a group that should approve the task before it’s considered as finally approved. |
resourceName |
The name of the default resource for this task. |
retryCount |
If the retry is auto, specify the maximum number of times retry should occur. |
retryInterval |
If the retry is auto, specify the number of seconds to wait until the next retry should occur. |
retryType |
Type of retry when process step or task fails. Is one of |
rollingDeployEnabled |
Perform rolling deployment. |
rollingDeployManualStepAssignees |
A list of assignees who receive the notification when rolling deploy iteration completes. (Alternate argument name 'rollingDeployManualStepAssignee') |
rollingDeployManualStepCondition |
Defines run condition on manual step created during rolling deployment. (Alternate argument name 'rollingDeployManualStepCondition') |
rollingDeployPhases |
One or more rolling deploy phases to be used for deployment. (Alternate argument name 'rollingDeployPhase') |
skippable |
True if a task is skippable. |
snapshotName |
Name of the snapshot associated with the application. |
stageName |
Name of the stage to which this task belongs to. |
stageSummaryParameters |
JSON representation of stage summary parameters and labels. |
stagesToRun |
One or more stages to run in a pipeline. (Alternate argument name 'stagesToRun') |
startTime |
The time of day to begin invoking this task (24-hour clock, for example, 17:00). |
startingStage |
The name of the starting stage. |
subErrorHandling |
The impact of invoking pipeline run when sub-pipeline fails. |
subTaskType |
The type of the sub task. |
subapplication |
The name of the application that owns the subprocess. |
subpipeline |
If referencing a pipeline, the name of the pipeline. |
subpluginKey |
If referencing a procedure, the name of the procedure’s pluginKey. |
subprocedure |
If referencing a procedure, the name of the procedure. |
subprocess |
The name of the process. |
subproject |
If referencing a procedure, the name of the procedure’s project. |
subrelease |
If referencing a release, the name of the release. |
subreleasePipeline |
The name of the pipeline to be used when attaching to the release instantiate from a releae task. |
subreleasePipelineProject |
The name of the project which contains the pipeline to the release instantiate from a releae task. |
subreleaseSuffix |
The suffix to be used when creating release. |
subworkflowDefinition |
If referencing a workflow definition, the name of the workflow definition. |
subworkflowStartingState |
The name of the starting state in the specified workflow definition. |
taskProcessType |
The type of the process a task can invoke. |
taskType |
The type of the task. |
tierResourceCounts |
Resource count per resource template tier. (Alternate argument name 'tierResourceCount') |
timeZone |
The time zone to use when interpreting times. |
triggerType |
The type of trigger when invoking a sub-pipeline. |
useApproverAcl |
True if after approve the authentication context of approving user should be added to the session. |
waitForPlannedStartDate |
True to enable waiting for planned start date. |
workspaceName |
The name of the workspace. |
tierMap
A map to hold mappings between application and an environment tiers.
Required Arguments
Name | Description |
---|---|
applicationName |
The name of the application. |
environmentName |
The name of the environment. |
environmentProjectName |
The name of the environment’s project name. |
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
applicationEntityRevisionId |
The revision ID of the versioned object. |
tierMapName |
The name of the tier map. If not specified the operation will assume a hyphenated application and environment name. |
tierMappings |
The list of mappings between the application tiers and the environment tiers. (Alternate argument name 'tierMapping') |
tierMapping
A mapping between an application tier and an environment tier.
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
applicationEntityRevisionId |
The revision ID of the versioned object. |
applicationName |
The name of the application. |
applicationTierName |
Name of the application tier. |
environmentName |
The name of the environment. |
environmentProjectName |
The name of the environment’s project name. |
environmentTierName |
Name of the environment tier. |
newName |
The new name for an existing object that is being renamed. |
resourceExpression |
Resource expression to pick up resources from the environment tier. |
tierMapName |
The name of the tier map. |
tierMappingName |
The name of the tierMapping. |
transitionDefinition
Defines how a workflow must transition from one state to another.
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
stateDefinitionName |
The name used for the state definition. |
transitionDefinitionName |
The name used for the transition. |
workflowDefinitionName |
The name of the workflow definition. |
Optional Arguments
Name | Description |
---|---|
actualParameters |
The actual parameters to the transition’s target state. (Alternate argument name 'actualParameter') |
clearActualParameters |
True if the transition should remove all actual parameters to the target state. |
condition |
A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
targetState |
Target state for the transition definition. |
trigger |
Specifies the type of trigger for this transaction. |
trigger
The object responsible for triggering objects by some events
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
triggerName |
The name of the trigger |
Optional Arguments
Name | Description |
---|---|
actualParameters |
Actual parameters passed to the invoked object. (Alternate argument name 'actualParameter') |
applicationName |
The name of the application that owns the trigger and the process that should be run. |
clearActualParameters |
Whether or not to clear actual parameters for this object. |
clearPipelineParameters |
Whether or not to clear pipeline parameters for the trigger. |
credentialName |
The name of the credential to use for impersonation. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
enabled |
True to enable the task. |
environmentName |
The name of the environment used to determine where to run the process. |
environmentProjectName |
Name for the project to which the environment or environment template belongs to. |
environmentTemplateName |
The name of the environment template used to determine the environment where to run the process. |
environmentTemplateProjectName |
Name for the project to which the environment template belongs to. |
insertRollingDeployManualStep |
True to indicate a manual step needs to be injected after each phase or batch. |
newName |
The new name for an existing object that is being renamed. |
pipelineName |
The name of the pipeline to run. |
pipelineParameters |
Pipeline parameters used by a release schedule to override the default parameters configured in the release (Alternate argument name 'pipelineParameter') |
pluginKey |
The key of the plugin to be used for trigger integration with 3rd-party system |
pluginParameters |
List of plugin parameters. (Alternate argument name 'pluginParameter') |
procedureName |
The name of the procedure that owns the process to run. |
processName |
The name of the application process to invoke. |
quietTimeMinutes |
Specify how long in minutes should pass since last trigger event before the trigger will run. |
releaseName |
The name of the release to run. |
rollingDeployEnabled |
Perform rolling deployment. |
rollingDeployManualStepAssignees |
A list of assignees who receive the notification when rolling deploy iteration completes. (Alternate argument name 'rollingDeployManualStepAssignee') |
rollingDeployManualStepCondition |
Defines run condition on manual step created during rolling deployment. (Alternate argument name 'rollingDeployManualStepCondition') |
rollingDeployPhases |
One or more rolling deploy phases to be used for deployment. (Alternate argument name 'rollingDeployPhase') |
runDuplicates |
Specify whether a trigger should be run if the previously triggered process is still running. |
scmSyncName |
The name of the scmSync trigger belong to. |
serviceAccountName |
The name of the service account associated with a webhook trigger |
snapshotName |
The name of the snapshot to be used to invoke the application process. |
stagesToRun |
One or more stages to run in a pipeline. (Alternate argument name 'stagesToRun') |
tierResourceCounts |
Resource count per resource template tier (Alternate argument name 'tierResourceCount') |
triggerType |
A type of trigger |
webhookName |
Webhook name. |
webhookSecret |
Webhook secret. |
webhookSecretCredentialName |
Webhook secret credential name. |
webhookSecretCredentialProjectName |
Webhook secret credential project name. |
user
A user object.
Optional Arguments
Name | Description |
---|---|
clearPersonas |
Clear personas for user, if modifying. |
Email address of the user. |
|
fullUserName |
Full name of the user. |
groupNames |
List of groups that this user is in. (Alternate argument name 'groupName') |
migrateSettings |
Migrate the user or group settings to this name. |
newName |
The new name for an existing object that is being renamed. |
password |
The users password. |
personas |
List of personas that this user has. (Alternate argument name 'persona') |
removeFromAllGroups |
True to remove this user from all groups. |
sessionPassword |
Session user’s password. Used to re-verify identity before changing user passwords in the system. |
utilityResource
Utility resource representation.
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
utilityResourceName |
Name for utilityResource; must be unique among all utility resources for the environment or environment template. |
Optional Arguments
Name | Description |
---|---|
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
environmentName |
Name of parent environment. |
environmentTemplateName |
Name of parent environmentTemplate. |
newName |
The new name for an existing object that is being renamed. |
resourceName |
The name of the default resource for this utility resource. |
waitDependency
Represents a dependency defined on a stage or task.
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
Optional Arguments
Name | Description |
---|---|
allowSkip |
The flag to indicate if a dependency can be skipped at runtime. |
assigneesForSkip |
A list of assignees who can skip a dependency at runtime. |
dependentGateType |
The type of dependent gate. |
dependentPipelineName |
The name of the dependent pipeline. |
dependentProjectName |
The name of the dependent project. |
dependentReleaseName |
The name of the dependent release. |
dependentStageName |
The name of the dependent stage. |
dependentTaskName |
The name of the dependent task. |
gateType |
The type of gate. |
newName |
The new name for an existing object that is being renamed. |
pipelineName |
The name of the pipeline. |
releaseName |
The name of the release. |
stageName |
The name of the stage. |
taskName |
The name of the task. |
waitDependencyName |
The name of the wait dependency. |
waitForTriggeredPipelines |
The flag to indicate that dependency should be created on all triggered pipelines. |
waitForTriggeredReleases |
The flag to indicate that dependency should be created on all triggered releases. |
widget
Dashboard widget
Required Arguments
Name | Description |
---|---|
dashboardName |
Unique name of the dashboard within the project. |
projectName |
The name for the project that must be unique among all projects. |
widgetName |
The name of the dashboard widget. |
Optional Arguments
Name | Description |
---|---|
actualParameters |
Actual parameter values for the parameters defined on the widget’s report. (Alternate argument name 'actualParameter') |
afterWidget |
The name of the widget after which this widget should be placed. |
attributeDataTypes |
Widget parameters used by UI to control data types of attributes. (Alternate argument name 'attributeDataType') |
attributePaths |
Widget parameters used by UI to control paths of attributes. (Alternate argument name 'attributePath') |
beforeWidget |
The name of the widget before which this widget should be placed. |
clearAttributeDataTypes |
Whether or not to clear attribute data types for the widget. |
clearAttributePaths |
Whether or not to clear attribute paths for the widget. |
clearColors |
Whether or not to clear color for the widget. |
clearLinkParameters |
Whether or not to clear link parameters for the widget. |
clearVisualizationProperties |
Whether or not to clear visualization properties for the widget. |
colorRanges |
The JSON with color ranges definition for the widget. |
colors |
Color map used when rendering the widget. The usage of the color map depends on the widget’s visualization type. (Alternate argument name 'color') |
column |
The column in a COMMAND_CENTER dashboard that the widget belongs to. Required for a COMMAND_CENTER dashboard widget unless the widget section is |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
iconUrl |
The icon to display for the widget. |
linkParameters |
Widget parameters used by UI to construct the drill-down link for the widget. (Alternate argument name 'linkParameter') |
linkTarget |
Determines the page to navigate to when the user drills down through the dashboard widget. |
newName |
The new name for an existing object that is being renamed. |
orderIndex |
Specifies the relative display order for the widget. |
reportName |
Name of an existing report backing the widget. |
reportProjectName |
Set if the report is in a different project than the dashboard. |
section |
The section of a COMMAND_CENTER dashboard to display the widget in. Applicable for a COMMAND_CENTER dashboard widget. |
title |
The title to display for the widget. If not set, use the report title. |
visualization |
Type of visualization data in the widget. |
visualizationProperties |
Properties or settings used by the widget’s visualization type. (Alternate argument name 'visualizationProperty') |
widgetFilterOverride
Widget filter override.
Required Arguments
Name | Description |
---|---|
dashboardFilterName |
The name of the dashboard filter. |
dashboardName |
Unique name of the dashboard within the project. |
projectName |
The name for the project that must be unique among all projects. |
widgetName |
Name of the widget within the dashboard this widget filter override is scoped to. |
Optional Arguments
Name | Description |
---|---|
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
ignoreFilter |
Whether to ignore the dashboard filter and not apply it to the report. All other arguments are ignored if this argument is set to true. |
parameterName |
The parameter name to use when applying the filter to the report instead of the parameter name specified in the dashboard filter. |
workflowDefinition
A top-level workflow object, which is a container for states, and transitions, and other information defining your workflow.
Required Arguments
Name | Description |
---|---|
projectName |
The name for the project that must be unique among all projects. |
workflowDefinitionName |
The name of the workflow definition. |
Optional Arguments
Name | Description |
---|---|
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |
workflowNameTemplate |
The template used to name instances of this workflow definition. |
workspace
File system directory in which a JobStep’s logs and often its artifactVersions are stored.
Optional Arguments
Name | Description |
---|---|
agentDrivePath |
Pathname to the root directory of a workspace, for use on Windows, specified with a drive letter. |
agentUncPath |
Pathname to the root directory of a workspace, for use on Windows, specified with a UNC path. |
agentUnixPath |
Pathname to the root directory of a workspace, for use on UNIX. |
credentialName |
The name of the impersonation credential to attach to this workspace. |
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
local |
True if the workspace is |
newName |
The new name for an existing object that is being renamed. |
workspaceDisabled |
True means this workspace is disabled. |
zoneName |
The zone name. |
zone
A zone or top-level network created as a way to partition a collection of agents to secure them from use by other groups.
Optional Arguments
Name | Description |
---|---|
description |
Comment text describing this object that is not interpreted at all by CloudBees CD/RO. |
newName |
The new name for an existing object that is being renamed. |