Configuration as Code (CasC) CLI

8 minute readAutomation

You can use the Jenkins CLI to manage CasC bundles and create a new item in the operations center based on a CasC items.yaml file.

Authentication and authorization

To access the Jenkins CLI tool, you need to set up authentication with SSL or using an API token.

Administrator permissions are required for authorization.

Commands

Table 1. Commands
CommandDescriptionParametersPrerequisites

casc-bundle-list

Lists all available controller CasC bundles on the operations center.

None.

casc-bundle-check-bundle-update

Checks for bundle updates. If a bundle update is available, you can issue the casc-bundle-reload-bundle command to immediately apply the updated bundle without restarting the instance.

None.

casc-bundle-regenerate-token -c (--controller-path) <controller path>

Regenerates the token and returns the new bundle information when successful.

  • Name: controller-path

    • Parameter type: Query string parameter

    • Data type: string

    • Description: The full path of the controller item in the operations center. For example, folder1/controller1.

The bundle-id parameter has been deprecated in version 2.289.1.2. The controller-path parameter should be used for all new applications.

casc-bundle-set-availability-pattern -b (--bundle-id) <bundle-id> -p (--availability-pattern) <"availability pattern">

Specifies the availability pattern to define the path to controllers that can use the bundle.

  • Name: bundle-id

    • Parameter type: Query string parameter

    • Data type: string

    • Description: The name of the folder that contains the CasC bundle. For example, casc-bundle-java.

  • Name: availability-pattern

    • Parameter type: Query string parameter

    • Data Type: string

    • Description: The full path to one or more controllers that can use the bundle. This must be a regular expression enclosed in quotation marks, and defines the bundles you can assign to a controller. For example, "folder1/.*" to use the bundle with any controller in the "folder1" folder.

casc-bundle-set-global-availability-pattern-behavior -v (--visibility) <visibility>

Specifies the default global availability pattern behavior for the controller CasC bundle.

  • Name: visibility

    • Parameter type: Query string parameter

    • Data type: string

    • Description: When the parameter value is true, all CasC bundles that do not have an availability pattern defined can be used by any controller. This option provides more flexibility, but is less secure.

casc-bundle-clear-availability-pattern -b (--bundle-id) <bundle id>

Uses the availability pattern defined in the bundle.yaml file and clears the availability pattern for the controller CasC bundle if previously defined.

  • Name: bundle-id

    • Parameter type: Query string parameter

    • Data type: string

    • Description: The name of the folder that contains the CasC bundle. For example, casc-bundle-java.

casc-bundle-set-controller -b (--bundle-id) <bundle id> -c (--controller-path) <controller path>

Assigns a bundle to a controller and returns the bundle information when successful.

For this command to be successful, you must first define the availability pattern for the bundle using the casc-bundle-set-availability-pattern or casc-bundle-set-global-availability-pattern-behavior command.

  • Name: bundle-id

    • Parameter type: Query string parameter

    • Data type: string

    • Description: The name of the folder that contains the CasC bundle. For example, casc-bundle-java.

  • Name: controller-path

    • Parameter type: Query string parameter

    • Data type: string

    • Description: The full path of the controller item in the operations center. For example, folder1/controller1.

casc-bundle-set-default-bundle -b (--bundle-id) <bundle id>

Specifies a default bundle that is pre-selected in the operations center controller configuration screen when setting up a new controller and returns the bundle information when successful.

The default bundle is pre-selected for controllers that match the availability pattern of the default bundle. To set the availability pattern of the default bundle, you can use the casc-bundle-set-availability-pattern or casc-bundle-set-global-availability-pattern-behavior command.

Specifying a default bundle does not assign the bundle to a controller. When setting up a new controller in the operations center, you must click Save or Apply from the controller configuration screen to assign the pre-selected bundle to the controller.

Name: bundle-id

  • Name: bundle-id

    • Parameter type: Query string parameter

    • Data type: string

    • Description: The name of the folder that contains the CasC bundle. For example, casc-bundle-java.

casc-bundle-reload-bundle

Applies the bundle update without restarting the instance, when possible.

None.

casc-items-create-items <oc/folder> = < <local-folder/items.yaml>

Creates a new item in the operations center based on an items.yaml file stored in the local filesystem.

  • oc/folder: The full path of the folder in the operations center where the item is created. The folder path must exist in the operations center prior to issuing the command. For example, /folder1. To create the item at the root of the operations center, you can use / as the folder path.

  • local-folder/items.yaml: The full path on the local filesystem to the items.yaml file. For example, /casc/items.yaml.

casc-bundle-set-master -b (--bundle-id) <bundle id> -m (--master-path) <controller path>

Assigns a bundle to a controller and returns the bundle information when successful.

For this command to be successful, you must first define the availability pattern for the bundle using the casc-bundle-set-availability-pattern or casc-bundle-set-global-availability-pattern-behavior command.

If you are using CloudBees CI 2.277.4.2 or 2.277.4.3, and you issue the casc-bundle-set-master command, no bundles are available to assign to the controller. You must first sign in to the operations center as a user with the Administer permission, navigate to the Configuration as Code bundles screen, define the Availability pattern, and then issue the casc-bundle-set-master command to assign a bundle to a controller.
  • Name: bundle-id

    • Parameter type: Query string parameter

    • Data type: string

    • Description: The name of the folder that contains the CasC bundle. For example, casc-bundle-java.

  • Name: master-path

    • Parameter type: Query string parameter

    • Data type: string

    • Description: The full path of the controller item in the operations center. For example, folder1/controller1

The casc-bundle-set-master command has been deprecated in version 2.289.2.2 due to offensive terminology. The casc-bundle-set-controller command should be used for all new applications.

Command examples

In the command examples, "admin" is the name of the user attempting to send the request and "https://my-operations-center.com/" is the operations center URL. These examples authenticate using an API token.
Table 2. Command examples
CommandCommand example

casc-bundle-list

java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-list

casc-bundle-check-bundle-update

java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-check-bundle-update

casc-bundle-regenerate-token -c (--controller-path) <controller path>

java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-regenerate-token -c folder1/controller1

casc-bundle-set-availability-pattern -b (--bundle-id) <bundle-id> -p (--availability-pattern) <"availability pattern">

java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-set-availability-pattern -b casc-bundle-java -c folder1/controller1

casc-bundle-set-global-availability-pattern-behavior -v (--visibility) <visibility>

java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-set-global-availability-pattern-behavior -v true

casc-bundle-clear-availability-pattern -b (--bundle-id) <bundle id>

java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-clear-availability-pattern -b casc-bundle-java

casc-bundle-set-controller -b (--bundle-id) <bundle id> -c (--controller-path) <controller path>

java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-set-controller -b casc-bundle-java -c folder1/controller1

casc-bundle-set-default-bundle -b (--bundle-id) <bundle id>

java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-set-default-bundle -b casc-bundle-java

casc-bundle-reload-bundle

java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-reload-bundle

casc-items-create-items <oc/folder> = < <local-folder/items.yaml>

java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-items-create-items /folder1 = < /casc/items.yaml

casc-bundle-set-master -b (--bundle-id) <bundle id> -m (--master-path) <controller path>

java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-set-master -b casc-bundle-java -m folder1/controller1

Response examples

Response examples are formatted for better readability.
casc-bundle-list
casc-bundle-check-bundle-update
casc-bundle-regenerate-token -c (--controller-path) <controller path>
casc-bundle-set-availability-pattern -b (--bundle-id) <bundle-id> -p (--availability-pattern) <"availability pattern">
casc-bundle-set-global-availability-pattern-behavior -v (--visibility) <visibility>
casc-bundle-clear-availability-pattern -b (--bundle-id)
casc-bundle-set-controller -b (--bundle-id) <bundle id> -c (--controller-path) <controller path>
casc-bundle-set-default-bundle -b (--bundle-id) <bundle id>
casc-bundle-reload-bundle
casc-items-create-items <oc/folder> = < <local-folder/items.yaml>
casc-bundle-set-master -b (--bundle-id) <bundle id> -m (--master-path) <controller path>
{
    "bundles":[
        {
            "linkFileContent":"url: \"https://my-operation-center.com/config-bundle/casc-bundle-java\"\ntoken: \"\"\n",
            "regex":"folder1/.*",
            "name":"casc-bundle-java",
            "availabilityPatternFromYaml": true,
            "url":"https://my-operation-center.com/config-bundle/casc-bundle-java",
            "token":"",
            "usedBy": [
                "folder1/controller1"
            ],
            "availableFor": [
                "folder1/controller1",
                "folder1/controller2"
            ]
        }
    ]
}
A new version of the configuration bundle is available.
{
    "linkFileContent":"url: \"https://my-operation-center.com/config-bundle/casc-bundle-java\"\ntoken: \"\"\n",
    "regex":"folder1/.*",
    "name":"casc-bundle-java",
    "availabilityPatternFromYaml": true,
    "url":"https://my-operation-center.com/config-bundle/casc-bundle-java",
    "token":""
}
"folder1/.*"
true
"folder1/controller1"
{
    "linkFileContent": "url: \"https://my-operation-center.com/config-bundle/casc-bundle-java\"\ntoken: \"\"\n",
    "regex":"folder1/.*",
    "name":"casc-bundle-java",
    "availabilityPatternFromYaml": true,
    "url":"https://my-operation-center.com/config-bundle/casc-bundle-java",
    "token":""
}
{
    "linkFileContent": "url: \"https://my-operation-center.com/config-bundle/casc-bundle-java\"\ntoken: \"\"\n",
    "regex":"folder1/.*",
    "name":"casc-bundle-java",
    "availabilityPatternFromYaml": true,
    "url":"https://my-operation-center.com/config-bundle/casc-bundle-java",
    "token":""
}
Bundle successfully reloaded.
Created items on /folder1
{
    "linkFileContent": "url: \"https://my-operation-center.com/config-bundle/casc-bundle-java\"\ntoken: \"\"\n",
    "regex":"folder1/.*",
    "name":"casc-bundle-java",
    "availabilityPatternFromYaml": true,
    "url":"https://my-operation-center.com/config-bundle/casc-bundle-java",
    "token":""
}

Response model

Table 3. Response model
ElementTypeDescription

availableFor

array of objects

Controllers that can be assigned to the bundle based on the availability pattern.

availabilityPatternFromYaml

string

Returns true if the availability pattern is defined in the bundle.yaml file. Returns false if the availability pattern is defined in the UI or using the casc-bundle-set-availability-pattern command.

bundles

array of objects

All bundles available on the operations center.

linkFileContent

string

Contains two entries in string format enclosed in quotes and separated by newline characters: url and token. The url is the bundle URL where the operations center exposes its content. The token is the access token for the bundle.

name

string

The name of the folder that contains the CasC bundle. For example, casc-bundle-java.

regex

string

The full path to one or more controllers in the operations center that can use the bundle. This must be a regular expression. It defines the bundles you can assign to a controller. For example, "folder1/.*".

token

string

The access token for the bundle.

url

string

The bundle URL where the operations center exposes its content.

usedBy

string

The names of controllers assigned to the bundle.

Status and exit codes

Table 4. Status and exit codes
CodeDescription

0

Success

6

Not authorized. Administrator permission required.

3

The provided parameter (bundle id or controller path) does not match the available bundles.

Examples for configuring a controller using CasC

Once the CasC bundle has been configured in the operations center, you can define an availability pattern to make the bundle available to controllers, assign the bundle to a controller, and specify a default bundle.

  1. Issue the casc-bundle-list command to list all available CasC bundles on the operations center. For example:

    java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-list

    In this example, there is one bundle named casc-bundle-java:

    {
        "bundles":[
            {
                "linkFileContent":"url: \"https://my-operation-center.com/config-bundle/casc-bundle-java\"\ntoken: \"\"\n",
                "regex":"",
                "name":"casc-bundle-java",
                "availabilityPatternFromYaml": true,
                "url":"https://my-operation-center.com/config-bundle/casc-bundle-java",
                "token": "",
                "usedBy": [],
                "availableFor": []
            }
        ]
    }
  2. Define the availability pattern for the bundle. You have two options:

    • Option 1: Issue the casc-bundle-set-availability-pattern command to define the path to the controllers that can use the bundle. For example:

      java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-set-availability-pattern -b casc-bundle -p "folder1/.*"

      If successful, the specified availability pattern is returned:

      "folder1/.*"
    • Option 2: Issue the casc-bundle-set-global-availability-pattern-behavior command to define the default global availability pattern behavior for bundles that do not have an availability pattern defined. This option provides more flexibility, but is less secure. For example:

      java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-set-global-availability-pattern-behavior -v true

      If successful, the default global availability pattern behavior is returned:

      true
  3. Issue the casc-bundle-set-controller command to assign a bundle to a controller. For example:

    java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-set-controller -b casc-bundle-java -c folder1/controller1

    If successful, the bundle information is returned:

    {
        "linkFileContent":"url: \"https://my-operation-center.com/config-bundle/casc-bundle-java\"\ntoken: \"\"\n",
        "regex":"folder1/.*",
        "name":"casc-bundle-java",
        "availabilityPatternFromYaml": true,
        "url":"https://my-operation-center.com/config-bundle/casc-bundle-java",
        "token":""
    }
  4. Issue the casc-bundle-list command again. For example:

    java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-list

    The casc-bundle-java bundle is now assigned to folder/controller1 and also available for assignment to folder1/controller2, based on the availability pattern you defined.

    {
        "bundles":[
            {
                "linkFileContent":"url: \"https://my-operation-center.com/config-bundle/casc-bundle-java\"\ntoken: \"\"\n",
                "regex":"folder1/.*",
                "name":"casc-bundle-java",
                "availabilityPatternFromYaml": true,
                "url":"https://my-operation-center.com/config-bundle/casc-bundle-java",
                "token":""
                "usedBy": [
                    "folder1/controller1"
                ],
                "availableFor": [
                    "folder1/controller1",
                    "folder1/controller2"
                ]
            }
        ]
    }
  5. Optionally, specify a default bundle to pre-select a bundle in the controller configuration screen when setting up a new controller. For example, to specify casc-bundle-java as the default bundle, issue the casc-bundle-set-default-bundle command:

    java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-set-default-bundle -b casc-bundle-java

    If successful, the default bundle information is returned:

    {
        "linkFileContent": "url: \"https://my-operation-center.com/config-bundle/casc-bundle-java\"\ntoken: \"\"\n",
        "regex":"folder1/.*",
        "name":"casc-bundle-java",
        "availabilityPatternFromYaml": true,
        "url":"https://my-operation-center.com/config-bundle/casc-bundle-java",
        "token":""
    }
In August 2020, the Jenkins project voted to replace the term master with controller. We have taken a pragmatic approach to cleaning these up, ensuring the least amount of downstream impact as possible. CloudBees is committed to ensuring a culture and environment of inclusiveness and acceptance - this includes ensuring the changes are not just cosmetic ones, but pervasive. As this change happens, please note that the term master has been replaced through the latest versions of the CloudBees documentation with controller (as in managed controller, client controller, team controller) except when still used in the UI or in code.