modifyPluginConfiguration

Back to index

Summary

Modifies a plugin configuration.

projectName

Stringrequired

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

pluginConfigurationName

Stringrequired

Unique name of the plugin configuration within the project.

clearCredentialName

Arrayoptional

Collection of existing credential names to be cleared for the plugin configuration.

clearCredentials

Booleanoptional

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

clearFields

Booleanoptional

Whether or not to clear fields for the plugin configuration.

credentialReferenceParameter

Arrayoptional

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.

credential

Arrayoptional

Credentials to be used by the plugin config.

description

Stringoptional

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

field

Arrayoptional

Fields for plugin configuration.

newName

Stringoptional

The new name for an existing object that is being renamed.

Usage

Perl

$cmdr->modifyPluginConfiguration(
  "test-projectName", # projectName
  "test-pluginConfigurationName" # pluginConfigurationName
  # optionals
);▼

ectool

ectool modifyPluginConfiguration \
  "test-projectName" `# projectName` \
  "test-pluginConfigurationName" `# pluginConfigurationName` \
  # optionals▼

Examples

ectool

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>▼