Groovy API reference

Plugin configuration

3 minute readReference

createPluginConfiguration

This command is a Preview feature.
Preview

A Preview feature:

  • Has not undergone end-to-end testing with CloudBees products

  • Is provided without service-level agreements (SLA) and therefore does not include CloudBees' commitment on functionality or performance

  • May impact other stable areas of the product when used

  • May have limited documentation

  • May not be feature complete during the Preview period

  • May graduate from preview state to fully supported or be removed from the product

  • May introduce incompatible, backward-breaking changes that could revoke the ability to upgrade

Product features and documentation are frequently updated. If you find an issue or have a suggestion, please contact CloudBees Support.

Creates a new plugin configuration.

Arguments

Argument Name Type Description

projectName

String

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

pluginConfigurationName

String

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

credentialReferenceParameters

Map

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.

credentials

Collection

Credentials to be used by the plugin config.

description

String

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

fields

Map

Fields for plugin configuration.

pluginKey

String

The plugin key.

pluginProjectName

String

The name for the plugin’s project.

Positional arguments

projectName, pluginConfigurationName

Usage

ec-perl

$cmdr->createPluginConfiguration(<projectName>, <pluginConfigurationName>, {<optionals>});

ectool

ectool createPluginConfiguration projectName,  pluginConfigurationName, [optionals]

deletePluginConfiguration

Deletes a plugin configuration.

Arguments

Argument Name Type Description

projectName

String

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

pluginConfigurationName

String

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

Positional arguments

projectName, pluginConfigurationName

Usage

ec-perl

$cmdr->deletePluginConfiguration(<projectName>, <pluginConfigurationName>);

ectool

ectool deletePluginConfiguration projectName,  pluginConfigurationName

getPluginConfiguration

Finds a plugin configuration.

Arguments

Argument Name Type Description

projectName

String

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

pluginConfigurationName

String

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

Positional arguments

projectName, pluginConfigurationName

Usage

ec-perl

$cmdr->getPluginConfiguration(<projectName>, <pluginConfigurationName>);

ectool

ectool getPluginConfiguration projectName,  pluginConfigurationName

getPluginConfigurations

This command is a Preview feature.
Preview

A Preview feature:

  • Has not undergone end-to-end testing with CloudBees products

  • Is provided without service-level agreements (SLA) and therefore does not include CloudBees' commitment on functionality or performance

  • May impact other stable areas of the product when used

  • May have limited documentation

  • May not be feature complete during the Preview period

  • May graduate from preview state to fully supported or be removed from the product

  • May introduce incompatible, backward-breaking changes that could revoke the ability to upgrade

Product features and documentation are frequently updated. If you find an issue or have a suggestion, please contact CloudBees Support.

Find plugin configurations.

Arguments

Argument Name Type Description

pluginKey

String

The plugin’s key.

pluginProjectName

String

The name for the plugin’s project.

projectName

String

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

Positional arguments

None.

Usage

ec-perl

$cmdr->getPluginConfigurations({<optionals>});

ectool

ectool getPluginConfigurations [optionals]

modifyPluginConfiguration

This command is a Preview feature.
Preview

A Preview feature:

  • Has not undergone end-to-end testing with CloudBees products

  • Is provided without service-level agreements (SLA) and therefore does not include CloudBees' commitment on functionality or performance

  • May impact other stable areas of the product when used

  • May have limited documentation

  • May not be feature complete during the Preview period

  • May graduate from preview state to fully supported or be removed from the product

  • May introduce incompatible, backward-breaking changes that could revoke the ability to upgrade

Product features and documentation are frequently updated. If you find an issue or have a suggestion, please contact CloudBees Support.

Modifies a plugin configuration.

Arguments

Argument Name Type Description

projectName

String

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

pluginConfigurationName

String

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

clearCredentialNames

Collection

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

clearCredentials

Boolean

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

clearFields

Boolean

Whether or not to clear fields for the plugin configuration.

credentialReferenceParameters

Map

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.

credentials

Collection

Credentials to be used by the plugin config.

description

String

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

fields

Map

Fields for plugin configuration.

newName

String

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

Positional arguments

projectName, pluginConfigurationName

Usage

ec-perl

$cmdr->modifyPluginConfiguration(<projectName>, <pluginConfigurationName>, {<optionals>});

ectool

ectool modifyPluginConfiguration projectName,  pluginConfigurationName, [optionals]