CI configuration commands

These commands provide the ability to manage connections to CI servers from within CloudBees CD/RO.

createCIConfiguration

Creates a new CI server configuration.

Arguments Descriptions

Arguments	Descriptions
ciConfigurationName	The name of this CI Configuration. Argument Type: String
ciConfigurationType	The type of configuration to create. `CI_CONTROLLER`: (default) An individual CI controller. `CB_OPS_CENTER`: A CloudBees operations center. Managed CI controllers for this operations center are automatically discovered. Argument Type: Enum
isDefault	(Optional) Boolean flag—`0\|1\|true\|false` If `true` or `1`, use this configuration as the default. Defaults to `false`. Argument Type: Boolean
overrideDefault	(Optional) Boolean flag—`0\|1\|true\|false` If `true` or `1`, override `isDefault` flag for the existing default CI configuration. Defaults to `false`. Argument Type: Boolean
description	(Optional) Comment text describing this object. This string is not interpreted at all by CloudBees CD/RO. Argument Type: String
refCIConfigurationName	The `ciConfigurationName` that uses the `userName` and `password`. Argument Type: String
serverUrl	The URL of the CI server. Argument Type: String
testConnection	(Optional) Boolean flag—`0\|1\|true\|false` Whether the connection to the CI Server should be tested before saving the configuration. Defaults to `false`. Argument Type: Boolean
userName	(Optional) Username for authenticating with the CI server. Argument Type: String
password	(Optional) Password for authenticating with the CI server. Argument Type: String
publicKey	(Optional) Public key for the CI controller. Use this argument to specify the public key for the CI controller if the server is unable to retrieve the controller’s public key due to network topology restrictions. Argument Type: String

ciConfigurationName

The name of this CI Configuration.

Argument Type: String

ciConfigurationType

The type of configuration to create.

CI_CONTROLLER: (default) An individual CI controller.
CB_OPS_CENTER: A CloudBees operations center. Managed CI controllers for this operations center are automatically discovered.

Argument Type: Enum

isDefault

(Optional) Boolean flag—0|1|true|false

If true or 1, use this configuration as the default. Defaults to false.

Argument Type: Boolean

overrideDefault

(Optional) Boolean flag—0|1|true|false

If true or 1, override isDefault flag for the existing default CI configuration. Defaults to false.

Argument Type: Boolean

description

(Optional) Comment text describing this object. This string is not interpreted at all by CloudBees CD/RO.

Argument Type: String

refCIConfigurationName

The ciConfigurationName that uses the userName and password.

Argument Type: String

serverUrl

The URL of the CI server.

Argument Type: String

testConnection

(Optional) Boolean flag—0|1|true|false

Whether the connection to the CI Server should be tested before saving the configuration. Defaults to false.

Argument Type: Boolean

userName

(Optional) Username for authenticating with the CI server.

Argument Type: String

password

(Optional) Password for authenticating with the CI server.

Argument Type: String

publicKey

(Optional) Public key for the CI controller. Use this argument to specify the public key for the CI controller if the server is unable to retrieve the controller’s public key due to network topology restrictions.

Argument Type: String

Positional arguments

ciConfigurationName

Response

Returns a ciConfiguration object.

ec-perl

syntax: $cmdr->createCIConfiguration (<ciConfigurationName>, {<optionals>});

Example

$cmdr->createCIConfiguration
  (
    ciConfigurationName => "CI Build Demo",
    serverURL => "www.example.com/CIServer",
    userName => "joe",
    password => "apassword"
  );▼

ectool

syntax: ectool createCIConfiguration <ciConfigurationName> [optionals]

Example

ectool createCIConfiguration 'CI Build Demo'
  --serverURL 'www.example.com/CIServer'
  --userName 'joe'
  --password 'apassword'▼

deleteCIConfiguration

Deletes a CI configuration.

Arguments	Descriptions
ciConfigurationName	The name of the CI Configuration. Argument Type: String

Arguments

Descriptions

ciConfigurationName

The name of the CI Configuration. Argument Type: String

Positional arguments

ciConfigurationName

Response

None.

ec-perl

syntax: $cmdr->deleteCIConfiguration (<ciConfigurationName>);

Example

$cmdr->deleteCIConfiguration
  (
    ciConfigurationName => "CD Build Demo"
  );▼

ectool

syntax: ectool deleteCIConfiguration <ciConfigurationName>

Example

ectool deleteCIConfiguration 'CD Build Demo'▼

getCIConfiguration

Gets a CI configuration.

Arguments	Descriptions
ciConfigurationName	The name of the CI Configuration. Argument Type: String

Arguments

Descriptions

ciConfigurationName

The name of the CI Configuration.

Argument Type: String

Positional arguments

ciConfigurationName

Response

The specified ciConfiguration object.

ec-perl

syntax: $cmdr->getCIConfiguration (<ciConfigurationName>);

Example

$cmdr->getCIConfiguration
  (
    ciConfigurationName => "CD Build Demo"
  );▼

ectool

syntax: ectool getCIConfiguration <ciConfigurationName>

Example

ectool getCIConfiguration 'CD Build Demo'▼

getCIConfigurations

Gets all CI configurations.

Arguments Descriptions

Arguments	Descriptions
ciConfigurationType	(Optional) The type of configuration to create. If not specified, all configurations are returned. `CI_CONTROLLER`: An individual CI controller. `CB_OPS_CENTER`: A CloudBees operations center. Managed CI controllers for this operations center are automatically discovered. Argument Type: Enum

ciConfigurationType

(Optional) The type of configuration to create. If not specified, all configurations are returned.

CI_CONTROLLER: An individual CI controller.
CB_OPS_CENTER: A CloudBees operations center. Managed CI controllers for this operations center are automatically discovered.

Argument Type: Enum

Positional arguments

None

Response

A list of ciConfiguration objects.

ec-perl

syntax: $cmdr->getCIConfigurations;

Example

$cmdr->getCIConfigurations▼

ectool

syntax: ectool getCIConfigurations

Example

ectool getCIConfigurations▼

modifyCIConfiguration

Modifies an existing CI server configuration.

Arguments Descriptions

Arguments	Descriptions
ciConfigurationName	The name of the CI Configuration. Argument Type: String
description	(Optional) Comment text describing this object. This string is not interpreted at all by CloudBees CD/RO. Argument Type: String
newName	New name for the object. Argument Type: String
ciConfigurationType	The type of configuration to create. `CI_CONTROLLER`: (default) An individual CI controller. `CB_OPS_CENTER`: A CloudBees operations center. Managed CI controllers for this operations center are automatically discovered. Argument Type: Enum
isDefault	(Optional) Boolean flag—`0\|1\|true\|false` If `true` or `1`, use this configuration as the default. Defaults to `false`. Argument Type: Boolean
overrideDefault	(Optional) Boolean flag—`0\|1\|true\|false` If `true` or `1`, override `isDefault` flag for the existing default CI configuration. Defaults to `false`. Argument Type: Boolean
serverUrl	The URL of the CI server. Argument Type: String
testConnection	(Optional) Boolean flag—`0\|1\|true\|false` Whether the connection to the CI Server should be tested before saving the configuration. Defaults to `false`. Argument Type: Boolean
userName	Username for authenticating with the CI server. Argument Type: String
password	Password for authenticating with the CI server. Argument Type: String
publicKey	Public key for the CI controller. Use this argument to specify the public key for the CI controller if the server is unable to retrieve the controller’s public key due to network topology. Argument Type: String

ciConfigurationName

The name of the CI Configuration. Argument Type: String

description

(Optional) Comment text describing this object. This string is not interpreted at all by CloudBees CD/RO. Argument Type: String

newName

New name for the object.

Argument Type: String

ciConfigurationType

The type of configuration to create.

CI_CONTROLLER: (default) An individual CI controller.
CB_OPS_CENTER: A CloudBees operations center. Managed CI controllers for this operations center are automatically discovered.

Argument Type: Enum

isDefault

(Optional) Boolean flag—0|1|true|false

If true or 1, use this configuration as the default. Defaults to false.

Argument Type: Boolean

overrideDefault

(Optional) Boolean flag—0|1|true|false

If true or 1, override isDefault flag for the existing default CI configuration. Defaults to false.

Argument Type: Boolean

serverUrl

The URL of the CI server.

Argument Type: String

testConnection

(Optional) Boolean flag—0|1|true|false

Whether the connection to the CI Server should be tested before saving the configuration. Defaults to false.

Argument Type: Boolean

userName

Username for authenticating with the CI server.

Argument Type: String

password

Password for authenticating with the CI server.

Argument Type: String

publicKey

Public key for the CI controller. Use this argument to specify the public key for the CI controller if the server is unable to retrieve the controller’s public key due to network topology.

Argument Type: String

Positional arguments

ciConfigurationName

Response

Returns a ciConfiguration object.

ec-perl

syntax: $cmdr->modifyCIConfiguration (<ciConfigurationName>, {<optionals>});

Example

$cmdr->modifyCIConfiguration
  (
    ciConfigurationName => "CI Build Demo",
    serverURL => "www.example.com/CIServer",
    userName => "joe",
    password => "apassword"
  );▼

ectool

syntax: ectool modifyCIConfiguration <ciConfigurationName> [optionals]

Example

ectool modifyCIConfiguration 'CI Build Demo'
  --serverURL 'www.example.com/CIServer'
  --userName 'joe'
  --password 'apassword'▼