CLI for CloudHub Applications
Use the cloudhub commands to automate your CloudHub Applications Processes. For more information about how to use these commands, refer to the CloudHub documentation.
| Command | Description |
|---|---|
Describes the history of the alarm |
|
Lists all alerts in the environment |
|
Copies a CloudHub application |
|
Deletes an application |
|
Deploys a new application |
|
Shows application details |
|
Download application logs to specified directory |
|
Lists all applications in the environment |
|
Modifies an existing application, optionally updating the ZIP file |
|
Restarts a running application |
|
Starts an application |
|
Stops a running application |
|
Tail application logs |
|
Lists all supported regions |
|
Lists all available runtimes |
runtime-mgr:cloudhub-alert-history:describe
> runtime-mgr:cloudhub-alert-history:describe [flags] <name>
Describes the history of the alarm passed in <name>
Use the --output flag to specify the response format. Supported values are table (default) and json.
This command accepts the default flag --help.
runtime-mgr:cloudhub-alert:list
> runtime-mgr:cloudhub-alert:list [flags]
Lists all alerts associated with your current environment
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:cloudhub-application:copy
> runtime-mgr:cloudhub-application:copy <source> <target> [flags]
Copies the CloudHub application passed in source to the target passed in target
Arguments source and target should be formatted as follows: ([group_id]/)<asset_id>/<version>
If group_id is not specified, it defaults to the currently selected Organization ID
For example:
> runtime-mgr:cloudhub-application:copy Services:QA/application-1 Development:QA/application-2
Copies the application named application-1 from the QA environment of the Services organization to the QA environment of the Development organization.
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:cloudhub-application:copy application-1 Development/QA/application-2
Running this command requires your user to have read/write access to the /tmp directory of the OS where CLI is installed.
|
In addition to the default flag --help, this command accepts the following flags:
| Flag | Description | Example |
|---|---|---|
|
Set a property ( |
|
| 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. |
When copying an application containing safely hidden application properties, pass the properties in the copy command using the --property flag.
For information about safely hidden application properties, see Safely Hide Application Properties.
|
runtime-mgr:cloudhub-application:delete
> runtime-mgr:cloudhub-application:delete [flags] <name>
Deletes the running application you specify in <name>
| This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation. |
This command accepts the default flag --help.
runtime-mgr:cloudhub-application:deploy
> runtime-mgr:cloudhub-application:deploy <name> <zipfile> [flags]
Deploys the Mule deployable archive ZIP file that you specify in <zipfile> using the name you set in <name>
You will have to provide the absolute or relative path to the deployable ZIP file in your local hard drive and the name you give to your application has to be unique.
If successful, this command’s output includes the deployment status of UNDEPLOYED,
which indicates that CloudHub uploaded the application successfully.
|
In addition to the default flag --help, this command accepts the following flags:
| Flag | Description | Example |
|---|---|---|
|
Name and version of the runtime environment. |
`--runtime 2.1.1-API-Gateway`, `--runtime 4.6-e-java17`. |
|
Set the name of the release channel to be used for the selected Mule version |
|
|
Set the name of the Java version to be used for the selected Mule version |
|
|
Number of workers |
|
|
Size of the workers in vCores |
|
|
Name of the region to deploy to |
|
|
Set a property ( |
|
`--propertiesFile |
Overwrite all properties with values from this file |
|
|
Enable or disable persistent queues |
|
`--[no-]persistentQueuesEncrypted ` |
Enable or disable persistent queue encryption |
|
|
Enable or disable static IPs |
|
|
Enable or disable Object Store V |
|
|
Enable or disable Object Store V2 |
|
|
Automatically restart app when not responding |
|
|
Specify the response format |
|
|
Set the timeout value in miliseconds |
|
| You won’t be able to allocate static IPs Anypoint Platform CLI. You can simply enable and disable them. |
|
If you deploy without using any flags, your application deploys using all your default values. |
| 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:cloudhub-application:describe
> runtime-mgr:cloudhub-application:describe [flags] <name>
Displays information on the application you pass in <name>
Use the flag -o json to get the raw JSON response of the application you specify in <name>.
The command returns data such as the application’s domain, its status, the last time it was updated, the Mule version, the ZIP file name, the region, monitoring, and workers; as well as TRUE or FALSE information for persistent queues and static IPs enablement.
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:cloudhub-application:download-logs
> runtime-mgr:cloudhub-application:download-logs [flags] <name> <directory>
Downloads logs the for application specified in <name> to the specified directory
Contrarily to what you see in the UI, the logs you download from the CLI won’t separate system logs from worker logs.
runtime-mgr:cloudhub-application:list
> runtime-mgr:cloudhub-application:list [flags]
Lists all applications available in your Anypoint Platform CLI
It returns your application name, its status, the number of vCores assigned and the last time it was updated.
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:cloudhub-application:modify
> runtime-mgr:cloudhub-application:modify <name> [zipfile] [flags]
Updates the settings of an existing application
Optionally, you can update it by uploading a new ZIP file.
This command can take all the same flags as the deploy command.
This command’s output includes Status, which is the application’s previous deployment status state.
|
| 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:cloudhub-application:restart
> runtime-mgr:cloudhub-application:restart [flags] <name>
Restarts the running application you specify in <name>
This command accepts the default flag --help.
runtime-mgr:cloudhub-application:start
> runtime-mgr:cloudhub-application:start [flags] <name>
Starts the running application you specify in <name>
This command accepts the default flag --help.
runtime-mgr:cloudhub-application:stop
> runtime-mgr:cloudhub-application:stop [flags] <name>
Stops the running application you specify in <name>
This command accepts the default flag --help.
runtime-mgr:cloudhub-application:tail-logs
> runtime-mgr:cloudhub-application:tail-logs [flags] <name>
Tails application logs
This command accepts the default flag --help.