modifyScmSync

Back to index

Summary

Modifies an existing source code synchronization object.
For a list of object types in CloudBees CD/RO, refer to Object types in CloudBees CD/RO.
projectName
Stringrequired
The name for the project that must be unique among all projects.
scmSyncName
Stringrequired
Name of SCM Sync.
branch
Stringoptional
The branch
clearExcludeObjects
Booleanoptional
Whether or not to clear exclude objects for this object.
clearIncludeObjects
Booleanoptional
Whether or not to clear include objects for this object.
configurationName
Stringoptional
Configuration name.
configurationProjectName
Stringoptional
Configuration project name.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
destinationDir
Stringoptional
Destination directory on the agent where local SCM repository will be located.
excludeObject
Arrayoptional
List of paths to the objects that should not be synchronized.
exportParameter
Arrayoptional
List of export parameters.
importParameter
Arrayoptional
List of import parameters.
includeObject
Arrayoptional
List of paths to the objects that should be synchronized.
newName
Stringoptional
The new name for an existing object that is being renamed.
relativePath
Stringoptional
Relative path.
repository
Stringoptional
The SCM repository.
resourceName
Stringoptional
Resource name.
scmType
Stringoptional
Specify the type of SCM.
Possible values: "git"
syncType
Stringoptional
Specify whether it's a sync from SCM or to SCM.
Possible values: "fromScm", "toScm"
triggerEnabled
Booleanoptional
True if trigger configured and enabled, false otherwise.

Usage

Perl

$cmdr->modifyScmSync( "test-projectName", # projectName "test-scmSyncName" # scmSyncName # optionals );

ectool

ectool modifyScmSync \ "test-projectName" `# projectName` \ "test-scmSyncName" `# scmSyncName` \ # optionals

Examples

Perl

$cmdr->modifyScmSync('default' 'testScmSync1', {branch => 'next', configurationName => 'my-git-config', scmType => 'git', syncType => 'fromScm', repository => 'Repo', resourceName => 'local', destinationDir => 'c:\tmp'});

ectool usage

ectool modifyScmSync 'default' 'testScmSync1' \ --branch 'main' \ --configurationName 'my-git-config' \ --scmType 'git' \ --syncType 'fromScm' \ --repository 'Repo' \ --resourceName 'local' \ --destinationDir 'c:\tmp'