webMethods Integration Cloud and Cloud Deployment Documentation 6.0.0 | webMethods Cloud Deployment | Switch to Cloud Deployment | Cloud Deployment CLI | Cloud Deployment CLI Reference
 
Cloud Deployment CLI Reference
The following table describes the commands you use to perform various scenarios in the CLI interface.
Commands for viewing alerts in Cloud Deployment
Run the following command to view alerts.
alert list [options]
where the options are:
--Name
Description
--solutionName <solutionName>
Filter the alerts that belong to a particular solution.
--stageName <stageName>
Filter the alerts that belong to a particular stage. Supported values are development, test, live, prelive.
--alertName <alertName>
Filter the alerts by name .
--runtime <runtime>
Filter the alerts by Instances / Node name in a solution.
--severity <severity>
Filter the alerts based on the severity. Default supported values are info, warning, and critical.
--view <view>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
alert list –-severity critical
--view <json>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
alert list –-severity critical –-view json
Note: JSON output format loads complete information that contains additional field than the table output format.
Commands for listing the assets in LAR
Run the following command to list all the assets available in the LAR.
asset-repo list-assets <solutionName> <nodeName> <stageName> [options]
where the options are:
--Name
Description
--view <view>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
asset-repo list-assets DemoSoln IS development
Commands for creating solutions
Run the following command to create solutions.
solution create [options] <stagename>
where the options are:
--Name
Description
--inputFile <fileName>
Provide the name of the file that contains the input data.
solution create --inputFile /home/etc/createSolution.json
<stagename>
The file must contain a valid solution name, the name of the webMethods Integration Server and Universal Messaging instances, number of CPU Cores, and Memory characteristics of the hardware to support each service in the solution.
Example 1 : Creating Type 1 solution without cluster.
{
"integration": {
"landscapeDefinition": {
"solutionName": "Demo",
"description": "Demo Solution",
"solutionType": 1,
"productDefinitions": {
"IS": [{
"name": "IS",
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"version": "10.4",
"env": {
"packages": ["packages.WmCloudStreams
.enabled=true",
"packages.WmJDBCAdapter.enabled=true"]
}
}]
}
}
}
}
Example 2: Creating Type 1 solution with stateful cluster.
{
"integration": {
"landscapeDefinition": {
"solutionName": "Demo",
"description": "Demo Solution",
"solutionType": 1,
"productDefinitions": {
"IS": [{
"name": "IS",
"replicaCount": "2",
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"dependencies": ["DB","tc"],
"clusterType": "stateful",
"isClustered": true,
"statefulCluster": true,
"version": "10.4",
"env": {
"packages": ["packages.WmCloudStreams.
enabled=true", "packages.WmJDBCAdapter.enabled=true"]
}
}],
"TERRACOTTA": [{
"name": "tc",
"isClustered": true,
"statefulCluster": false,
"replicaCount": "2",
"enabled": true,
"resources": {
"limits": {
"cpu": "1",
"memory": "4"
}
},
"version": "10.4",
"env": {
"packages": [],
"monitoringTools": []
}
}]
}
}
}
}
Example 3: Creating Type 1 solution with stateless cluster.
{
"integration": {
"landscapeDefinition": {
"solutionName": "Demo",
"description": "Demo Solution",
"solutionType": 1,
"productDefinitions": {
"IS": [{
"name": "IS",
"replicaCount": "2",
"dependencies": ["DB"],
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"clusterType": "stateless",
"isClustered": true,
"statefulCluster": false,
"version": "10.4",
"env": {
"packages": ["packages.WmCloudStreams.
enabled=true", "packages.WmJDBCAdapter.enabled=true"]
}
}]
}
}
}
}
Example 4: Creating Type 2 solution without cluster.
{
"integration": {
"landscapeDefinition": {
"solutionName": "Solution2",
"description": "sample solution",
"solutionType": 2,
"productDefinitions": {
"IS": [{
"name": "IS",
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"version": "10.4",
"env": {
"packages": ["packages.WmCloudStreams
.enabled=true",
"packages.WmJDBCAdapter.enabled=true"]
}
}],
"UNIVERSALMESSAGING": [{
"name": "UM",
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"version": "10.4"
}]
}
}
}
}
Example 5: Creating Type 2 solution with stateful cluster.
{
"integration": {
"landscapeDefinition": {
"solutionName": "Solution2",
"description": "sample solution",
"solutionType": 2,
"productDefinitions": {
"IS": [{
"name": "IS",
"clusterType": "stateful",
"replicaCount": "2",
"isClustered": true,
"statefulCluster": true,
"dependencies": ["DB", "UM", "tc"],
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"version": "10.4",
"env": {
"packages": ["packages.WmCloudStreams.
enabled=true", "packages.WmJDBCAdapter.enabled=true"]
}
}],
"UNIVERSALMESSAGING": [{
"name": "UM",
"clusterType": null,
"isClustered": false,
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"version": "10.4"
}],
"TERRACOTTA": [{
"name": "tc",
"isClustered": true,
"resources": {
"limits": {
"cpu": "1",
"memory": "4"
}
},
"version": "10.4",
"env": {
"packages": [],
"monitoringTools": []
}
}]
}
}
}
}
Example 6: Creating Type 2 solution with stateless cluster.
{
"integration": {
"landscapeDefinition": {
"solutionName": "Solution2",
"description": "sample solution",
"solutionType": 2,
"productDefinitions": {
"IS": [{
"name": "IS",
"replicaCount": "2",
"clusterType": "stateless",
"dependencies": ["DB","UM"],
"isClustered": true,
"statefulCluster": false,
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"version": "10.4",
"env": {
"packages": ["packages.WmCloudStreams.
enabled=true", "packages.WmJDBCAdapter.enabled=true"]
}
}],
"UNIVERSALMESSAGING": [{
"name": "UM",
"clusterType": null,
"isClustered": false,
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"version": "10.4"
}]
}
}
}
}
Example 7: Creating Type 3 solution without cluster.
{
"integration": {
"landscapeDefinition": {
"solutionName": "Solution3",
"description": "Sample Solution",
"solutionType": 3,
"productDefinitions": {
"IS": [{
"name": "IS1",
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"version": "10.4",
"env": {
"packages": ["packages.WmCloudStreams.
enabled=true", "packages.WmJDBCAdapter.
enabled=true"]
}
}, {
"name": "IS2",
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"version": "10.4",
"env": {
"packages": ["packages.WmCloudStreams.enabled=true",
"packages.WmJDBCAdapter.enabled=true"]
}
}],
"UNIVERSALMESSAGING": [{
"name": "UM",
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"version": "10.4"
}]
}
}
}
}
Example 8: Creating Type 3 solution with stateful cluster.
{
"integration": {
"landscapeDefinition": {
"solutionName": "Solution3",
"description": "Sample Solution",
"solutionType": 3,
"productDefinitions": {
"IS": [{
"name": "IS1",
"isClustered": true,
"replicaCount": "2",
"statefulCluster": true,
"dependencies": ["UM", "DB", "tc1"],
"clusterType": "stateful",
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"version": "10.4",
"env": {
"packages": ["packages.WmCloudStreams.
enabled=true", "packages.WmJDBCAdapter.enabled=true"]
}
}, {
"name": "IS2",
"isClustered": true,
"statefulCluster": true,
"replicaCount": "2",
"dependencies": ["UM", "DB", "tc2"],
"clusterType": "stateful",
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"version": "10.4",
"env": {
"packages": ["packages.WmCloudStreams.
enabled=true", "packages.WmJDBCAdapter.enabled=true"]
}
}],
"UNIVERSALMESSAGING": [{
"name": "UM",
"isClustered": false,
"statefulCluster": false,
"clusterType": null,
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"version": "10.4"
}],
"TERRACOTTA": [{
"name": "tc1",
"isClustered": true,
"resources": {
"limits": {
"cpu": "1",
"memory": "4"
}
},
"version": "10.4",
"env": {
"packages": [],
"monitoringTools": []
}
}, {
"name": "tc2",
"isClustered": true,
"resources": {
"limits": {
"cpu": "1",
"memory": "4"
}
},
"version": "10.4",
"env": {
"packages": [],
"monitoringTools": []
}
}]
}
}
}
}
Example 9: Creating Type 3 solution with stateless cluster.
{
"integration": {
"landscapeDefinition": {
"solutionName": "Solution3",
"description": "Sample Solution",
"solutionType": 3,
"productDefinitions": {
"IS": [{
"name": "IS1",
"isClustered": true,
"replicaCount": "2",
"statefulCluster": false,
"dependencies": ["UM", "DB"],
"clusterType": "stateless",
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"version": "10.4",
"env": {
"packages": ["packages.WmCloudStreams.enabled=true",
"packages.WmJDBCAdapter.enabled=true"]
}
}, {
"name": "IS2",
"isClustered": true,
"statefulCluster": false,
"replicaCount": "2",
"dependencies": ["UM", "DB"],
"clusterType": "stateless",
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"version": "10.4",
"env": {
"packages": ["packages.WmCloudStreams.enabled=true",
"packages.WmJDBCAdapter.enabled=true"]
}
}],
"UNIVERSALMESSAGING": [{
"name": "UM",
"isClustered": false,
"statefulCluster": false,
"clusterType": null,
"resources": {
"limits": {
"cpu": "1",
"memory": "2"
}
},
"version": "10.4"
}]

}
}
}
}
Commands for listing the solutions for a particular stage
Run the following command to list solutions for a particular stage.
solution list <stageName> [options]
where the valid stage name value includes development, test, prelive, and live.
Example:
solution list development --view json
Commands for getting the solution and runtimes for a particular stage
Run the following command to get the solution and all runtimes for a particular stage.
solution get <solutionName> <stageName> [options]
where the options are:
--Name
Description
--view <viewType>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
solution get DemoSoln development
Commands for deleting the solution for a particular stage
Run the following command to delete the solution for a particular stage.
solution delete <solutionName> <stageName> [options]
where the options are:
--Name
Description
--view <viewType>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
solution delete DemoSoln development
Commands for activating or deactivating the solution for a particular stage
Run the following command to activate and deactivate a solution for a particular stage.
solution update-status <solutionName> <stageName> <actionName> [options]
where the options are:
--Name
Description
--view <viewType>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
solution update-stats DemoSoln development deactivate
*Allowed stage names are development, test, live, prelive.
*Allowed action names are activate or deactivate
Commands for getting the status of all pods in a solution
Run the following command to get the status of all pods in a solution.
solution get-status <solutionName> <stageName> [options]
where the options are:
--Name
Description
--view <viewType>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
solution get-status DemoSoln development
Commands for getting the license information for a particular tenant
Run the following command to get the license information for a particular tenant.
tenant get-license-info [options]
where the options are:
--Name
Description
--view <viewType>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
tenant get-license-info
Commands for getting the total CPU and memory utilization details for a particular tenant
Run the following command to get the total CPU and memory utilization details for a particular tenant.
tenant get-utilization-details [options]
where the options are:
--Name
Description
--view <viewType>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
tenant get-license-info
Commands for listing all the users
Run the following command to list all the users.
user list [options]
where the options are:
--Name
Description
--view <viewType>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
tenant get-license-info
Commands to get a particular user
Run the following command to get the user information.
user get <userId> [options]
where the options are:
--Name
Description
--view <viewType>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
user get <ID details>
Commands for promoting Integration Server and Universal Messaging configurations from one stage to another
Run the following command to promote Integration Server and Universal Messaging configurations from one stage to another.
runtime promote-configuration <fromSolutionName> <fromNodeName>
<fromStageName> [toSolutioName] [toNodeName] [options]
Note: If toSolutionName and toNodeName are provided as part of your command, then the CLI performs the cross solution promotion. However, if toSolutionName and toNodeName are not available, then the configuration will be promoted to higher stage on the sameIntegration Server or Universal Messaging node.
where the options are:
--Name
Description
--propFile <fileName>
Properties file to perform variable substitution.
Example: Use the following command for promotion across same instance:
runtime promote-configuration DemoSoln IS development
Example: Use the following command for cross solution promotion:
runtime promote-configuration DemoSoln IS development
DemoSoln1 IS1
Promotes the configuration from the solution DemoSoln IS node to DemoSoln1 and IS1 node.
Commands for promoting Integration Server packages from one stage to another
Run the following command to promote Integration Server packages from one stage to another.
runtime promote-packages <fromSolutionName> <fromNodeName> <fromStageName>
[toSolutioName] [toNodeName] [options]
Note: If toSolutionName and toNodeName are provided then the CLI performs the cross solution promotion. If toSolutionName and toNodeName are not available, then the packages will be promoted to higher stage on the same Integration Server instance.
where the options are:
--Name
Description
--include <comma separated packages names>
Promotes only specified packages.
Example:
--include package1,package2,package3
--exclude <comma separated packages names>
Promotes all the packages other than the packages specified in the options.
Example:
--exclude package1,package2,package3
--propFile <fileName>
Provide properties file to perform variable substitution.
Examples:
Use the following command for promotion across same instance:
runtime promote-packages DemoSoln IS development
-- propFile /home/etc/var_sub.properties
Use the following command for cross solution promotion:
runtime promote-packages DemoSoln IS development
TestSoln IS2
Use the following command to replace a property in a specific composite asset.
<propertyName>/<compositeAssetName>
Note: The replacement properties should be in the following format:
<propertyName>/<compositeAssetName>/<assetName>
Example for replacing properties of a package:
activatePkgOnInstall/TestODataService=false
where TestODataService is the package name whose property activatePkgOnInstall" is assigned with value "false".
Example for replacing properties of a service of a package:
serverName/TestODataService/JDBC_Connection
.ODataService=localhost
where JDBC_Connection.ODataService is a service under package TestODataService, whose parameter serverName is assigned with value localhost
Commands for printing the list of exposed services
Run the following command to print the list of exposed services.
runtime get-exposed-is-serices <solutionName> <nodeName> <stageName> [options]
where the options are:
--Name
Description
-view <viewType>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
runtime get-exposed-is-services DemoSoln IS development
Commands for listing all the queues
Run the following command to list all the queues in the Universal Messaging instance.
um list-queues <solutionName> <nodeName> <stageName> [options]
where the options are:
--Name
Description
-view <viewType>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
um list-queues DemoSoln UM development
Commands for getting the queue information
Run the following command to retrieve pushed, popped, and memory usage of the queue.
um get-queue <solutionName> <nodeName> <stageName> <queueName> [options]
where the options are:
--Name
Description
-view <viewType>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
um get-queue DemoSoln UM development dummyQueue
Commands for getting the queue details
Run the following command to retrieve the queue details.
um get-queue-details <solutionName> <nodeName> <stageName> <queueName> [options]
where the options are:
--Name
Description
-view <viewType>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
um get-queue-details DemoSoln UM development dummyQueue
Commands for listing all the channels in the Universal Messaging instance
Run the following command to list all the channels in a Universal Messaging instance.
um list-channels <solutionName> <nodeName> <stageName> [options]
where the options are:
--Name
Description
-view <viewType>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
um list-channels DemoSoln UM development
Commands for getting the channel information
Run the following command to get the channel information.
um get-channel <solutionName> <nodeName> <stageName> <channelName> [options]
where the options are:
--Name
Description
-view <viewType>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
um get-channel DemoSoln UM development dummyChannel
Commands for getting the channel details
Run the following command to get the channel details.
um get-channel-details <solutionName> <nodeName> <stageName> <channelName>
[options]
where the options are:
--Name
Description
-view <viewType>
By default, outputs the response in a table view mode. The CLI supports both table and JSON output format.
Example:
um get-channel-details DemoSoln UM development dummyChannel
Copyright © 2014- 2019 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.