IBM DevOps Loop Documentation

https://www.ibm.com/docs/en/devops-loop
Admin
IBM DevOps Loop documentation provides comprehensive guides and API references for managing and...
Tokens:1,154,822
Snippets:13,984
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example: Get Components for JPetStore Application

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getcomponentsinapplication

This example demonstrates how to authenticate and execute the `getComponentsInApplication` command for the 'JPetStore' application.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getComponentsInApplication
  -application JPetStore
```

--------------------------------

### Get Resources Command Example

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=reference-command-format

This example demonstrates how to use the `getResources` command with global parameters for authentication and specifying the web URL.

```bash
udclient -weburl http://localhost:8080 -username admin -password admin getResources
```

--------------------------------

### Start Step Example

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=steps-start

Illustrates a complete example of the 'start' step in a process definition, including multiple 'start' actions and a 'finish' step to signify the end of the process.

```process definition
start is
    start A
    start B
    start C
    finish
end
```

--------------------------------

### Example: Get Component Process

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getcomponentprocess

This example demonstrates how to use the getComponentProcess command with authentication and URL parameters to retrieve details for a specific component process.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getComponentProcess
  -component JPetStore-APP
  -componentProcess "Deploy application component"
```

--------------------------------

### Example: Get Snapshots for an Application

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getsnapshotsinapplication

This example demonstrates how to use the `getSnapshotsInApplication` command with authentication and URL parameters to retrieve snapshots for 'MyApplication'.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getSnapshotsInApplication 
  -application MyApplication
```

--------------------------------

### Example: Using udclient to Get All Teams

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getallteams

This example demonstrates how to use the getAllTeams command with authentication credentials and a web URL. Ensure you replace placeholders with your actual values.

```bash
udclient -username jsmith -password passwd \
  -weburl https://deployserver.example.com:8443
  getAllTeams
```

--------------------------------

### Example: Get Environments for JPetStore Application

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getenvironmentsinapplication

This example demonstrates how to use the `getEnvironmentsInApplication` command with authentication and URL parameters to retrieve environments for the 'JPetStore' application.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getEnvironmentsInApplication
  -application JPetStore
```

--------------------------------

### Example: Get Blueprints in Application

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getblueprintsinapplication

This example demonstrates how to use the getBlueprintsInApplication command with authentication and URL parameters to retrieve blueprints for the 'JPetStore' application.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getBlueprintsInApplication
  -application JPetStore
```

--------------------------------

### Example: Fetching Application Process Requests

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getapplicationsprocessrequests

This example demonstrates how to use the `getApplicationsProcessRequests` command with authentication, a web URL, and parameters to filter requests submitted after a specific timestamp and to start from a specific index.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getApplicationsProcessRequests
  -startedAfter 1471603999000
  startIndex 200
```

--------------------------------

### Example: Get Snapshot Versions with Application

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getsnapshotversions

This example demonstrates how to use the getSnapshotVersions command with both application and snapshot names. Ensure you provide valid credentials and the web URL for your deployment server.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getSnapshotVersions 
  -application JPetStore 
  -snapshot mySnapshot
```

--------------------------------

### Example: Create Application via Command Line

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-createapplication

This example shows how to execute the createApplication command with necessary authentication and server details, pointing to a JSON file for application configuration.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  createApplication newApplication.json
```

--------------------------------

### Example: Logging in with Credentials

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-login

This example demonstrates how to log in to the server using username, password, and web URL. The generated token is stored locally.

```bash
udclient -username admin -password admin 
  -weburl https://myserver.example.com:8443
  login
```

--------------------------------

### Install and start the RMAgent Windows service

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=rma-starting-resource-monitoring-java-agent-as-service-windows

These commands are used to install the resource monitoring agent as a Windows service and then start it. Ensure you have administrator privileges and are in the correct directory.

```cmd
RMAgent-winservice install
```

```cmd
RMAgent-winservice start
```

--------------------------------

### GET Request to retrieve installed plug-ins

Source: https://www.ibm.com/docs/en/devops-loop/2.0.1?topic=resource-get-installed-plug-ins

Use this request to get a list of all currently installed plug-ins. Ensure the Accept header is set to either application/json or application/yaml.

```http
GET https://{hostname}:{port}
    /cli/plugin/installed
Accept: {contentType}
```

--------------------------------

### Example: List Resources with a Specific Component Version

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getresourceswithcomponentversion

Use this command to retrieve all resources that have a specific component and version installed. Ensure you provide valid global arguments and the required component and version parameters.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getResourcesWithComponentVersion
  -component "JPetStore-APP"
  -version "1.0"
```

--------------------------------

### Install Agent Command Example

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-installagent

An example of how to use the installAgent command with specific parameters.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  installAgent
  -name NewAgent
  -host agenthost.example.com
  -port 22
  -sshUsername root
  -sshPassword 12345
  -installDir /opt/devops-deploy/agent
  -javaHomePath /usr/lib/java
  -tempDirPath /tmp
  -serverHost host.example.com
  -serverPort 7918
```

--------------------------------

### Get Environment Command Example

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getenvironment

Example of how to use the getEnvironment command with specific parameters to retrieve environment details.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getEnvironment 
  -application JPetStore 
  -environment "Tutorial environment 1"
```

--------------------------------

### Plugin Step Examples

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=steps-plugin

Illustrates two distinct 'plugin' step configurations: 'A' with multiple properties and 'B' with a working directory and precondition script.

```yaml
start is
    start A
    start B
end

plugin step A is
    plugin plugin-value
    command command-value
    property prop1 = prop1-value
    property prop2 = prop2-value
    property prop3 = prop3-value
on success
    finish
end

plugin step B is
    plugin plugin-value
    command command-value
    working-directory "/working/directory"
    precondition-script "true"
on success
    finish
end
```

--------------------------------

### Example Response for Get Components

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getcomponents

This is an example of the JSON output returned by the getComponents command, detailing properties of each component.

```json
[
  {
    "id": "69a6a5bd-583b-4b40-bd47-54b28f5aa1e6",
    "name": "JPetStore-APP",
    "description": "",
    "created": 1387315824908,
    "importAutomatically": false,
    "useVfs": true,
    "active": true,
    "deleted": false,
    "defaultVersionType": "FULL",
    "cleanupDaysToKeep": 0,
    "cleanupCountToKeep": 0,
    "tags": [
      {
        "id": "d140ae5a-dfb0-477a-910b-762cc0d99cc6",
        "name": "Tag2",
        "color": "#7fff00",
        "description": "",
        "objectType": "Component"
      }
    ],
    "user": "admin"
  },
  {
    "id": "f4a37f52-7d96-4fb5-b43b-57166b177e7c",
    "name": "JPetStore-DB",
    "description": "",
    "created": 1387316389625,
    "importAutomatically": false,
    "useVfs": true,
    "active": true,
    "deleted": false,
    "defaultVersionType": "FULL",
    "cleanupDaysToKeep": 0,
    "cleanupCountToKeep": 0,
    "tags": [
    ],
    "user": "admin"
  },
  {
    "id": "76299d8e-c328-42f4-99ab-aa7bfee7aa14",
    "name": "JPetStore-WEB",
    "description": "",
    "created": 1387316469977,
    "importAutomatically": false,
    "useVfs": true,
    "active": true,
    "deleted": false,
    "defaultVersionType": "FULL",
    "cleanupDaysToKeep": 0,
    "cleanupCountToKeep": 0,
    "tags": [
    ],
    "user": "admin"
  }
]
```

--------------------------------

### Example: Get Environment Base Resources with Application and Environment

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getenvironmentbaseresources

Use this command to list base resources for a specific environment and application. Ensure you provide valid credentials and the web URL.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getEnvironmentBaseResources 
  -application JPetStore 
  -environment "Tutorial environment 1"
```

--------------------------------

### Start z/OS Agent Manually

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=administering-starting-agents-zos

Use this command to start the agent process in the background from the agent's installation directory.

```bash
bin/agent start
```

--------------------------------

### Example Response for Get Environment

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getenvironment

This is an example of the JSON response returned by the getEnvironment command, detailing the environment's properties.

```json
{
  "id": "1f97af86-cde3-4ba2-803b-0e4580dcc05b",
  "name": "Tutorial environment 1",
  "description": "",
  "color": "#ffffff",
  "requireApprovals": false,
  "lockSnapshots": false,
  "calendarId": "e237199e-8bbc-497e-97eb-ca2568dff91c",
  "active": true,
  "cleanupDaysToKeep": 0,
  "cleanupCountToKeep": 0,
  "conditions": [
  ],
  "compliancy": {
    "missingCount": 0,
    "correctCount": 3,
    "desiredCount": 3
  },
  "systemCleanupDaysToKeep": -1,
  "systemCleanupCountToKeep": -1,
  "exemptProcesses": "",
  "extendedSecurity": {
    "read": true,
    "write": true,
    "execute": true,
    "Create Environments": true,
    "Edit Environments": true,
    "Execute on Environments": true,
    "View Environments": true,
    "teams": [
      {
        "teamId": "ea307e2e-d6be-4092-a7e8-e8e02274de7e",
        "teamLabel": "My team"
      }
    ]
  }
}
```

--------------------------------

### Example: Creating a Snapshot

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-createsnapshotofenvironment

This example demonstrates how to create a snapshot of an environment, specifying the environment name, application name, and a name for the new snapshot. Ensure you replace placeholder credentials and URLs with your actual values.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  createSnapshotOfEnvironment 
  -environment newEnvironment 
  -application JPetStore 
  -name NewSnapshot
```

--------------------------------

### Get Installed Plug-ins

Source: https://www.ibm.com/docs/en/devops-loop/2.0.1?topic=resource-get-installed-plug-ins

Retrieves a list of all currently installed plug-ins. This is useful for understanding the current state of your system's plug-ins.

```APIDOC
## GET /cli/plugin/installed

### Description
Get a list of all currently installed plugins.

### Method
GET

### Endpoint
`https://{hostname}:{port}/cli/plugin/installed`

### Parameters
#### Header Parameters
- **Accept** (string) - Required - Specifies the desired content type for the response. Accepted values are `application/json` and `application/yaml`.

### Request Example
```http
GET https://{hostname}:{port}/cli/plugin/installed
Accept: application/json
```

### Response
#### Success Response (200)
- **installedPlugins** (array) - A list of installed plug-ins.
  - **name** (string) - The name of the plug-in.
  - **version** (string) - The version of the plug-in.

### Response Example
```json
{
  "installedPlugins": [
    {
      "name": "plugin-a",
      "version": "1.0.0"
    },
    {
      "name": "plugin-b",
      "version": "2.1.0"
    }
  ]
}
```
```

--------------------------------

### Example Usage of getApplications

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getapplications

Demonstrates how to execute the `getApplications` command with authentication and server URL parameters.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getApplications
```

--------------------------------

### Get Installed Plugins Command Format

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getinstalledplugins

Use this command format to retrieve a list of all currently installed plugins. No parameters are required.

```bash
udclient [global-args...] [global-flags...]
  getInstalledPlugins
```

--------------------------------

### Example: Create a Version Status

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-createstatus

This example demonstrates how to create a new 'version' status named 'Documented' with a specific color. The command requires authentication details and the web service URL.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  createStatus
  -type version
  -status Documented
  -color "#0077FF"
```

--------------------------------

### Example URL with Default Parameters

Source: https://www.ibm.com/docs/en/devops-loop/2.0.1?topic=reference-deployment-pre-selected-parameters

This example demonstrates a complete URL with default values for common deployment parameters. It can be used to directly access the deployment request page with pre-populated fields.

```URL
https://localhost:8443/?applicationId=abcd&environmentId=helloDeploy&versionIds=78e87602-cd9f-4937-8828-02eea631a615&description=Description updated from API&onlyChanged=true
```

--------------------------------

### Example Response for Get Tags on Agent

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-gettagsonagent

This is an example of the JSON response returned by the getTagsOnAgent command, listing the tags associated with an agent.

```json
[
  {
    "id": "34afc9d1-e6d7-420f-a40c-30e6d3bf0c34",
    "name": "Tag1",
    "color": "#FFFFFF",
    "description": "",
    "objectType": "Agent"
  },
  {
    "id": "74c02e58-e532-47d7-ba98-66d1ac20c361",
    "name": "Tag2",
    "color": "#7fff00",
    "description": "",
    "objectType": "Agent"
  }
]
```

--------------------------------

### Get Status List Command Example

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getstatuslist

An example of how to use the getStatusList command with authentication and URL parameters, specifying both application and snapshot.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getStatusList
  -application MyApplication
  -snapshot MySnapshot
```

--------------------------------

### Example: Add a Base Resource to an Environment

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-addenvironmentbaseresource

This example demonstrates how to add a base resource to an application environment using the udclient command. It includes authentication details, the web URL, and the necessary parameters for the environment, application, and resource.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  addEnvironmentBaseResource
  -application MyApplication
  -environment Environment1
  -resource /agents/agent1
```

--------------------------------

### Example Response for Get Component Properties

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getcomponentproperties

This is an example of the JSON response returned by the getComponentProperties command, showing a list of properties with their details.

```json
[
  {
    "id": "3702f391-09e1-4550-903a-d5ae286c94aa",
    "name": "Prop1",
    "value": "value1",
    "description": "",
    "secure": false
  }
]
```

--------------------------------

### getUser Command Example

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getuser

Demonstrates how to use the getUser command with authentication and URL parameters.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getUser 
  -user jsmith
```

--------------------------------

### Example: Get Tags on Agent

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-gettagsonagent

This example demonstrates how to use the getTagsOnAgent command with authentication and URL parameters, specifying the agent for which to retrieve tags.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getTagsOnAgent
  -agent Agent1
```

--------------------------------

### Example: Download Component Version Artifacts

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-downloadversionartifacts

This example demonstrates how to download all artifacts for the 'JPetStore-WEB' component, version '1.0', to the current directory. Ensure you provide valid credentials and web URL.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  downloadVersionArtifacts
  -component JPetStore-WEB
  -version 1.0
  -location .
```

--------------------------------

### Example: Get Component Properties

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getcomponentproperties

This example demonstrates how to use the getComponentProperties command with authentication and URL parameters to retrieve properties for the JPetStore-APP component.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getComponentProperties
  -component JPetStore-APP
```

--------------------------------

### Example: Add Application to Team

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-addapplicationtoteam

This example demonstrates how to add the 'JPetStore' application to the 'MyTeam' team using the udclient command. Ensure you provide valid credentials and the server URL.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  addApplicationToTeam
  -application JPetStore
  -team MyTeam
```

--------------------------------

### Run IBM DevOps Loop Installation Script

Source: https://www.ibm.com/docs/en/devops-loop/1.0.3?topic=loop-installing-devops-rhel-system-demo-setup

Execute the IBM-devops-Install.sh script to start the installation of DevOps Loop after configuring necessary values in the script.

```bash
./IBM-devops-Install.sh
```

--------------------------------

### Example: Retrieve tomcat.start property

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getenvironmentproperty

This example demonstrates how to use the getEnvironmentProperty command to retrieve the value of the 'tomcat.start' property for a specific application and environment. Ensure you replace placeholders with your actual credentials and URLs.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getEnvironmentProperty 
  -application JPetStore 
  -environment "Tutorial environment 1" 
  -name tomcat.start
```

--------------------------------

### Example Request with Multiple Resources

Source: https://www.ibm.com/docs/en/devops-loop/2.0.1?topic=resource-executes-new-generic-process-requests-resources

This example shows how to execute a process against multiple resources simultaneously.

```JSON
{
    "processId" : "1710e0b0-eb7e-e9b7-38ab-c7be3e828f56",
    "resources" : [
        "1710e095-edff-9d34-831e-33ed5da7a078", 
        "170208fb-7464-4133-44c2-0587986fe1b6"
    ]
}
```

--------------------------------

### Example: Create User Command Execution

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-createuser

This example demonstrates how to execute the createUser command with specific global arguments and the path to the JSON file.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  createUser 
  newUser.json
```

--------------------------------

### Example Response for Get Applications Process Requests

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getapplicationsprocessrequests

This is an example of the JSON response returned by the `getApplicationsProcessRequests` command, showing details of application process requests.

```json
[
  {
    "application": {
      "id": "962d3544-c028-4d44-8d0d-52311043e83d",
      "securityResourceId": "9543d94f-d9b9-4a34-a43a-f4d7d69b9987",
      "name": "MyApplication",
      "description": "",
      "created": 1471534973567,
      "enforceCompleteSnapshots": false,
      "active": true,
      "tags": [],
      "deleted": false,
      "user": "admin"
    },
    "applicationProcess": {
      "id": "4a38f91e-41bb-49c0-8010-d406d65fa7ba",
      "name": "deploy",
      "description": "",
      "active": true,
      "inventoryManagementType": "AUTOMATIC",
      "offlineAgentHandling": "PRE_EXECUTION_CHECK",
      "versionCount": 2,
      "version": 2,
      "commit": 17,
      "path": "applications/962d3544-c028-4d44-8d0d-52311043e83d/processes/4a38f91e-41bb-49c0-8010-d406d65fa7ba",
      "deleted": false,
      "metadataType": "applicationProcess"
    },
    "environment": {
      "id": "8ecf9ba2-4f7a-4326-a4bd-309a0366b2a2",
      "securityResourceId": "fdab7788-519a-4118-87a7-d1e4f0f391c9",
      "name": "local",
      "description": "",
      "color": "#00B2EF",
      "requireApprovals": false,
      "noSelfApprovals": false,
      "lockSnapshots": false,
      "calendarId": "27c132c9-b805-4ece-b6f9-265a1b355c21",
      "active": true,
      "deleted": false,
      "cleanupDaysToKeep": 0,
      "cleanupCountToKeep": 0,
      "enableProcessHistoryCleanup": false,
      "useSystemDefaultDays": true,
      "historyCleanupDaysToKeep": 365,
      "conditions": []
    },
    "id": "3bc33fb8-98a6-4a24-a97b-d6e4b4b541a3",
    "submittedTime": 1471535097984,
    "traceId": "46749e41-d571-4b3c-a3b2-6fd0b6f23858",
    "userName": "admin",
    "onlyChanged": true,
    "description": "",
    "startTime": 1471535098738,
    "result": "SUCCEEDED",
    "state": "CLOSED",
    "paused": false,
    "endTime": 1471535099134,
    "duration": 396
  },
  {
    "application": {
      "id": "8ba25265-f313-4246-aa8a-4f8a9617ed2b",
      "securityResourceId": "10935be7-678d-4dc6-bbd1-57644d619041",
      "name": "MyApplication2",
      "description": "",
      "created": 1471535176734,
      "enforceCompleteSnapshots": false,
      "active": true,
      "tags": [],
      "deleted": false,
      "user": "admin"
    },
    "applicationProcess": {
      "id": "4d4d727c-a92e-45f0-8901-1277e92c09f4",
      "name": "deploy",
      "description": "",
      "active": true,
      "inventoryManagementType": "AUTOMATIC",
      "offlineAgentHandling": "PRE_EXECUTION_CHECK",
      "versionCount": 2,
      "version": 2,
      "commit": 20,
      "path": "applications/8ba25265-f313-4246-aa8a-4f8a9617ed2b/processes/4d4d727c-a92e-45f0-8901-1277e92c09f4",
      "deleted": false,
      "metadataType": "applicationProcess"
    },
    "environment": {
      "id": "03eae7bf-f97f-4e2d-81b5-8780ee1d5277",
      "securityResourceId": "43fa87b2-1751-44d8-9abe-e788d7990608",
      "name": "local",
      "description": "",
      "color": "#00B2EF",
      "requireApprovals": false,
      "noSelfApprovals": false,
      "lockSnapshots": false,
      "calendarId": "79fc6057-f0a6-42a1-be0f-939ac76dbd50",
      "active": true,
      "deleted": false,
      "cleanupDaysToKeep": 0,
      "cleanupCountToKeep": 0,
      "enableProcessHistoryCleanup": false,
      "useSystemDefaultDays": true,
      "historyCleanupDaysToKeep": 365,
      "conditions": []
    },
    "id": "0596ac0b-36c0-449a-a11b-a5aa0cccb98b",
    "submittedTime": 1471535228001,
    "traceId": "e10524ee-e43c-44ea-9a5b-610d6dcbf2e8",
    "userName": "admin",
    "onlyChanged": true,
    "description": "",
    "startTime": 1471535228400,
    "result": "SUCCEEDED",
    "state": "CLOSED",
    "paused": false,
    "endTime": 1471535228502,
    "duration": 102
  }
]
```

--------------------------------

### GetComponentVersions Command Example

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getcomponentversions

An example of how to execute the getComponentVersions command with authentication and component details.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getComponentVersions
  -component MyComponent
```

--------------------------------

### Example: Get Application Details

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getapplication

Use this command to retrieve details for the 'JPetStore' application. Ensure you provide valid username, password, and web URL.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getApplication 
  -application JPetStore
```

--------------------------------

### Get Available Plug-ins

Source: https://www.ibm.com/docs/en/devops-loop/2.0.1?topic=resource-get-available-plug-ins

Retrieves a list of all available plug-ins for installation.

```APIDOC
## GET /cli/plugin/available

### Description
Get a list of all available plugins for installing into the server.

### Method
GET

### Endpoint
`https://{hostname}:{port}/cli/plugin/available`

### Parameters
#### Header Parameters
- **Accept** (string) - Required - Specifies the desired content type for the response. Accepted values are `application/json` and `application/yaml`.
```

--------------------------------

### Example of release-lock step

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=steps-release-lock

This example demonstrates how to use the release-lock step to release a lock named 'lock-name'. It includes starting a process and then releasing the lock on success.

```yaml
start is
    start "A"
end

release-lock step "A" is
    lock "lock-name"
on success
    finish
end
```

--------------------------------

### Example Usage of getApplicationProcess

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getapplicationprocess

This example demonstrates how to use the `getApplicationProcess` command with authentication and URL parameters, specifying the application and application process names.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getApplicationProcess
  -application JPetStore
  -applicationProcess "Deploy JPetStore"
```

--------------------------------

### Example: Get Tags on Component

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-gettagsoncomponent

This example demonstrates how to use the getTagsOnComponent command with authentication and target server details. The '-component' parameter specifies the target component.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getTagsOnComponent
  -component JPetStore-APP
```

--------------------------------

### Example: Get Application Process Request Properties

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getapplicationprocessrequestproperties

This example demonstrates how to call the getApplicationProcessRequestProperties command with authentication and web URL parameters. The requestID is a required parameter.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getApplicationProcessRequest
  -requestID 134t52le97-3f75-6783-333f-3b54d48c8d88
```

--------------------------------

### cURL Example for Getting Application Properties

Source: https://www.ibm.com/docs/en/devops-loop/2.0.1?topic=resource-get-all-application-properties-their-values

This cURL command demonstrates how to call the GET /cli/application/getProperties endpoint. It includes basic authentication and specifies the application name.

```curl
curl -k -u jsmith:passwd 
  "https://deployserver.example.com:8443/cli/application/getProperties
  ?application=JPetStore"
```

--------------------------------

### Example of Adding a Version Link

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-addversionlink

This example demonstrates how to add a link named 'Link to IBM web site' pointing to 'http://www.ibm.com' for the '1.0' version of the 'JPetStore-APP' component. It includes necessary global arguments for authentication and server URL.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  addVersionLink 
  -component JPetStore-APP 
  -version 1.0 
  -linkName "Link to IBM web site" 
  -link http://www.ibm.com
```

--------------------------------

### getSystemProperty Command Example

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=commands-getsystemproperty

An example of how to execute the getSystemProperty command with authentication and URL details, specifying the property name.

```bash
udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  getSystemProperty
  -name property1
```

--------------------------------

### Example HTTP virtual service endpoint on Ubuntu

Source: https://www.ibm.com/docs/en/devops-loop/2.0.2?topic=mvs-running-http-virtual-services-in-kubernetes-cluster-without-using-proxies

An example of a virtual service endpoint on Ubuntu with a specific ingress domain. The 'in-' prefix is standard for Ubuntu installations.

```text
in-cd3a755635574c6fa7e264911301821a.10.1.2.3.nip.io
```
Tokens:
Raw