createApplicationFromDeploymentPackage
Runs a procedure that creates an application from a deployment package.
Arguments
| Argument Name | Type | Description |
|---|---|---|
artifactGroup |
String |
(Required) The artifact group. |
artifactKey |
String |
(Required) The artifact key. |
artifactVersion |
String |
(Required) The artifact version. |
artifactFileName |
String |
(Required) The artifact file name. |
dslString |
String |
The DSL to pass to invoking procedure. |
retrieveToFolder |
String |
The folder where the artifact is retrieved. The default value is a dot ( |
deleteLicense
getLicense
getServerStatus
Retrieves the current status of the CloudBees CD/RO server, including log messages generated during the startup sequence.
Arguments
| Argument Name | Type | Description |
|---|---|---|
block |
Boolean |
True means wait until the server reaches a new state. |
diagnostics |
Boolean |
True to include server diagnostics. |
serverStateOnly |
Boolean |
The response includes only the serverState element. |
timeout |
Integer |
How many seconds before the blocking command times out. |
importLicenseData
setCIEventsSchemaConfiguration
Change the CI events schema configuration.
Arguments
| Argument Name | Type | Description |
|---|---|---|
eventName |
String |
(Required) Name of the event. |
version |
Long |
(Required) Version of the event schema. |
destination |
CIEventDestination |
Destination of the event. |
destinationMappings |
Collection |
Mapping destination types to JSON text with the mapping fields. |
eventSchema |
String |
JSON text for the event schema. Required if the event does not already have a schema registered. |
setDevOpsInsightServerConfiguration
Sets the DevOps Insight Server configuration.
Arguments
| Argument Name | Type | Description |
|---|---|---|
elasticSearchUrl |
String |
CloudBees CD/RO server retrieves data from ElasticSearch using this URL. This URL must be set if DevOps Insight is enabled. |
enabled |
Boolean |
If true, enables DevOps Insight. |
logStashUrl |
String |
DEPRECATED: This is the URL where LogStash receives data from CloudBees CD/RO server. This URL must be set if DevOps Insight is enabled. |
password |
String |
The password for authenticating with the DevOps Insight Server. |
testConnection |
Boolean |
Whether the connection to the DevOps Insight Server should be tested before saving the configuration. Defaults to false. |
userName |
String |
The user name for authenticating with the DevOps Insight Server. |
setSsoConfiguration
setStatsdConfiguration
Change the statsd configuration.
Arguments
| Argument Name | Type | Description |
|---|---|---|
enabled |
Boolean |
True if metrics should be sent to the configured statsd server. |
flushRate |
String |
Sets the rate at which the client will flush the pending metric values to the network. E.g. if the rate is 0.1, 1 in 10 writes will flush the pending metrics. Must be between 0 and 1. The default is 0.01, flushing 1 in 100 writes. |
hostName |
String |
The host name of the statsd server to which metrics are sent. |
includeHostName |
Boolean |
True to include the CD server hostname in the name of statsd metrics. |
port |
Integer |
The port on the statsd server to which metrics are sent; defaults to port 8125. |
prefix |
String |
Prefix added to all statsd metric names; defaults to |
sampleRate |
String |
Sets the sample rate of elements that will be actually sent. E.g. if rate is 0.75, more or less 75% of items will be sent (and the @0.75 suffix will be added to the metrics). Must be between 0 and 1. The default is 1, sending all samples. |
shutdownServer
Shuts down the CloudBees CD/RO server. Shutting down the server can take as long as a couple of minutes, depending on the server activity level at the time the shutdown command is issued.
The CloudBees CD/RO server is composed of two processes. The main process is a Java Virtual Machine (JVM). The second process, called the wrapper, is responsible for interacting with the native operating system as a service. This wrapper process is responsible for starting and stopping the main JVM process.