CI configuration commands

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

createCIConfiguration

Creates a new 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. Argument Type: String
password	Password for authenticating with the CI server. 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	Username for authenticating with the CI server. 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. Argument Type: String

password

Password for authenticating with the CI server.

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

Username for authenticating with the CI server.

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 => "patty",
    password => "apassword"
  );

ectool

syntax: ectool createCIConfiguration <ciConfigurationName> [optionals]

Example

ectool createCIConfiguration 'CI Build Demo'
  --serverURL 'www.example.com/CIServer'
  --userName 'patty'
  --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.

Positional arguments

None

Response

A list of ciConfiguration objects.

ec-perl

syntax: $cmdr->getCIConfigurations;

Example

$cmdr->getCIConfigurations

ectool

syntax: ectool gCIConfigurations

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. Argument Type: String
newName	New name for the object. Argument Type: String
password	Password for authenticating with the CI server. 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	Username for authenticating with the CI server. 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. Argument Type: String

newName

New name for the object.

Argument Type: String

password

Password for authenticating with the CI server.

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

Username for authenticating with the CI server.

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 => "patty",
    password => "apassword"
  );

ectool

syntax: ectool modifyCIConfiguration <ciConfigurationName> [optionals]

Example

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