Runtime Manager Command-Line Interface
Anypoint Platform provides a scripting and command-line tool for Runtime Manager. The command-line interface (CLI) supports both the interactive shell and standard CLI modes and works with:
Locally Deployed Applications Managed by Runtime Manager
| For the Anypoint Platform CLI to recognize your target servers, each server must be manually registered with the platform. |
| Command | Description |
|---|---|
Downloads a standalone application artifact binary |
|
Deploys or redeploys an application to an on-premises server, server group, or cluster |
|
Changes a standalone application artifact |
|
Starts a standalone application |
|
Deletes a standalone application |
|
Shows detailed information for a standalone application |
|
Lists all standalone applications in the environment |
|
Restarts a standalone application |
|
Stops a standalone application |
|
Copies a standalone application |
runtime-mgr:standalone-application:artifact
> runtime-mgr:standalone-application:artifact [flags] <identifier> <directory>
This command downloads the application artifact of the identifier application, to the directory passed in directory.
The identifier flag can be either an application ID or name.
This command accepts only the default flag --help.
runtime-mgr:standalone-application:deploy
> runtime-mgr:standalone-application:deploy [flags] <targetIdentifier> <name> <zipfile>
This command deploys or redeploys the application passed as a ZIP file in the path zipfile to the on-premises target passed in targetIdentifier.
The targetIdentifier flag can be either a target ID or name.
A target can be either a server, server group, or cluster.
This command accepts only the default flag --help.
To redeploy an app and set a logging level or turn on Insight event tracking, see runtime-mgr:standalone-application:modify.
runtime-mgr:standalone-application:modify
> runtime-mgr:standalone-application:modify [flags] <identifier> <zipfile>
This command modifies the standalone (on-premises) application passed in identifier with the ZIP file application passed in zipfile as a path.
The identifier option specifies the application identifier.
To retrieve the identifier, see
runtime-mgr:standalone-application:list.
In addition to the default --help flag, this command also accepts:
| Flag | Description |
|---|---|
|
Stores message metadata of every Mule transaction. |
|
Sets the logging level and scope pair:
To set multiple logging levels, provide multiple |
runtime-mgr:standalone-application:start
> runtime-mgr:standalone-application:start [flags] <identifier>
This command starts the standalone (on-premises) application passed in identifier.
This command accepts only the default flag --help.
runtime-mgr:standalone-application:delete
> runtime-mgr:standalone-application:delete [flags] <identifier>
This command deletes the standalone (on-premises) application passed in identifier.
This command accepts only the default flag --help.
| This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation. |
runtime-mgr:standalone-application:describe
> runtime-mgr:standalone-application:describe [flags] <identifier>
This command shows detailed information, such as status, creation date, and last update, for the standalone (on-premises) application passed in identifier.
Use the flag -o json to get the raw JSON response of the application you specify in <name>.
This command has the --output flag. Use the --output flag to specify the response format. Supported values are table (default) and json
This command also accepts the default flags --help.
runtime-mgr:standalone-application:list
> runtime-mgr:standalone-application:list [flags]
This command lists all standalone (on-premises) applications.
Besides the default --help flag, this command also accepts:
| Flag | Description |
|---|---|
|
Specifies the number of results to retrieve |
|
Offsets the number of applications passed |
|
Specifies the response format. |
runtime-mgr:standalone-application:restart
> runtime-mgr:standalone-application:restart [flags] <identifier>
This command restarts the standalone (on-premises) application passed in identifier.
This command accepts only the default flag --help.
runtime-mgr:standalone-application:stop
> runtime-mgr:standalone-application:stop [flags] <identifier>
This command stops the standalone (on-premises) application passed in identifier.
This command accepts only the default flag --help.
runtime-mgr:standalone-application:copy
> runtime-mgr:standalone-application:copy [flags] <source> <target> <targetIdentifier>
This command copies the standalone (on-premises) application passed in source to the target passed in target and the server, server group or cluster ID or Name passed in targetIdentifier.
Both arguments source and destination are represented using the format: <organizationName>:<environmentName>/<appName>, for example:
> runtime-mgr:standalone-application:copy Services:QA/application-1 Development:QA/application-2 123456
Copies the application named application-1 from the QA environment of the Services organization to the QA environment of the Development organization in the server ID 123456.
If the Anypoint Platform CLI is using the QA environment in the Services organization, the command can simply take the application name as a source:
> runtime-mgr:standalone-application:copy application-1 Development/QA/application-2 123456
Running this command requires for your user to have read/write access to the /tmp directory of the OS where the CLI is installed.
|
This command accepts only the default flag --help.
Alerts for Locally Deployed Applications Managed by Runtime Manager
| Command | Description |
|---|---|
Describes an alert |
|
Creates new alert for standalone runtime |
|
Modifies alert for standalone runtime |
|
Lists all alerts for standalone runtimes in the environment |
runtime-mgr:standalone-alert:describe
> runtime-mgr:standalone-alert:describe [flags] <alertId>
This command describes the alert passed in alertId.
This command has the --output flag. Use the --output flag to specify the response format. Supported values are table (default) and json.
This command also accepts the default flag --help.
runtime-mgr:standalone-alert:create
> runtime-mgr:standalone-alert:create <name> [flags]
This command creates a new alert for a standalone runtime with the ID passed in name.
The alert name is limited to 256 characters.
Besides the default --help flag, this command also accepts:
| Flag | Description |
|---|---|
|
Alert severity |
|
Alert resource type |
|
Alert resource ID. Can be used multiple types. If not provided alert triggers for all resources. Depending on |
|
Alert trigger condition |
|
Condition duration in minutes |
|
Condition threshold number |
|
Condition operator explaining values relation to threshold. |
|
Alert notification email subject |
|
Alert notification email body |
|
Username to send alert notification to. Can be used multiple times to specify up to 20 platform user IDs. |
|
Email address to send alert notification to. Can be used multiple times to specify up to 20 email addresses. |
| This command has multi-option flags. When using multi-option flags in a command, either put the parameter before the flags or use a `-- ` (two dashes followed by a space) before the parameter. |
runtime-mgr:standalone-alert:modify
> runtime-mgr:standalone-alert:modify <alertId> [flags]
This command modifies the alert passed in alertId.
Besides the default --help flag, this command also accepts:
| Flag | Description |
|---|---|
|
Alert name |
|
Alert severity |
|
Alert resource type |
|
Alert resource ID. Can be used multiple types. If not provided alert triggers for all resources. Depending on |
|
Alert trigger condition |
|
Condition duration in minutes |
|
Condition threshold number |
|
Condition operator explaining values relation to threshold. |
|
Alert notification email subject |
|
Alert notification email body |
|
Username to send alert notification to. Can be used multiple times to specify up to 20 platform user IDs. |
|
Email address to send alert notification to. Can be used multiple times to specify up to 20 email addresses. |
| This command has multi-option flags. When using multi-option flags in a command, either put the parameter before the flags or use a `-- ` (two dashes followed by a space) before the parameter. |
runtime-mgr:standalone-alert:list
> runtime-mgr:standalone-alert:list [flags]
This command lists all alerts for standalone Mules in the current environment.
This command has the --output flag. Use the --output flag to specify the response format. Supported values are table (default) and json.
This command also accepts the default flag --help.
Local Servers
| Command | Description |
|---|---|
Describes server |
|
Modifies server |
|
Gets server registration token. This token needs to be used to register a new server |
|
Deletes server |
|
Changes an standalone application artifact |
runtime-mgr:server:describe
> runtime-mgr:server:describe [flags] <serverId>
This command describes the server passed in serverId.
This command has the --output flag. Use the --output flag to specify the response format. Supported values are table (default) and json.
This command accepts only the default flag --help.
runtime-mgr:server:modify
> runtime-mgr:server:modify [flags] <serverId>
This command modifies the server passed in serverId.
In order to update the id for the cluster, you need to pass the --name flag.
Besides the --name flag, this command also has the default --help flag.
runtime-mgr:server:token
> runtime-mgr:server:token [flags]
This command gets server registration token. This token needs to be used to register a new server.
This command accepts only the default flag --help.
Local Server Groups
| Command | Description |
|---|---|
Creates server group from servers |
|
Describes server group |
|
Modifies server group |
|
Adds server to a server group |
|
Deletes server group |
|
Lists all server groups in the environment |
|
Removes server from a server group |
runtime-mgr:serverGroup:create
> runtime-mgr:serverGroup:create [flags] <name> [serverIds...]
This command creates a server group with the name passed in name using the server Id(s) passed as argument(s) thereafter.
This command accepts only the default flag --help.
runtime-mgr:serverGroup:describe
> runtime-mgr:serverGroup:describe [flags] <serverGroupId>
This command describes the server group passed in serverGroupId.
This command has the --output flag. Use the --output flag to specify the response format. Supported values are table (default) and json.
This command also accepts the default flag --help.
runtime-mgr:serverGroup:modify
> runtime-mgr:serverGroup:modify [flags] <serverGroupId>
This command modifies the server group passed in serverGroupId.
In order to update the id for the cluster, you need to pass the --name flag.
Besides the --name flag, this command also has the default --help flag.
runtime-mgr:serverGroup:add:server
> runtime-mgr:serverGroup:add:server [flags] <serverGroupId> <serverId>
This command adds the server passed in serverId to the server group passed in serverGroupId.
This command accepts only the default flag --help.
runtime-mgr:serverGroup:delete
> runtime-mgr:serverGroup:delete [flags] <serverGroupId>
This command deletes the server groups passed in serverGroupId.
This command accepts only the default flag --help.
| This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation. |
runtime-mgr:serverGroup:list
> runtime-mgr:serverGroup:list [flags]
This command lists all server groups in the environment.
This command has the --output flag. Use the --output flag to specify the response format. Supported values are table (default) and json.
This command also accepts the default flag --help.
Local Cluster Servers
| Command | Description |
|---|---|
Adds server to cluster |
|
Deletes cluster |
|
Lists all clusters in the environment |
|
Removes server from a cluster |
|
Creates new cluster |
|
Describes server cluster |
|
Modifies cluster |
runtime-mgr:cluster:add:server
> runtime-mgr:cluster:add:server [flags] <clusterId> <serverId>
This command adds the cluster in clusterId to the server passed in serverId.
This command accepts only the default flag --help.
runtime-mgr:cluster:delete
> runtime-mgr:cluster:delete [flags] <clusterId>
This command deletes the cluster passed in clusterId.
This command accepts only the default flag --help.
| This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation. |
runtime-mgr:cluster:list
> runtime-mgr:cluster:list [flags]
This command lists all clusters in the environment.
This command has the --output flag. Use the --output flag to specify the response format. Supported values are table (default) and json.
This command also accepts the default flag --help.
runtime-mgr:cluster:remove:server
> runtime-mgr:cluster:remove:server [flags] <clusterId> <serverId>
This command removes the server passed in serverId from the cluster passed in clusterId.
This command accepts only the default flag --help.
runtime-mgr:cluster:create
> runtime-mgr:cluster:create <name> [flags]
This command creates a cluster using the id passed in name.
Besides the default --help flag, this command also accepts:
| Flag | Description |
|---|---|
|
Whether cluster should be multicast |
|
Pair of server ID and IP address. Latter is optional for multicast cluster. Provide multiple values to add multiple servers |
| This command has multi-option flags. When using multi-option flags in a command, either put the parameter before the flags or use a `-- ` (two dashes followed by a space) before the parameter. |
runtime-mgr:cluster:describe
> runtime-mgr:cluster:describe [flags] <clusterId>
This command describes the cluster passed in clusterId.
This command has the --output flag. Use the --output flag to specify the response format. Supported values are table (default) and json.
This command also accepts the default flag --help.
CLI for Cloudhub 2.0
You can use CLI commands for deploying and managing applications in Cloudhub 2.0.