Contact Us 1-800-596-4880

Locally Deployed Applications Managed by Runtime Manager

Use these commands to control applications deployed to your local Mule server and managed with Runtime Manager. For more information about how to use these commands, refer to the Runtime Manager documentation.

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

Copies a standalone application

Deletes a standalone application

Deploys or redeploys an application to an on-premises server, server group, or cluster

Shows detailed information for a standalone application

Lists all standalone applications in the environment

Changes a standalone application artifact

Restarts a standalone application

Starts a standalone application

Stops a standalone application

runtime-mgr:standalone-application:artifact

> runtime-mgr:standalone-application:artifact [flags] <identifier> <directory>

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:copy

> runtime-mgr:standalone-application:copy [flags] <source> <target> <targetIdentifier>

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.

runtime-mgr:standalone-application:delete

> runtime-mgr:standalone-application:delete [flags] <identifier>

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:deploy

> runtime-mgr:standalone-application:deploy [flags] <targetIdentifier> <name> <zipfile>

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

> runtime-mgr:standalone-application:describe [flags] <identifier>

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 accepts 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-application:list

> runtime-mgr:standalone-application:list [flags]

Lists all standalone (on-premises) applications.

In addition to the default flag --help, this command accepts the following flags:

Flag Description Example

--limit

Specifies the number of results to retrieve

--limit 50

--offset

Offsets the number of applications passed

--offset 20

--output

Specifies the response format.

--output json

runtime-mgr:standalone-application:modify

> runtime-mgr:standalone-application:modify [flags] <identifier> <zipfile>

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 flag --help, this command accepts the following flags:

Flag Description Example

--insight

Stores message metadata of every Mule transaction.

--insight

--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 flags.

--log INFO:org.apache --log WARN:org.mule

runtime-mgr:standalone-application:restart

> runtime-mgr:standalone-application:restart [flags] <identifier>

Restarts the standalone (on-premises) application passed in identifier.

This command accepts only the default flag --help.

runtime-mgr:standalone-application:start

> runtime-mgr:standalone-application:start [flags] <identifier>

Starts 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>

Stops the standalone (on-premises) application passed in identifier.

This command accepts only the default flag --help.