+
+

CLI for Hybrid Applications

Use these commands for apps that are deployed to your local Mule server and managed with 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.

Was this article helpful?

💙 Thanks for your feedback!

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