clone

Back to index

Summary

Clone a CloudBees CD/RO entity.

The clone API enables copying objects, and it allows some customization in the process. It takes two classes of arguments:
- Arguments for the source object to be cloned. For example, to clone a pipeline, specify both the name of the project that contains the pipeline and the name of the specific pipeline within the project.
- Arguments for the cloned object; use cloneName to name the new clone and include a path.
  
  To clone a pipeline into a different project, proj2, use cloneName to specify both the destination project’s name and the new pipeline’s name, for example:
  --cloneName /projects/proj2/pipelines/newpipeline
- Refer to ectool examples below.
Cloning parameters, artifacts, or artifact versions is not supported.
To locate the entity for cloning, it is necessary to specify the following arguments:
- A new name for the cloned object. For example, cloneName.
- Locator arguments for the objects that can be cloned. For example, to clone a project, specify the name of the project that you want to clone.

applicationName

Stringoptional

The name of the application container of the property sheet that owns the property.

applicationTierName

Stringoptional

The name of the application tier container of the property sheet that owns the property.

archiveConnectorName

Stringoptional

The name of the archive connector of the property sheet that owns the property.

artifactName

Stringoptional

The name of the artifact container of the property sheet that owns the property.

artifactVersionName

Stringoptional

The name of the artifactVersion container of the property sheet that owns the property.

catalogItemName

Stringoptional

The Catalog Item name.

catalogItemRunId

Stringoptional

The primary key of the CatalogItemRun container of the property sheet that owns the property.

catalogName

Stringoptional

The name of the catalog of the property sheet that owns the property.

ciBuildDetailName

Stringoptional

The name of the CI build detail of the property sheet that owns the property.

cloneName

Stringoptional

New name to use for a cloned copy of an object.

cloneTaskGroup

Stringoptional

The name of the group of task.

clusterName

Stringoptional

The name of the cluster which owns property sheet.

componentName

Stringoptional

The name of the component container of the property sheet that owns the property.

configName

Stringoptional

The name of the emailConfig container that owns the property.

credentialName

Stringoptional

The name of the credential container of the property sheet that owns the property.

credentialProviderName

Stringoptional

The credential provider name.

dashboardName

Stringoptional

The name of the dashboard of the property sheet that owns the property.

dataRetentionPolicyName

Stringoptional

The name of the data retention policy of the property sheet that owns the property.

disableProjectTracking

Booleanoptional

If set to true, when copying a project, even if the original project has change tracking enabled, make change tracking of the new copy of the project be disabled from its creation. If you don't need to track changes to the new copy, this avoids the change tracking overhead that would otherwise slow down the copying operation, and also saves having to subsequently disable change tracking of the new copy of the project.

environmentName

Stringoptional

The name of the environment container of the property sheet that owns the property.

environmentTemplateName

Stringoptional

The name of the environment template container of the property sheet that owns the property.

environmentTemplateTierName

Stringoptional

The name of the environment template tier container of the property sheet that owns the property.

environmentTierName

Stringoptional

The name of the environment tier container of the property sheet that owns the property.

flowName

Stringoptional

The name of the flow container of the property sheet that owns the property.

flowRuntimeId

Stringoptional

The primary key or name of the flowRuntime container of the property sheet that owns the property.

flowRuntimeName

Stringoptional

The name of the flow runtime container of the property sheet that owns the property.

flowRuntimeStateId

Stringoptional

The primary key or name of the flowRuntimeState container of the property sheet that owns the property.

flowRuntimeStateName

Stringoptional

The name of the flow state container of the property sheet that owns the property.

flowStateName

Stringoptional

The name of the flow state container of the property sheet that owns the property.

flowTransitionName

Stringoptional

The name of the flow transition container of the property sheet that owns the property.

gateType

Stringoptional

The type of the gate which owns property sheet.

Possible values: "POST", "PRE"

gatewayName

Stringoptional

The name of the gateway container of the property sheet.

groupName

Stringoptional

The name of the group container of the property sheet that owns the property.

jobId

Stringoptional

The primary key or name of the job container of the property sheet that owns the property.

jobStepId

UUIDoptional

The primary key of the job-step container of the property sheet that owns the property.

linkNewPersona

Booleanoptional

Set to 1 to associate users and groups to the cloned persona.

microserviceName

Stringoptional

The name of the microservice container of the property sheet.

notifierName

Stringoptional

The name of the notifier container of the property sheet that owns the property.

objectId

Stringoptional

The object ID as returned by FindObjects.

path

Stringoptional

Property path string.

personaName

Stringoptional

The persona name.

pipelineName

Stringoptional

The name of the pipeline container of the property sheet that owns the property.

pluginConfigurationName

Stringoptional

The plugin configuration name.

pluginName

Stringoptional

The name of the plugin container of the property sheet that owns the property.

procedureName

Stringoptional

The name of the procedure container of the property sheet that owns the property.

processName

Stringoptional

The name of the process, if the container is a process or process step.

processStepName

Stringoptional

The name of the process step, if the container is a process step.

projectName

Stringoptional

The name of the project container of the property sheet that owns the property.

propertySheetId

UUIDoptional

The primary key of the property sheet that owns the property.

providerName

Stringoptional

The unique name of the directory provider.

reducedDetailChangeHistory

Booleanoptional

Set to 0 or false to prevent copying of a large project that has change tracking enabled from automatically reducing the level of detail that it tracks for the change history of the copy -- this will make the copy operation take longer and put more load on the database, but will allow the Change History feature to still show the full detail of entities owned by the copy of the project that were created by the copy operation.

releaseName

Stringoptional

The name of the release container of the property sheet that owns the property.

reportName

Stringoptional

The name of the report of the property sheet that owns the property.

reportObjectTypeName

Stringoptional

The name of the report object type of the property sheet that owns the property.

repositoryName

Stringoptional

The name of the repository container of the property sheet that owns the property.

resourceName

Stringoptional

The name of the resource container of the property sheet that owns the property.

resourcePoolName

Stringoptional

The name of the resource pool container of the property sheet that owns the property.

resourceTemplateName

Stringoptional

The name of the resource template container of the property sheet that owns the property.

scheduleName

Stringoptional

The name of the schedule container of the property sheet.

scmSyncName

Stringoptional

The name of the SCM Sync container of the property sheet that owns the property.

searchFilterName

Stringoptional

The name of the search filter container of the property sheet.

serviceAccountName

Stringoptional

Retrieves the name of the service account container of the property sheet.

snapshotName

Stringoptional

The name of the snapshot container of the property sheet that owns the property.

stageName

Stringoptional

The name of the stage container of the property sheet that owns the property.

stateDefinitionName

Stringoptional

The name of the state definition container of the property sheet that owns the property.

stateName

Stringoptional

The name of the state container of the property sheet that owns the property.

stepName

Stringoptional

The name of the step container of the property sheet that owns the property.

systemObjectName

Stringoptional

The system object.

Possible values: "admin", "analyticsServerConfigurations", "archiveConnectors", "artifacts", "ciConfigurations", "ciEventsSchemaConfiguration", "ciJobDetails", "ciLoginHistory", "complianceConfiguration", "dataRetentionPolicies", "devOpsForesight", "devOpsInsightServerConfigurations", "directory", "dslClientFiles", "emailConfigs", "forceAbort", "licensing", "log", "personaCategories", "personaPages", "personas", "plugins", "priority", "projects", "reportObjectTypes", "repositories", "resources", "searchFilters", "server", "session", "ssoConfiguration", "ssoLoginHistory", "statsdConfiguration", "tags", "test", "workspaces", "zonesAndGateways"

taskName

Stringoptional

The name of the task which owns property sheet.

transitionDefinitionName

Stringoptional

The name of the transition definition container of the property sheet that owns the property.

transitionName

Stringoptional

The name of the transition container of the property sheet that owns the property.

triggerName

Stringoptional

The name of the trigger which owns property sheet.

unlinkOriginalPersona

Booleanoptional

Set to 1 to disassociate users and groups from the original or the persona being cloned.

userName

Stringoptional

The name of the user container of the property sheet that owns the property.

widgetName

Stringoptional

The name of the widget of the property sheet that owns the property.

workflowDefinitionName

Stringoptional

The name of the workflow definition container of the property sheet that owns the property.

workflowName

Stringoptional

The name of the workflow container of the property sheet that owns the property.

workspaceName

Stringoptional

The name of the workspace container of the property sheet.

zoneName

Stringoptional

The name of the zone container of the property sheet.

Usage

Perl

$cmdr->clone(
  # optionals
);▼

ectool

ectool clone \
  # optionals▼

Examples

Perl

To create a copy of a procedure, as though you selected Copy in the UI:

$xPath = $cmdr->clone(
    {
        projectName => "EC-Examples",
        procedureName => "set Property"
    }
);▼

To create a copy of a procedure and provide a name for the procedure:

$xPath = $cmdr->clone(
    {
        projectName   => "EC-Examples",
        procedureName => "set Property",
        cloneName     => "set Property 2"
    }
);▼

To create a copy of a procedure step:

$xPath = $cmdr->clone(
    {
        projectName   => "EC-Examples",
        procedureName => "set Property",
        cloneName     => "set Property 2",
        stepName      => 'setProperty'
    }
);▼

To copy a step using the full path:

$xPath = $cmdr->clone(
    {
        path =>
          '/projects/EC-Examples/procedures/set Property/steps/setProperty'
    }
);▼

ectool

To create a copy of a procedure, as though you selected Copy in the UI:

ectool clone --projectName 'EC-Examples' --procedureName 'set Property' <response requestId="1" nodeId="192.168.16.238">    <cloneName>Set Property copy</cloneName></response>▼

To create a copy of a procedure and provide a name for the procedure:

ectool clone --projectName 'EC-Examples' --procedureName 'set Property'
--cloneName 'set Property 2'
<response requestId="1" nodeId="192.168.16.238">    <cloneName>set Property 2</cloneName></response>▼

To create a copy of a procedure step:

ectool clone --projectName 'EC-Examples' --procedureName 'set Property'
--stepName 'setProperty'
<response requestId="1" nodeId="192.168.16.238">    <cloneName>setProperty copy</cloneName></response>▼

To copy a step using the full path:

ectool clone --path '/projects/EC-Examples/procedures/set Property/steps/setProperty'
<response requestId="1" nodeId="192.168.16.238">    <cloneName>setProperty copy</cloneName></response>▼

To copy a release from a project named test, and name the new release testrelease copy:

ectool clone --projectName test --releaseName testrelease▼

To copy a release named testrelease from a project named test, give it a new release name of testrelease2, and save it in the test2 project:

ectool clone --projectName test --releaseName testrelease --cloneName /projects/test2/releases/testrelease2▼

The use of the full path in the cloneName argument makes it possible to clone to a different project. cloneName is exclusively related to the new object.
The path argument specifies the location of the source object; it does not apply to the new object being created.