createCIConfiguration

Back to index

Summary

Creates a new CI server configuration.

ciConfigurationName

Stringrequired

The name of the CI configuration.

ciConfigurationType

Stringoptional

The type of CI configuration.

Possible values: "CB_OPS_CENTER", "CI_CONTROLLER"

credentialName

Stringoptional

The name of the credential.

credentialProjectName

Stringoptional

The name of the project containing specified credential.

description

Stringoptional

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

isDefault

Booleanoptional

Set as default CI Configuration.

overrideDefault

Booleanoptional

If true, the isDefault flag is overwritten for the existing, default CI configuration.

password

Stringoptional

The password for authenticating with the CI server.

publicKey

Stringoptional

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.

refCIConfiguration

Stringoptional

References the CI configuration to use the userName and password or API token.

serverUrl

Stringoptional

URL to connect to the CI server. If using an IPv6 address, enclose the address in square brackets. Example: [<IPv6-ADDRESS>].

testConnection

Booleanoptional

Specifies if the connection to the CI server should be tested before saving the configuration. The default is false.

userName

Stringoptional

The user name for authenticating with the CI server.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.createCIConfiguration(
  ciConfigurationName: "test-ciConfigurationName"
  /* optional arguments */
)▼