The CasC bundle management on the operations center CLI commands allow users to view the availability patterns and tokens for all CasC bundles on the operations center. They also allow users to assign a bundle to a controller and regenerate tokens.
Commands
| Command | Description | Parameters | Supported versions | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Lists all available CasC bundles on the operations center. | None. | 2.249.2.3 and later | ||||||
| Regenerates the token and returns the new bundle information when successful. |
| 2.249.2.3 and later
| ||||||
| Specifies the availability pattern to define the path to controllers that can use the bundle. |
| 2.289.1.2 and later | ||||||
| Specifies the default global availability pattern behavior. |
| 2.289.2.2 and later | ||||||
| Assigns a bundle to a controller and returns the bundle information when successful.
|
| 2.289.2.2 and later | ||||||
| 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.
|
| 2.289.2.2 and later | ||||||
| Assigns a bundle to a controller and returns the bundle information when successful.
|
| 2.249.2.3 - 2.289.2.2
|
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. |
| Command | Command example |
|---|---|
| |
| |
| |
| |
| |
| |
| |
Response examples
| Response examples are formatted for better readability. |
{
"bundles":[
{
"linkFileContent":"url: \"https://my-operation-center.com/config-bundle/casc-bundle-java\"\ntoken: \"\"\n",
"regex":"folder1/.*",
"name":"casc-bundle-java",
"url":"https://my-operation-center.com/config-bundle/casc-bundle-java",
"token":""
"usedBy": [
"folder1/controller1"
],
"availableFor": [
"folder1/controller1",
"folder1/controller2"
]
}
]
}{
"linkFileContent":"url: \"https://my-operation-center.com/config-bundle/casc-bundle-java\"\ntoken: \"\"\n",
"regex":"folder1/.*",
"name":"casc-bundle-java",
"url":"https://my-operation-center.com/config-bundle/casc-bundle-java",
"token":""
}"folder1/.*"true{
"linkFileContent": "url: \"https://my-operation-center.com/config-bundle/casc-bundle-java\"\ntoken: \"\"\n",
"regex":"folder1/.*",
"name":"casc-bundle-java",
"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",
"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",
"url":"https://my-operation-center.com/config-bundle/casc-bundle-java",
"token":""
}Response model
| Element | Type | Description |
|---|---|---|
bundles | array of objects | List of 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. |
regex | string | The regex attribute is 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, |
name | string | The name is the name of the folder that contains the CasC bundle. For example, |
url | string | The url is the bundle URL where the operations center exposes its content. |
token | string | The token is the access token for the bundle. |
usedBy | string | The names of controllers assigned to the bundle. |
availableFor | array of objects | Controllers that can be assigned to the bundle based on the availability pattern. |
Status and exit codes
| Code | Description |
|---|---|
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.
-
Issue the
casc-bundle-listcommand 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-listIn 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", "url":"https://my-operation-center.com/config-bundle/casc-bundle-java", "token": "", "usedBy": [], "availableFor": [] } ] } -
Define the availability pattern for the bundle. You have two options:
-
Option 1: Issue the
casc-bundle-set-availability-patterncommand 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-behaviorcommand 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 trueIf successful, the default global availability pattern behavior is returned:
true
-
-
Issue the
casc-bundle-set-controllercommand 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/controller1If 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", "url":"https://my-operation-center.com/config-bundle/casc-bundle-java", "token":"" } -
Issue the
casc-bundle-listcommand again. For example:java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-listThe
casc-bundle-javabundle is now assigned tofolder/controller1and also available for assignment tofolder1/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", "url":"https://my-operation-center.com/config-bundle/casc-bundle-java", "token":"" "usedBy": [ "folder1/controller1" ], "availableFor": [ "folder1/controller1", "folder1/controller2" ] } ] } -
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-javaas the default bundle, issue thecasc-bundle-set-default-bundlecommand:java -jar jenkins-cli.jar -auth admin:rG57xFa2eFrCeWjG4NKU5QMJeW9TzfSkym -s https://my-operation-center.com/ -webSocket casc-bundle-set-default-bundle -b casc-bundle-javaIf 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", "url":"https://my-operation-center.com/config-bundle/casc-bundle-java", "token":"" }