+
+

Runtime Manager Command-Line Interface

logo cloud disabled logo hybrid active logo server active logo rtf active

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

Shows a raw standalone application JSON response

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 [options] <identifier> <directory>

This command downloads the application artifact of the identifier application, to the directory passed in directory. The identifier parameter can be either an application ID or name.

This command accepts only the default options: --help, -f/--fields and -o/--output.

runtime-mgr standalone-application deploy

> runtime-mgr standalone-application deploy [options] <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 parameter 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 options: --help, -f/--fields and -o/--output.

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 describe-json

> runtime-mgr standalone-application describe-json [options] <identifier>

This command describes the standalone (on-premises) application passed in identifier as a raw JSON response.

This command accepts only the default options: --help, -f/--fields and -o/--output.

runtime-mgr standalone-application modify

> runtime-mgr standalone-application modify [options] <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 parameter specifies the application identifier. To retrieve the identifier, see runtime-mgr standalone-application list.

In addition to the default --help, -f/--fields and -o/--output options, this command also takes:

Value Description

--insight

Stores message metadata of every Mule transaction.

--log [level:scope]

Sets the logging level and scope pair:

  • level: TRACE, DEBUG, INFO, WARN, ERROR, FATAL, or OFF

  • scope: package name of the class, connector, or module to log, such as org.mule.extension.ftp for Anypoint Connector for FTP

To set multiple logging levels, provide multiple --log options, for example, --log INFO:org.apache --log WARN:org.mule.

runtime-mgr standalone-application start

> runtime-mgr standalone-application start [options] <identifier>

This command starts the standalone (on-premises) application passed in identifier.

This command accepts only the default options: --help, -f/--fields and -o/--output.

runtime-mgr standalone-application delete

> runtime-mgr standalone-application delete [options] <identifier>

This command deletes the standalone (on-premises) application passed in identifier.

This command accepts only the default options: --help, -f/--fields and -o/--output.

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 [options] <identifier>

This command shows detailed information, such as status, creation date, and last update, for the standalone (on-premises) application passed in identifier.

This command accepts only the default options: --help, -f/--fields and -o/--output.

runtime-mgr standalone-application list

> runtime-mgr standalone-application list [options]

This command lists all standalone (on-premises) applications.

Besides the default --help, -f/--fields and -o/--output options, this command also takes:

Value Description

--limit <num>

Specifies the number of results to retrieve

--offset <num>

Offsets the number of applications passed

runtime-mgr standalone-application restart

> runtime-mgr standalone-application restart [options] <identifier>

This command restarts the standalone (on-premises) application passed in identifier.

This command accepts only the default options: --help, -f/--fields and -o/--output.

runtime-mgr standalone-application stop

> runtime-mgr standalone-application stop [options] <identifier>

This command stops the standalone (on-premises) application passed in identifier.

This command accepts only the default options: --help, -f/--fields and -o/--output.

runtime-mgr standalone-application copy

> runtime-mgr standalone-application copy [options] <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 options: --help, -f/--fields and -o/--output.

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 [options] <alertId>

This command describes the alert passed in alertId.

This command accepts only the default options: --help, -f/--fields and -o/--output.

runtime-mgr standalone-alert create

> runtime-mgr standalone-alert create [options] <name>

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, -f/--fields and -o/--output options, this command also takes:

Value Description

--severity <val>

Alert severity

--resourceType <type>

Alert resource type

--resource [id]

Alert resource ID. Can be used multiple types. If not provided alert triggers for all resources. Depending on resourceType resource can be application, server, server-group or cluster.

--condition <val>

Alert trigger condition

--period [minutes]

Condition duration in minutes

--threshold [num]

Condition threshold number

--operator [type]

Condition operator explaining values relation to threshold.

--subject <string>

Alert notification email subject

--content <string>

Alert notification email body

--recipient [username]

Username to send alert notification to. Can be used multiple times to specify up to 20 platform user IDs.

--email [emailAddress]

Email address to send alert notification to. Can be used multiple times to specify up to 20 email addresses.

runtime-mgr standalone-alert modify

> runtime-mgr standalone-alert modify [options] <alertId>

This command modifies the alert passed in alertId.

Besides the default --help, -f/--fields and -o/--output options, this command also takes:

Value Description

--name <value>

Alert name

--severity <value>

Alert severity

--resourceType <type>

Alert resource type

--resource [id]

Alert resource ID. Can be used multiple types. If not provided alert triggers for all resources. Depending on resourceType resource can be application, server, server-group or cluster.

--condition <value>

Alert trigger condition

--period [minutes]

Condition duration in minutes

--threshold [num]

Condition threshold number

--operator [type]

Condition operator explaining values relation to threshold.

--subject <string>

Alert notification email subject

--content <string>

Alert notification email body

--recipient [username]

Username to send alert notification to. Can be used multiple times to specify up to 20 platform user IDs.

--email [emailAddress]

Email address to send alert notification to. Can be used multiple times to specify up to 20 email addresses.

runtime-mgr standalone-alert list

> runtime-mgr standalone-alert list [options]

This command lists all alerts for standalone Mules in the current environment.

This command accepts only the default options: --help, -f/--fields and -o/--output.

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 [options] <serverId>

This command describes the server passed in serverId.

This command accepts only the default options: --help, -f/--fields and -o/--output.

runtime-mgr server modify

> runtime-mgr server modify [options] <serverId>

This command modifies the server passed in serverId.

In order to update the id for the cluster, you need to pass the --name option.

Besides the --name option, this command also takes the default --help, -f/--fields and -o/--output options.

runtime-mgr server token

> runtime-mgr server token [options]

This command gets server registration token. This token needs to be used to register a new server.

This command accepts only the default options: --help, -f/--fields and -o/--output.

runtime-mgr server delete

> runtime-mgr server delete [options] <serverId>

This command deletes the server passed in serverId.

This command accepts only the default options: --help, -f/--fields and -o/--output.

This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation.

runtime-mgr server list

> runtime-mgr server list [options]

This server lists all servers in your environment.

This command accepts only the default options: --help, -f/--fields and -o/--output.

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 [options] <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 options: --help, -f/--fields and -o/--output.

runtime-mgr serverGroup describe

> runtime-mgr serverGroup describe [options] <serverGroupId>

This command describes the server group passed in serverGroupId.

This command accepts only the default options: --help, -f/--fields and -o/--output.

runtime-mgr serverGroup modify

> runtime-mgr serverGroup modify [options] <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 option.

Besides the --name option, this command also takes the default --help, -f/--fields and -o/--output options.

runtime-mgr serverGroup add server

> runtime-mgr serverGroup add server [options] <serverGroupId> <serverId>

This command adds the server passed in serverId to the server group passed in serverGroupId.

This command accepts only the default options: --help, -f/--fields and -o/--output.

runtime-mgr serverGroup delete

> runtime-mgr serverGroup delete [options] <serverGroupId>

This command deletes the server groups passed in serverGroupId.

This command accepts only the default options: --help, -f/--fields and -o/--output.

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 [options]

This command lists all server groups in the environment.

This command accepts only the default options: --help, -f/--fields and -o/--output.

runtime-mgr serverGroup remove server

> runtime-mgr serverGroup remove server [options] <serverGroupId> <serverId>

This command removes the server passed in serverId from the server group passed in serverGroupId.

This command accepts only the default options: --help, -f/--fields and -o/--output.

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 [options] <clusterId> <serverId>

This command adds the cluster in clusterId to the server passed in serverId.

This command accepts only the default options: --help, -f/--fields and -o/--output.

runtime-mgr cluster delete

> runtime-mgr cluster delete [options] <clusterId>

This command deletes the cluster passed in clusterId.

This command accepts only the default options: --help, -f/--fields and -o/--output.

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 [options]

This command lists all clusters in the environment.

This command accepts only the default options: --help, -f/--fields and -o/--output.

runtime-mgr cluster remove server

> runtime-mgr cluster remove server [options] <clusterId> <serverId>

This command removes the server passed in serverId from the cluster passed in clusterId.

This command accepts only the default options: --help, -f/--fields and -o/--output.

runtime-mgr cluster create

> runtime-mgr cluster create [options] <name>

This command creates a cluster using the id passed in name.

Besides the default --help, -f/--fields and -o/--output options, this command also takes:

Value Description

--multicast

Whether cluster should be multicast

--server <id:ip>

Pair of server ID and IP address. Latter is optional for multicast cluster. Provide multiple values to add multiple servers

runtime-mgr cluster describe

> runtime-mgr cluster describe [options] <clusterId>

This command describes the cluster passed in clusterId.

This command accepts only the default options: --help, -f/--fields and -o/--output.

runtime-mgr cluster modify

> runtime-mgr cluster modify [options] <clusterId>

This command modifies the cluster passed in clusterId.
In order to update the id for the cluster, you need to pass the --name option.

Besides the --name option, this command also takes the default --help, -f/--fields and -o/--output options.

Runtime Fabric Instances

Command Description

Lists available Runtime Fabric instances

runtime-mgr rtf list

> runtime-mgr rtf list [options]

This command lists available Runtime Fabric instances.

This command accepts only the default options: --help, -f/--fields and -o/--output.

For information about managing your Runtime Fabric instances using the command line, see Supported rtfctl Commands.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub
Submit your feedback!
Share your thoughts to help us build the best documentation experience for you!
Take our latest survey!