Plugin configuration management

3 minute readReference

createPluginConfiguration

Create a new plugin configuration.

ArgumentsDescriptions

projectName

(required) The name for the project that must be unique among all projects.

Argument type: String

pluginConfigurationName

(required) Unique name of the plugin configuration within the project.

Argument type: String

pluginKey

(optional) The plugin key. Specify pluginKey or pluginProjectName.

Argument type: String

pluginProjectName

(optional) The name for the plugin’s project. Specify pluginKey or pluginProjectName.

Argument type: String

credentialReferenceParameter

(optional) 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.

Argument type: array of the key value pairs:

<credName>=<credReference>

credential

(optional) Password prompted during a CLI call. Credentials to be used by the plugin config.

Argument type: array of the key value pairs:

<credName>=<userName>

description

(optional) Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

Argument type: String

field

Fields for plugin configuration.

Argument type: array of the key value pairs:

<field_name>=<field_value>

Syntax

Usage: createPluginConfiguration <projectName> <pluginConfigurationName>
        [--credentialReferenceParameter <var1>=<val1> [<var2>=<val2> ...]]
        [--credential <credName>=<userName> [<credName>=<userName> ...]]
        [--description <description>]
        [--field <var1>=<val1> [<var2>=<val2> ...]]
        [--pluginKey <pluginKey>]
        [--pluginProjectName <pluginProjectName>]

Example

ectool createPluginConfiguration projectA test-git-00 --pluginKey EC-Git --field authType=token library=jgit --credential token_credential=new_git_cred --description "test git configuration 00"

Response

<response requestId="1" nodeId="192.168.250.178">
    <pluginConfiguration>
      <pluginConfigurationId>620815fc-df1b-11eb-8657-a4c3f0873bac</pluginConfigurationId>
      <pluginConfigurationName>test-git-00</pluginConfigurationName>
      <createTime>2021-07-07T12:03:46.629Z</createTime>
      <description>test git configuration 00</description>
      <lastModifiedBy>admin</lastModifiedBy>
      <modifyTime>2021-07-07T12:03:46.629Z</modifyTime>
      <owner>admin</owner>
      <pluginKey>EC-Git</pluginKey>
      <projectName>projectA</projectName>
      <propertySheetId>6208b23e-df1b-11eb-8657-a4c3f0873bac</propertySheetId>
      <tracked>1</tracked>
      <credentialMappings>
        <parameterDetail>
          <parameterName>token_credential</parameterName>
          <parameterType>runtime</parameterType>
          <parameterValue>/projects/projectA/credentials/test-git-00-token_credential-20210707150346</parameterValue>
        </parameterDetail>
      </credentialMappings>
      <fields>
        <parameterDetail>
          <parameterName>authType</parameterName>
          <parameterValue>token</parameterValue>
        </parameterDetail>
        <parameterDetail>
          <parameterName>library</parameterName>
          <parameterValue>jgit</parameterValue>
        </parameterDetail>
      </fields>
    </pluginConfiguration>
  </response>

Example

ectool createPluginConfiguration projectA test-git-01 --pluginKey EC-Git --field authType=password library=jgit --credentialReferenceParameter credential=/projects/projectA/credentials/git_creds --description "test git configuration 01"

Response

<response requestId="1" nodeId="192.168.250.178">
    <pluginConfiguration>
      <pluginConfigurationId>c66369dc-df25-11eb-b9d0-a4c3f0873bac</pluginConfigurationId>
      <pluginConfigurationName>test-git-01</pluginConfigurationName>
      <createTime>2021-07-07T13:18:10.002Z</createTime>
      <description>test git configuration 01</description>
      <lastModifiedBy>admin</lastModifiedBy>
      <modifyTime>2021-07-07T13:18:10.002Z</modifyTime>
      <owner>admin</owner>
      <pluginKey>EC-Git</pluginKey>
      <projectName>projectA</projectName>
      <propertySheetId>c663b7fe-df25-11eb-b9d0-a4c3f0873bac</propertySheetId>
      <tracked>1</tracked>
      <credentialMappings>
        <parameterDetail>
          <parameterName>credential</parameterName>
          <parameterType>reference</parameterType>
          <parameterValue>/projects/projectA/credentials/git_creds</parameterValue>
        </parameterDetail>
      </credentialMappings>
      <fields>
        <parameterDetail>
          <parameterName>authType</parameterName>
          <parameterValue>password</parameterValue>
        </parameterDetail>
        <parameterDetail>
          <parameterName>library</parameterName>
          <parameterValue>jgit</parameterValue>
        </parameterDetail>
      </fields>
    </pluginConfiguration>
  </response>

modifyPluginConfiguration

Modify a plugin configuration.

ArgumentsDescriptions

projectName

(required) The name for the project that must be unique among all projects.

Argument type: String

pluginConfigurationName

(required) Unique name of the plugin configuration within the project.

Argument type: String

clearCredentials

(optional) < Boolean flag— 0|1|true|false >

Whether or not to clear existing credentials for the plugin configuration.

Argument type: boolean

clearFields

(optional) < Boolean flag— 0|1|true|false >

Whether or not to clear fields for the plugin configuration.

Argument type: boolean

credentialReferenceParameter

(optional) 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.

Argument type: array of the key value pairs:

<credName>=<credReference>

credential

(optional) Credentials to be used by the plugin config.

Argument type: array of the key value pairs:

<credName>=<userName>

description

(optional) Comment text describing this object that is not interpreted at all by CloudBees CD.

Argument type: String

field

Fields for plugin configuration.

Argument type: array of the key value pairs:

<field_name>=<field_value>

newName

(optional) New name for an existing object that is being renamed.

Argument type: string

Syntax

Usage: modifyPluginConfiguration <projectName> <pluginConfigurationName>
        [--clearCredentials <0|1|true|false>]
        [--clearFields <0|1|true|false>]
        [--credentialReferenceParameter <var1>=<val1> [<var2>=<val2> ...]]
        [--credential <credName>=<userName> [<credName>=<userName> ...]]
        [--description <description>]
        [--field <var1>=<val1> [<var2>=<val2> ...]]
        [--newName <newName>]

Example

ectool modifyPluginConfiguration projectA test-git-01 --clearFields 1 --field authType=password library=git --description "test git configuration 01 new"

Response

<response requestId="1" nodeId="192.168.250.178">
    <pluginConfiguration>
      <pluginConfigurationId>c66369dc-df25-11eb-b9d0-a4c3f0873bac</pluginConfigurationId>
      <pluginConfigurationName>test-git-01</pluginConfigurationName>
      <createTime>2021-07-07T13:18:10.002Z</createTime>
      <description>test git configuration 01 new</description>
      <lastModifiedBy>admin</lastModifiedBy>
      <modifyTime>2021-07-07T13:21:27.809Z</modifyTime>
      <owner>admin</owner>
      <pluginKey>EC-Git</pluginKey>
      <projectName>projectA</projectName>
      <propertySheetId>c663b7fe-df25-11eb-b9d0-a4c3f0873bac</propertySheetId>
      <tracked>1</tracked>
      <credentialMappings>
        <parameterDetail>
          <parameterName>credential</parameterName>
          <parameterType>reference</parameterType>
          <parameterValue>/projects/projectA/credentials/git_creds</parameterValue>
        </parameterDetail>
      </credentialMappings>
      <fields>
        <parameterDetail>
          <parameterName>authType</parameterName>
          <parameterValue>password</parameterValue>
        </parameterDetail>
        <parameterDetail>
          <parameterName>library</parameterName>
          <parameterValue>git</parameterValue>
        </parameterDetail>
      </fields>
    </pluginConfiguration>
  </response>

deletePluginConfiguration

Delete a plugin configuration.

ArgumentsDescriptions

projectName

(required) The name for the project that must be unique among all projects.

Argument type: String

pluginConfigurationName

(required) Unique name of the plugin configuration within the project.

Argument type: String

Syntax

Usage: deletePluginConfiguration <projectName> <pluginConfigurationName>

Example

ectool deletePluginConfiguration projectA test-git-01

getPluginConfiguration

Find a plugin configuration.

ArgumentsDescriptions

projectName

(required) The name for the project that must be unique among all projects.

Argument type: String

pluginConfigurationName

(required) Unique name of the plugin configuration within the project.

Argument type: String

Syntax

Usage: getPluginConfiguration <projectName> <pluginConfigurationName>

Example

ectool getPluginConfiguration projectA test-git-00

Response

<response requestId="1" nodeId="192.168.250.178">
    <pluginConfiguration>
      <pluginConfigurationId>c66369dc-df25-11eb-b9d0-a4c3f0873bac</pluginConfigurationId>
      <pluginConfigurationName>test-git-01</pluginConfigurationName>
      <createTime>2021-07-07T13:18:10.002Z</createTime>
      <description>test git configuration 01</description>
      <lastModifiedBy>admin</lastModifiedBy>
      <modifyTime>2021-07-07T13:18:10.002Z</modifyTime>
      <owner>admin</owner>
      <pluginKey>EC-Git</pluginKey>
      <projectName>projectA</projectName>
      <propertySheetId>c663b7fe-df25-11eb-b9d0-a4c3f0873bac</propertySheetId>
      <tracked>1</tracked>
      <credentialMappings>
        <parameterDetail>
          <parameterName>credential</parameterName>
          <parameterType>reference</parameterType>
          <parameterValue>/projects/projectA/credentials/git_creds</parameterValue>
        </parameterDetail>
      </credentialMappings>
      <fields>
        <parameterDetail>
          <parameterName>authType</parameterName>
          <parameterValue>password</parameterValue>
        </parameterDetail>
        <parameterDetail>
          <parameterName>library</parameterName>
          <parameterValue>jgit</parameterValue>
        </parameterDetail>
      </fields>
    </pluginConfiguration>
  </response>

getPluginConfigurations

Find one or more plugin configurations.

ArgumentsDescriptions

pluginKey

(optional) The plugin Key.

Argument type: String

projectName

(optional) The name for the project that must be unique among all projects.

Argument type: String

pluginProjectName

(optional) The name for the plugin’s project.

Argument type: String

Syntax

Usage: getPluginConfigurations
        [--pluginKey <pluginKey>]
        [--pluginProjectName <pluginProjectName>]
        [--projectName <projectName>]

Example

ectool getPluginConfigurations --pluginKey EC-Git

Response

<response requestId="1" nodeId="192.168.250.178">
    <pluginConfiguration>
      <pluginConfigurationId>00c35965-de7e-11eb-9042-a4c3f0873bac</pluginConfigurationId>
      <pluginConfigurationName>test git 00</pluginConfigurationName>
      <createTime>2021-07-06T17:17:12.462Z</createTime>
      <description>test git credential 00 description</description>
      <lastModifiedBy>admin</lastModifiedBy>
      <modifyTime>2021-07-06T17:17:12.462Z</modifyTime>
      <owner>admin</owner>
      <pluginKey>EC-Git</pluginKey>
      <projectName>Default</projectName>
      <propertySheetId>00c35967-de7e-11eb-9042-a4c3f0873bac</propertySheetId>
      <tracked>1</tracked>
      <credentialMappings>
        <parameterDetail>
          <parameterName>token_credential</parameterName>
          <parameterValue>/projects/Default/credentials/test git 00-token_credential-20210706201712</parameterValue>
        </parameterDetail>
      </credentialMappings>
      <fields>
        <parameterDetail>
          <parameterName>authType</parameterName>
          <parameterValue>token</parameterValue>
        </parameterDetail>
        <parameterDetail>
          <parameterName>library</parameterName>
          <parameterValue>jgit</parameterValue>
        </parameterDetail>
      </fields>
    </pluginConfiguration>
    <pluginConfiguration>
      <pluginConfigurationId>5703ece6-de7f-11eb-8f00-a4c3f0873bac</pluginConfigurationId>
      <pluginConfigurationName>test git 00</pluginConfigurationName>
      <createTime>2021-07-06T17:26:46.692Z</createTime>
      <description>test git credential 00 description</description>
      <lastModifiedBy>admin</lastModifiedBy>
      <modifyTime>2021-07-06T17:26:46.692Z</modifyTime>
      <owner>admin</owner>
      <pluginKey>EC-Git</pluginKey>
      <projectName>projectA</projectName>
      <propertySheetId>5703ece8-de7f-11eb-8f00-a4c3f0873bac</propertySheetId>
      <tracked>1</tracked>
      <credentialMappings>
        <parameterDetail>
          <parameterName>token_credential</parameterName>
          <parameterValue>/projects/projectA/credentials/test git 00-token_credential-20210706202646</parameterValue>
        </parameterDetail>
      </credentialMappings>
      <fields>
        <parameterDetail>
          <parameterName>authType</parameterName>
          <parameterValue>token</parameterValue>
        </parameterDetail>
        <parameterDetail>
          <parameterName>library</parameterName>
          <parameterValue>jgit</parameterValue>
        </parameterDetail>
      </fields>
    </pluginConfiguration>
    <pluginConfiguration>
      <pluginConfigurationId>620815fc-df1b-11eb-8657-a4c3f0873bac</pluginConfigurationId>
      <pluginConfigurationName>test-git-00</pluginConfigurationName>
      <createTime>2021-07-07T12:03:46.629Z</createTime>
      <description>test git configuration 00</description>
      <lastModifiedBy>admin</lastModifiedBy>
      <modifyTime>2021-07-07T12:03:46.629Z</modifyTime>
      <owner>admin</owner>
      <pluginKey>EC-Git</pluginKey>
      <projectName>projectA</projectName>
      <propertySheetId>6208b23e-df1b-11eb-8657-a4c3f0873bac</propertySheetId>
      <tracked>1</tracked>
      <credentialMappings>
        <parameterDetail>
          <parameterName>token_credential</parameterName>
          <parameterValue>/projects/projectA/credentials/test-git-00-token_credential-20210707150346</parameterValue>
        </parameterDetail>
      </credentialMappings>
      <fields>
        <parameterDetail>
          <parameterName>authType</parameterName>
          <parameterValue>token</parameterValue>
        </parameterDetail>
        <parameterDetail>
          <parameterName>library</parameterName>
          <parameterValue>jgit</parameterValue>
        </parameterDetail>
      </fields>
    </pluginConfiguration>
  </response>