Anypoint CLI 2.x List of Commands
Anypoint Platform CLI provides commands for different use case scenarios:
|
The Anypoint Platform CLI provides three default options:
|
Anypoint Platform Account
| Command | Description |
|---|---|
Show account details |
|
Lists business groups |
|
Show details of a business group |
|
Lists environments |
|
Create new environment |
|
Delete an environment |
|
Shows details of an environment |
API Manager
| Command | Description |
|---|---|
Lists all APIs in API Manager |
|
Deletes an API version |
|
Lists all versions of an API in API Manager |
|
Approves a given application |
|
Approves SLA tier change |
|
Deletes a given application |
|
Lists all applications to a given API version |
|
Rejects a given application |
|
Rejects SLA tier change |
|
Restores a given application |
|
Revokes a given application |
|
Sets SLA tier for a given application |
|
Copies an API definition from one API to another |
|
Download an API definition to a local directory |
|
Uploads a local API definition to API Manager |
|
Configures the endpoint of a given API version |
|
Shows the endpoint configuration of a given API version |
|
Apply a policy to a given API version |
|
Copies the policy configuration from one API version to another. Doing this removes the policies that don’t exist in the source API version |
|
Show the description and available configuration properties of a given policy |
|
Disable a policy from a given API version |
|
Edit the policy configuration of a given API version |
|
Enable a policy on a given API version |
|
List policies |
|
Remove a policy from a given API version |
|
Copies an API portal from source to target |
|
Lists all the portals for an API |
|
Opens the API portal in your browser |
|
Creates an SLA tier |
|
Copy SLA tiers from one API version to another |
|
Delete SLA tier |
|
Deprecate SLA tier |
|
Edit SLA tier |
|
Lists API version SLA tiers |
|
Reactivate SLA tier |
|
Download a ZIP archive of a proxy to a local directory |
Design Center Applications
| Command | Description |
|---|---|
Creates a new Design Center project |
|
Deletes a Design Center project |
|
Downloads the content of a Design Center project |
|
Publishes a Design Center project to Exchange |
|
Uploads the content of a project to Design Center |
|
List all Design Center projects |
Exchange Assets
| Command | Description |
|---|---|
Uploads an Exchange asset |
|
Modifies an Exchange asset |
|
Downloads an Exchange asset |
|
Lists all assets |
|
Downloads an asset’s description page from Exchange |
|
Changes an asset’s description page from Exchange |
|
Uploads an asset’s description page from Exchange |
|
Deletes an asset’s description page from Exchange |
|
List all pages for a given asset |
|
Copies an Exchange asset |
|
Deletes an asset from Exchange |
|
Deprecates an asset |
|
Undeprecate an asset |
|
Show a given asset’s information |
CloudHub Applications
| Command | Description |
|---|---|
Lists all alerts in the environment |
|
Describes the history of the alarm |
|
Lists all applications in the environment |
|
Show application details |
|
Show raw application JSON response |
|
Stop a running application |
|
Start an application |
|
Restart a running application |
|
Delete an application |
|
Deploy a new application |
|
Modify an existing application, optionally updating the zip file |
|
Download application logs to specified directory |
|
Tail application logs |
|
Copies a CloudHub application |
Locally Deployed Applications Managed by Runtime Manager
| In order for the Anypoint Platform CLI to recognize your target servers, each server needs to be manually registered with the platform. |
| Command | Description |
|---|---|
Downloads application artifact binary |
|
Deploys a new application to an on-premises server, server group, or cluster |
|
Shows a raw standalone application JSON response |
|
Changes a standalone application artifact |
|
Starts an standalone application |
|
Deletes an standalone application |
|
Shows detailed info of a standalone application |
|
Lists all standalone applications in the environment |
|
Restarts a standalone application |
|
Stops a standalone application |
|
Copies a standalone application |
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 |
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 |
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 |
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 |
CloudHub Dedicated Load Balancer
| Command | Description |
|---|---|
Lists all load balancers in an organization |
|
Show LB details |
|
Show raw LB JSON response |
|
Create a load balancer |
|
Starts a load balancer |
|
Stops a load balancer |
|
Delete a load balancer |
|
Add an additional certificate to an existing load balancer |
|
Remove a certificate from a load balancer |
|
Set the default certificate that the load balancer will serve |
|
Show the load balancer configuration for a particular certificate |
|
Add an IP or range of IPs to the load balancer allowlist |
|
Remove an IP or range of IPs from the load balancer allowlist |
|
Lists the proxy mapping rules for a load balancer. If no certificateName is given, the mappings for the default SSL endpoint are shown |
|
Add a proxy mapping rule at the specified indexIf no certificateName is given, the mappings for the default SSL endpoint are shown |
|
Remove a proxy mapping ruleIf no certificateName is given, the mappings for the default SSL endpoint are shown |
|
Enables dynamic IPs |
|
Disables dynamic IPs |
|
Lists all supported regions |
|
Lists all available runtimes |
CloudHub Anypoint Virtual Private Cloud (VPC)
| Command | Description |
|---|---|
Lists all VPCs |
|
Show VPC details |
|
Show raw VPC JSON response |
|
Create a new VPC |
|
Delete an existing VPC |
|
Modifies the VPC association to Runtime Manager environments. |
|
Modifies the VPC association to Runtime Manager environments. |
|
Share a VPC with a list of Business Groups. |
|
Share a VPC with a list of Business Groups. |
|
Sets the domain names that are resolved using your internal DNS servers. If used with no option, internal DNS will be disabled |
|
Clears the list domain names that are resolved using your internal DNS servers |
|
Show firewall rule for Mule applications in this VPC |
|
Add a firewall rule for Mule applications in this VPC |
|
Remove a firewall rule for Mule applications in this VPC |
Environments and Business Groups
| Command | Description |
|---|---|
Make specified environment active |
|
Make specified business-group active |
An Anypoint Platform CLI call has the following form:
$ anypoint-cli [params] [command]If you choose not to pass a command, Anypoint Platform CLI will run in interactive mode. If you choose to pass a specific command and there is an error, the application exits and return you a description of the issue.
account user describe
> account user describe [options]
This command simply returns the information for your account. This includes your username, your full name, your email address, and the creation date of your account.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output
account business-group list
> account business-group list [options]
This command displays all business groups. It returns the name of the business group, and the ID.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
account business-group describe
> account business-group describe [options] <name>
This command displays information on the business group you pass in <name>.
If <name> is not specified, the command describes the business group on the current session.
|
If your business group or organization name contains spaces, you need to enclose its name between > account business-group describe "QA Organization" |
This command returns data such as the owner, the type, subscription information, the entitlements of the group and in which environment is running.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
account environment list
> account environment list [options]
This command lists all your environments in Anypoint Platform. It returns your environment name, ID and whether it’s sandboxed or not.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output
account environment create
> account environment create [options] <name>
This command creates a new environment using the name you set in <name>.
Besides the default --help, -f/--fields and -o/--output options, this command also takes the --type option. Use the --type option to specify the environment type.
Supported values for environment types are:
-
design -
production -
sandbox
If no type is specified, the command creates a production environment.
account environment delete
> account environment delete [options] <name>
This command deletes the environment specified in <name>
| This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation. |
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
account environment describe
> account environment describe [options] <name>
This command deletes the environment specified in <name>
If no <name> is provided, this command returns information about the current session’s environment.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr api list
> api-mgr api list [options] <searchText>
This command lists all APIs in API Manager.
You can specify an API Name in searchText to get the results of that specific API.
This command lists each API name, the latest version of the API, version count of the API and the time passed since it was last updated.
Besides the default --help, -f/--fields and -o/--output options, this command also takes:
| Command | Description | Example |
|---|---|---|
|
Number of results to retrieve |
|
|
Offsets the amount of APIs passed |
|
|
Sorts the results in the field name passed |
|
api-mgr api-version delete
> api-mgr api-version delete [options] <apiName> <version>
This command deletes version specified in version of the API passed in apiName.
| This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation. |
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr api-version list
> api-mgr api-version list [options] <apiName>
This command lists all versions of the API specified in apiName.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr applications approve
> api-mgr applications approve [options] <clientId> <apiName> <apiVersion>
This command approves the access request from the application with the client ID passed in clientId to the API specified in apiName and version passed in apiVersion.
| You can use the api-mgr applications list command to get the Client ID of the application you’d like to interact with. |
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr applications approve-tier-change
> api-mgr applications approve-tier-change [options] <clientId> <apiName> <apiVersion>
This command approves the SLA tier change for the application with the client ID passed in clientId to the API specified in apiName and version passed in apiVersion.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
|
You can use the api-mgr applications list command to get the Client ID of the application you’d like to interact with. |
api-mgr applications delete
> api-mgr applications delete [options] <clientId> <apiName> <apiVersion>
This command deletes the application associated with the client ID passed in clientId to the API passed in apiName with version specified in apiVersion.
| This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation. |
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
|
You can use the api-mgr applications list command to get the Client ID of the application you’d like to interact with. |
api-mgr applications list
> api-mgr applications list [options] <apiName> <apiVersion> [searchText]
This command displays information about the applications whose access request status to your API is either pending, approved or revoked.
| You can specify keywords in searchText to limit results to APIs containing those specific keywords. |
Besides the default --help, -f/--fields and -o/--output options, this command also takes:
| Command | Description | Example |
|---|---|---|
|
When passed, this command only lists applications with pending SLA tier change requests. |
|
|
Number of results to retrieve |
|
|
Offsets the amount of APIs passed |
|
|
Sorts the results in the field name passed |
|
api-mgr applications reject
> api-mgr applications reject [options] <clientId> <apiName> <apiVersion>
This command rejects the application to the API passed in apiName and version specified in apiVersion.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
|
You can use the api-mgr applications list command to get the Client ID of the application you’d like to interact with. |
api-mgr applications reject-tier-change
> api-mgr applications reject-tier-change [options] <clientId> <apiName> <apiVersion>
This command rejects the SLA tier change requested by the application with client ID passed in clientId for the API passed in apiName and version specified in apiVersion.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
|
You can use the api-mgr applications list command to get the client ID of the application you’d like to interact with. |
api-mgr applications restore
> api-mgr applications restore [options] <clientId> <apiName> <apiVersion>
This command restores the requested application associated with the client ID passed in clientId with the API passed in apiName and version specified in apiVersion.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
| You can use the api-mgr applications list command to get the Client ID of the application you’d like to interact with. |
api-mgr applications revoke
> api-mgr applications revoke [options] <clientId> <apiName> <apiVersion>
This command revokes the application associated with the client ID passed in clientId to the API passed in apiName and version specified in apiVersion.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
| You can use the api-mgr applications list command to get the Client ID of the application you’d like to interact with. |
api-mgr applications set-tier
> api-mgr applications set-tier [options] <tierId> <clientId> <apiName> <apiVersion>
This command sets the SLA Tier specified in tierId for the application associated with the client ID passed in clientId, and to the API passed in apiName and version specified in apiVersion.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
| You can create a tier using the api-mgr tiers add command. |
api-mgr definition copy
> api-mgr definition copy [options] <source> <target>
This command copies the definition from the API passed in source to the API 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:
> api-mgr definition copy Services/api-1/1.0 Development/api-1/1.0
Copies the definition of the API named api-1 and version 1.0 from the Services organization to the Development organization.
If Anypoint Platform CLI is using the Services organization, the command can simply take the application name as a source:
> api-mgr definition copy api-1/1.0 Development/api-1/1.0
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr definition download
> api-mgr definition download [options] <apiName> <version> <directory>
This command downloads the API definition of the API passed in apiName with version specified in version to the local directory passed in directory.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr definition upload
> api-mgr definition upload [options] <apiName> <version> <directory>
This command uploads the API definition from the directory passed in directory, to the API passed in apiName with version passed in version.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
Besides the default --help, -f/--fields and -o/--output options, this command also takes:
| Command | Description | Example |
|---|---|---|
|
Passed when the API definition is swagger |
|
|
Defines the root file of the API definition to upload |
|
api-mgr endpoint configure
> api-mgr endpoint configure [options] <apiName> <apiVersion>
This command lets configure the endpoint for the API specified in apiName with version apiVersion.
Besides the default --help, -f/--fields and -o/--output options, this command also takes:
| Command | Description |
|---|---|
|
Indicates whether the endpoint should use a proxy. Passing |
|
Indicates whether a CloudHub proxy should be configured. Passing |
|
Indicates whether a proxy should reference a user domain |
|
Endpoint type |
|
Implementation URI |
|
Get implementation URI from RAML |
|
Proxy scheme |
|
Proxy port |
|
Proxy path |
|
Response Timeout |
api-mgr endpoint describe
> api-mgr endpoint describe [options] <apiName> <apiVersion>
This command describes the endpoint of the API passed in apiName with version passed in apiVersion.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr policy apply
> api-mgr policy apply [options] <policyId> <apiName> <apiVersion>
This command applies the policy passed in policyId to the API and version passed in apiName and apiVersion respectively.
|
You can learn the policy ID of each default policy using the api-mgr policy list command. |
|
The policy configuration properties must be passed in JSON format using the api-mgr policy apply ip-blacklist test-api 1 -c '{"ips": "123.1.1.1"}'
|
Besides the the -c/--config option, this command also takes the default --help, -f/--fields and -o/--output options.
|
You can use the api-mgr policy describe option to check the default field names and values of each default policy. |
api-mgr policy copy
> api-mgr policy copy [options] <source> <target> [policyId]
This command copies all policies from the API passed in source to the API 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.
When the policyId argument is provided, only the policy with that matching ID is copied.
For example:
> api-mgr policy copy Services/api-1/1.0 Development/api-1/1.0
Copies the policy of the API named api-1 and version 1.0 from Services organization to the Development organization.
> api-mgr policy copy Services/api-1/1.0 Development/api-1/1.0 ip-blacklist
Only copies the ip-blacklist policy.
If the Anypoint Platform CLI is using the Services organization, the command can simply take the application name as a source:
> api-mgr definition copy api-1/1.0 Development/api-1/1.0
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr policy describe
> api-mgr policy describe [options] <policyId>
This command shows a description of the policy passed in policyId.
|
You can learn the policy ID of each default policy using the api-mgr policy list command. |
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr policy disable
> api-mgr policy disable [options] <policyId> <apiName> <apiVersion>
This command disables the policy passed in policyId from the API and version passed in apiName and apiVersion respectively.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
|
You can learn the policy ID of each default policy using the api-mgr policy list command. |
api-mgr policy edit
> api-mgr policy edit [options] <policyId> <apiName> <apiVersion>
This command edits the policy passed in policyId on the API and version passed in apiName and apiVersion respectively.
|
You can learn the policy ID of each default policy using the api-mgr policy list command. |
|
The Policy configuration properties must be passed in JSON format using the api-mgr policy edit ip-blacklist test-api 1 -c '{"ips": "123.1.1.1"}'
|
Besides the the -c/--config option, this command also takes the default --help, -f/--fields and -o/--output options.
|
You can use the api-mgr policy describe option to check the default field names and values of each default policy. |
api-mgr policy enable
> api-mgr policy enable [options] <policyId> <apiName> <apiVersion>
This commands enables the policy passed in policyId in the API and version passed in apiName and apiVersion.
|
You can learn the policy ID of each default policy using the api-mgr policy list command. |
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr policy list
> api-mgr policy list [options] [apiName] [apiVersion]
This command lists all the policies available.
When apiName and apiVersion are provided, this command returns the policies applied to the specified API.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr policy remove
> api-mgr policy remove [options] <policyId> <apiName> <apiVersion>
This command removes the the policy passed in policyId from the API and version passed in apiName and apiVersion respectively.
|
You can learn the policy ID of each default policy using the api-mgr policy list command. |
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr portal copy
> api-mgr portal copy [options] <source> <target>
This command copies the API Portal from the API passed in source to the API 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:
> api-mgr portal copy Services/api-1/1.0 Development/api-1/1.0
Copies the API portal of the API named api-1 and version 1.0 from Services organization to the Development organization.
If the Anypoint Platform CLI is using the Services organization, the command can simply take the application name as a source:
> api-mgr portal copy api-1/1.0 Development/api-1/1.0
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr portal list
> api-mgr portal list [options] <apiName>
This command lists all portals associated with the API passed in apiName.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr portal open
This command is only available for interactive mode.
> api-mgr portal open [options] <apiName> <version>
This command opens in your browser the API portal of the API and version passed in apiName and version.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr tiers add
> api-mgr tiers add [options] <apiName> <apiVersion>
This command creates an SLA tier for the API and version passed in apiName and version.
Besides the default --help, -f/--fields and -o/--output options, this command also takes:
| Command | Description | ||
|---|---|---|---|
|
Indicates whether SLA tier should be auto-approved. |
||
|
SLA tier name |
||
|
SLA Tier description |
||
|
Single instance of an SLA tier limit in the form
For example:
|
api-mgr tiers copy
> api-mgr tiers copy [options] <source> <target>
This command copies the SLA tier from the API passed in source to the API 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:
> api-mgr tiers copy Services/api-1/1.0 Development/api-1/1.0
Copies the tier of the API named api-1 and version 1.0 from Services organization to the Development organization.
If the Anypoint Platform CLI is using the Services organization, the command can simply take the application name as a source:
> api-mgr tiers copy api-1/1.0 Development/api-1/1.0
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr tiers delete
> api-mgr tiers delete [options] <tierId> <apiName> <apiVersion>
This command deletes the SLA tier passed in tierId from the API and version from apiName and apiVersion respectively.
This command does not take any options, except for the default ones: --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. |
api-mgr tiers deprecate
> api-mgr tiers deprecate [options] <tierId> <apiName> <apiVersion>
This command deprecates the SLA tier passed in tierId from the apiName and apiVersion.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr tiers edit
> api-mgr tiers edit [options] <tierId> <apiName> <apiVersion>
This command edits the SLA tier passed in tierId associated with the API and version passed in apiName and apiVersion respectively.
|
All passed data replaces the original with no deep merging or comparison performed. Full SLA tier data must be passed. |
Besides the default --help, -f/--fields and -o/--output options, this command also takes:
| Command | Description | ||
|---|---|---|---|
|
Indicates whether SLA tier should be auto-approved. |
||
|
SLA tier name |
||
|
SLA tier description |
||
|
Single instance of an SLA tier limit in the form
For example:
|
api-mgr tiers list
> api-mgr tiers list [options] <apiName> <apiVersion>
This command lists all SLA tiers for the API and version passed in apiName and apiVersion respectively.
Besides the default --help, -f/--fields and -o/--output options, this command also takes:
| Command | Description | Example |
|---|---|---|
|
Number of results to retrieve |
|
|
Offsets the amount of APIs passed |
|
|
Sorts the results in the field name passed |
|
api-mgr tiers reactivate
> api-mgr tiers reactivate [options] <tierId> <apiName> <apiVersion>
This command reactivates the SLA tier passed in tierId for the API and version passed in apiName and apiVersion.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
api-mgr proxy download
> api-mgr proxy download [options] <apiName> <apiVersion> <directory>
This command download a ZIP archive of the proxy used by <apiName> and <apiVersion> to the local directory passed in <directory>.
Besides the default --help, -f/--fields and -o/--output options, this command also takes the -gatewayVersion option. If not specified, the command defaults to the latest version.
designcenter project create
> designcenter project create [options] <name>
This Command creates a new Design Center project with the name specified in <name>.
| This command does not support Mule application types. |
Besides the default --help, -f/--fields and -o/--output options, this command also takes:
| Command | Description | Example |
|---|---|---|
|
The project type. Supported values are:
|
|
|
The fragment type if the application type is a RAML fragment. This field is required if the type option was set as Supported fragments type are:
|
|
designcenter project delete
> designcenter project delete [options] <name>
This Command deletes the Design Center project specified in <name>.
| This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation. |
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
designcenter project download
> designcenter project download [options] <name> <targetDir>
This Command downloads the Design Center project passed in name to your local directory specified in targetDir.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
designcenter project publish
> designcenter project publish [options] <projectName>
This Command publishes the Design Center project passed in projectName to Exchange.
Besides the default --help, -f/--fields and -o/--output options, this command also takes:
| Options that are not specified are extracted from exchange.json |
| Command | Description | Example |
|---|---|---|
|
The name for the asset |
|
|
The name of the main file name. |
|
|
The API version if your project is an API specification project. |
|
|
Comma separated list of tags. |
|
|
The asset’s groupId. |
|
|
The asset’s assetId. |
|
|
The asset’s version. |
|
designcenter project upload
> designcenter project upload [options] <name> <projDir>
This Command uploads a Design Center project from your local directory passed in projDir and names it using the name passed in <name>.
By default, this command ignores all hidden files and directories. To include hidden files and directories, use the --include-dot-files option.
When the --include-dot-files option is used, the command uploads hidden files and folders from your specified directory.
Besides the --include-dot-files, this command takes the default --help, -f/--fields and -o/--output options.
designcenter project list
> designcenter project list [options] [searchText]
This Command lists all your Design Center projects.
You can start typing your project’s name and press tab for Anypoint Platform CLI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
exchange asset upload
> exchange asset upload [options] <assetIdentifier> [filePath]
This command upload an OAS, WSDL, HTTP or custom asset using the IDs passed in <assetIdentifier>.
If [filePath] points to a ZIP archive file, that archive must include an exchange.json file describing the asset.
Argument assetIdentifier should be formatted as follows: <group_id>/<asset_id>/<version>.
Besides the default --help, -f/--fields and -o/--output options, this command also takes:
| Command | Description | Example |
|---|---|---|
|
Asset API version |
|
|
Asset name |
|
|
Asset classifier |
exchange asset modify
> exchange asset modify [options] <assetIdentifier>
This command modifies the Exchange asset identified with <assetIdentifier>.
Argument assetIdentifier should be formatted as follows: ([group_id]/)<asset_id>/<version>.
If group_id is not specified, it defaults to the currently selected Organization ID.
Besides the default --help, -f/--fields and -o/--output options, this command also takes:
| Command | Description | Example |
|---|---|---|
|
New asset name |
|
|
Comma-separated tags for the asset |
exchange asset download
> exchange asset download [options] <assetIdentifier> <directory>
This command downloads the Exchange asset identified with <assetIdentifier> to the directory passed in <directory>.
Argument assetIdentifier should be formatted as follows: ([group_id]/)<asset_id>/<version>.
If group_id is not specified, it defaults to the currently selected Organization ID.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
exchange asset list
> exchange asset list [options] [searchText]
This command lists all assets in Exchange.
| You can specify keywords in searchText to limit results to APIs containing those specific keywords. |
Besides the default --help, -f/--fields and -o/--output options, this command also takes:
| Command | Description | Example |
|---|---|---|
|
Number of results to retrieve |
|
|
Offsets the amount of APIs passed |
|
|
Sorts the results in the field name passed |
|
exchange asset page download
> exchange asset page download [options] <assetIdentifier> <directory> [pageName]
This command downloads the description page specified in <pageName>, for the Exchange asset identified with <assetIdentifier> to the directory passed in <directory>.
If [pageName] is not specified, this command downloads all pages.
| This command only supports published pages. |
Argument assetIdentifier should be formatted as follows: ([group_id]/)<asset_id>/<version>.
If group_id is not specified, it defaults to the currently selected Organization ID.
The description page in downloaded in Markdown format. When name is not specified, all pages are downloaded.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
exchange asset page modify
> exchange asset page modify [options] <assetIdentifier> <pageName>
This command modifies the description page specified in <pageName>, for the Exchange asset identified with <assetIdentifier>.
| This command only supports published pages. |
Argument assetIdentifier should be formatted as follows: ([group_id]/)<asset_id>/<version>.
If group_id is not specified, it defaults to the currently selected Organization ID.
Besides the default --help, -f/--fields and -o/--output options, this command also takes the --name option to set a new asset page name.
exchange asset page upload
> exchange asset page upload [options] <assetIdentifier> <pageName> <mdPath>
This command uploads an asset description page from the path passed in <mdPath> using the name specified in <pageName> to the Exchange asset identified with <assetIdentifier>.
Naming the page home makes the uploaded page the main description page for the Exchange asset.
| This command only supports published pages. |
Argument assetIdentifier should be formatted as follows: ([group_id]/)<asset_id>/<version>.
If group_id is not specified, it defaults to the currently selected Organization ID.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
exchange asset page delete
> exchange asset page delete [options] <assetIdentifier> <pageName>
This command deletes the description page specified in <pageName>, for the asset identified with <assetIdentifier>.
If [pageName] is not specified, this command downloads all pages.
| This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation. |
| This command only supports published pages. |
Argument assetIdentifier should be formatted as follows: ([group_id]/)<asset_id>/<version>.
If group_id is not specified, it defaults to the currently selected Organization ID.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
exchange asset page list
> exchange asset page list <assetIdentifier>
This command lists all pages for the asset passed in <assetIdentifier>.
Argument assetIdentifier should be formatted as follows: ([group_id]/)<asset_id>/<version>.
If group_id is not specified, it defaults to the currently selected Organization ID.
| This command only supports published pages. |
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
exchange asset copy
> exchange asset copy [options] <source> <target>
This command copies the Exchange asset from <source> to <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.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
exchange asset delete
> exchange asset delete [options] <assetIdentifier>
This command deletes the Exchange asset passed in <assetIdentifier>.
| This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation. |
Argument assetIdentifier should be formatted as follows: ([group_id]/)<asset_id>/<version>.
If group_id is not specified, it defaults to the currently selected Organization ID.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
exchange asset deprecate
> exchange asset deprecate <assetIdentifier>
This command deprecates the asset passed in <assetIdentifier>.
Argument assetIdentifier should be formatted as follows: ([group_id]/)<asset_id>/<version>.
If group_id is not specified, it defaults to the currently selected Organization ID.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
exchange asset undeprecate
> exchange asset undeprecate <assetIdentifier>
This command undeprecates the asset passed in <assetIdentifier>.
Argument assetIdentifier should be formatted as follows: ([group_id]/)<asset_id>/<version>.
If group_id is not specified, it defaults to the currently selected Organization ID.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
exchange asset describe
> exchange asset describe <assetIdentifier>
This command describes the asset passed in <assetIdentifier>.
Argument assetIdentifier should be formatted as follows: ([group_id]/)<asset_id>/<version>.
If group_id is not specified, it defaults to the currently selected Organization ID.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr cloudhub-alert list
> runtime-mgr cloudhub-alert list [options]
This command lists all alerts associated with your current environment
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr cloudhub-alert-history describe
> runtime-mgr cloudhub-alert-history describe [options] <name>
This command describes the history of the alarm passed in <name>.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr cloudhub-application list
> runtime-mgr cloudhub-application list [options]
This command lists all applications available in your Anypoint Platform CLI. It returns your application name, its status, the amount of vCores assigned and the last time it was updated.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr cloudhub-application describe
> runtime-mgr cloudhub-application describe [options] <name>
This command displays information on the application you pass in <name>.
You can start typing your application’s name and press tab for Anypoint Platform CLI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
It will return data such as the application’s domain, its status, last time it was updated, the Runtime version, the .zip file name, the region, monitoring, and Workers; as well as 'TRUE' or 'FALSE' information for persistent queues and static IPs enablement.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr cloudhub-application describe-json
> runtime-mgr cloudhub-application describe-json [options] <name>
This command returns the raw JSON response of the application you specify in <name>.
You can start typing your application’s name and press tab for Anypoint Platform CLI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr cloudhub-application stop
> runtime-mgr cloudhub-application stop [options] <name>
This command stops the running application you specify in <name>
You can start typing your application’s name and press tab for Anypoint Platform ClI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr cloudhub-application start
> runtime-mgr cloudhub-application start [options] <name>
This command starts the running application you specify in <name>
You can start typing your application’s name and press tab for Anypoint Platform CLI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr cloudhub-application restart
> runtime-mgr cloudhub-application restart [options] <name>
This command restarts the running application you specify in <name>
You can start typing your application’s name and press tab for Anypoint Platform CLI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr cloudhub-application delete
> runtime-mgr cloudhub-application delete [options] <name>
This command 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 does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr cloudhub-application deploy
> runtime-mgr cloudhub-application deploy [options] <name> <zipfile>
This command deploys the Mule deployable archive .zip file that you specify in <zipfile> using the name you set in <name>.
You can start typing your application’s name and press tab for Anypoint Platform CLI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
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.
The options this command can take are:
| Option | Description |
|---|---|
|
Name and version of the runtime environment. |
|
Number of workers. (This value is '1' by default) |
|
Size of the workers in vCores. (This value is '1' by default) |
|
Name of the region to deploy to. |
|
Set a property (name:value). Can be specified multiple times. Character |
|
Overwrite all properties with values from this file. The file format is 1 or more lines in name:value format. Set the absolute path of the properties file in your local hard drive. |
|
Enable or disable persistent queues. Can take |
|
Enable or disable persistent queue encryption. Can take |
|
Enable or disable static IPs. Can take 'Enable' or 'Disabled' values. (This value is 'Disabled' by default) |
|
Automatically restart app when not responding. Can take |
|
output usage information |
Note that from Anypoint Platform CLI you won’t be able to allocate static IPs. You can simply enable and disable them.
After typing any option, you can double tap the tab key for a full list of all possible options.
For example:
> deploy <app name> --runtime [tab][tab]
Lists all possible runtimes you can select.
|
If you deploy without using any options, your application will deploy using all your default values. |
runtime-mgr cloudhub-application modify
> runtime-mgr cloudhub-application modify [options] <name> [zipfile]
This command updates the settings of an existing application. Optionally you can update it by uploading a new .zip file.
You can start typing your application’s name and press tab for Anypoint Platform CLI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
This command can take all the same options as the deploy option.
You can also start typing your option and press tab for Anypoint Platform CLI to autocomplete it for you.
runtime-mgr cloudhub-application download-logs
> runtime-mgr cloudhub-application download-logs [options] <name> <directory>
This command downloads logs the for application specified in <name> to the specified directory.
You can start typing your application’s name and press tab for Anypoint Platform CLI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
Keep in mind that 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 tail-logs
> runtime-mgr cloudhub-application tail-logs [options] <name>
This command tails application logs.
You can start typing your application’s name and press tab for Anypoint Platform CLI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr cloudhub-application copy
> runtime-mgr cloudhub-application copy [options] <source> <target>
This command 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 for your user to have read/write access to the /tmp directory of the OS where CLI is installed.
|
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
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 does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr standalone-application deploy
> runtime-mgr standalone-application deploy [options] <targetIdentifier> <name> <zipfile>
This command deploys 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 does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr standalone-application describe-json
> runtime-mgr standalone-application describe-json [options] <identifier>
This command describes the application passed in identifier as a raw JSON response.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr standalone-application modify
> runtime-mgr standalone-application modify [options] <identifier> <zipfile>
This command modifies the standalone application passed in identifier with the zip file application passed in zipfile as a path.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr standalone-application start
> runtime-mgr standalone-application start [options] <identifier>
This command starts the application passed in identifier.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr standalone-application delete
> runtime-mgr standalone-application delete [options] <identifier>
This command deletes the application passed in identifier.
This command does not take any options, except for the default ones: --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 describes the standalone application passed in identifier.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr standalone-application list
> runtime-mgr standalone-application list [options]
This command lists all standalone applications.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr standalone-application restart
> runtime-mgr standalone-application restart [options] <identifier>
This command restarts the application passed in identifier.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr standalone-application stop
> runtime-mgr standalone-application stop [options] <identifier>
This command stops the standalone application passed in identifier.
This command does not take any options, except for the default ones: --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 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 CLI is installed.
|
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr server describe
> runtime-mgr server describe [options] <serverId>
This command describes the server passed in serverId.
This command does not take any options, except for the default ones: --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 does not take any options, except for the default ones: --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 does not take any options, except for the default ones: --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 does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
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 does not take any options, except for the default ones: --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 does not take any options, except for the default ones: --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 does not take any options, except for the default ones: --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 does not take any options, except for the default ones: --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 does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
runtime-mgr serverGroup remove server
> runtime-mgr serverGroup remove server [options] <serverGroupId> <serverId>
This command removes the removes the server passed in serverId, from the server group passed in serverGroupId.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
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 does not take any options, except for the default ones: --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 does not take any options, except for the default ones: --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 does not take any options, except for the default ones: --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 does not take any options, except for the default ones: --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 |
|---|---|
|
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 |
runtime-mgr cluster describe
> runtime-mgr cluster describe [options] <clusterId>
This command describes the cluster passed in clusterId.
This command does not take any options, except for the default ones: --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-mgr standalone-alert describe
> runtime-mgr standalone-alert describe [options] <alertId>
This command describes the alert passed in alertId.
This command does not take any options, except for the default ones: --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.
Besides the default --help, -f/--fields and -o/--output options, this command also takes:
| Value | Description |
|---|---|
|
Alert severity |
|
Alert resource type |
|
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. |
|
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 multiple usernames. |
|
Email to send alert notification to. Can be used multiple times to specify multiple emails. |
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 |
|---|---|
|
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 multiple usernames. |
|
Email to send alert notification to. Can be used multiple times to specify multiple emails. |
runtime-mgr standalone-alert list
> runtime-mgr standalone-alert list [options]
This command lists all alerts for standalone runtimes in the current environment.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
cloudhub load-balancer list
> cloudhub load-balancer list [options]
This command lists all load balancers in your Anypoint Platform. It displays load balancer’s name, domain, its state and the VPC ID to which the load balancer is bound.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
cloudhub load-balancer describe
> cloudhub load-balancer describe [options] <name>
This command displays information about the load balancer that is specified in <name>.
You can start typing your load balancer’s name and press tab for Anypoint Platform CLI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
It displays load balancer’s name, domain, its state and the VPC ID to which the load balancer is bound.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
cloudhub load-balancer describe-json
> cloudhub load-balancer describe [options] <name>
This command displays raw JSON response of the load balancer that is specified in <name>.
You can start typing your load balancer’s name and press tab for Anypoint Platform CLI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
cloudhub load-balancer create
> cloudhub load-balancer create [options] <vpc> <name> <certificate> <privateKey>
This command creates a load balancer using the specified values in the variables.
| Value | Description | Example |
|---|---|---|
|
Name of the VPC to which this load balancer is bound. |
vpc-demo |
|
Name for the load balancer. |
|
|
Absolute path to the |
|
|
Absolute path to the |
|
|
The name for the load balancer that you pass in |
Besides the default --help, -f/--fields and -o/--output options, this command also takes:
| Value | Description |
|---|---|
|
Specifies the load balancer HTTP behavior. It can be set to |
|
Client certificate file |
|
Specifies the client verification mode. It can be set to |
|
Certificate Revocation List file |
|
Supports TLSv1 in addition to TLSv1.1 and TLSv1.2 |
|
Uses dynamic IPs, which are not persistent through restarts |
| CloudHub does not implement the Online Certificate Status Protocol (OCSP). To keep your certification revocation list up to date, it’s recommended to use the CloudHub API to update your certificates programmatically. |
For more configuration information, see Configure SSL Endpoints and Certificates.
cloudhub load-balancer start
> cloudhub load-balancer start [options] <name>
This command starts the load balancer specified in <name>.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output
cloudhub load-balancer stop
> cloudhub load-balancer stop [options] <name>
This command stops the load balancer specified in <name>.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output
cloudhub load-balancer delete
> cloudhub load-balancer delete [options] <name>
This command deletes the load balancer specified in <name>.
| This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation. |
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output
cloudhub load-balancer ssl-endpoint add
> cloudhub load-balancer ssl-endpoint add [options] <name> <certificate> <privateKey>
This command adds an SSL endpoint to the load balancer specified in <name>, using the certificate and private key passed.
| Value | Description | Example |
|---|---|---|
|
Name for the load balancer. |
|
|
Absolute path to the |
/Users/mule/Documents/cert.pem |
|
Absolute path to the |
|
| CloudHub does not implement the Online Certificate Status Protocol (OCSP). To keep your certification revocation list up to date, it’s recommended to use the CloudHub API to update your certificates programmatically. |
Besides the default --help, -f/--fields and -o/--output options, this command also takes:
| Value | Description |
|---|---|
|
Client certificate file |
|
Specifies the client verification mode. It can be set to |
|
Certificate Revocation List file |
|
Supports TLSv1 in addition to TLSv1.1 and TLSv1.2 |
For more configuration information, see Configure SSL Endpoints and Certificates.
cloudhub load-balancer ssl-endpoint remove
> cloudhub load-balancer ssl-endpoint remove [options] <name> <certificateName>
This command removes the SSL certificate specified in <certificateName> from the load balancer specified in <name>.
| This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation. |
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output
cloudhub load-balancer ssl-endpoint set-default
> cloudhub load-balancer ssl-endpoint set-default [options] <name> <certificateName>
This command sets the certificate specified in <certificateName> as the default certificate for the load balancer passed in <name>.
You can start typing your load balancer’s name and press tab for Anypoint Platform CLI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
Besides the default --help, -f/--fields and -o/--output options, this command also takes:
| Value | Description |
|---|---|
|
Specifies the load balancer HTTP behavior |
cloudhub load-balancer ssl-endpoint describe
> cloudhub load-balancer ssl-endpoint describe [options] <name> <certificateName>
This command shows information about the configuration of the load balancer passed in <name> for the the certificate specified in <certificateName>.
You can start typing your load balancer’s name and press tab for Anypoint Platform CLI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output
cloudhub load-balancer whitelist add
> cloudhub load-balancer whitelist add [options] <name> <cidrBlock>
This command adds a range of IP addresses specified in <cidrBlock> to the allowlist of the load balancer specified in <name>.
| The allowlist works at the load balancer level, not at the CN certificate level. Make sure you only pass IP addresses formatted in CIDR notation. |
You can start typing your load balancer’s name and press tab for Anypoint Platform CLI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output
cloudhub load-balancer whitelist remove
> cloudhub load-balancer whitelist remove <name> <cidrBlock>
This command removes an IP or range of IPs addresses specified in <cidrBlock> to the allowlist of the load balancer specified in <name>.
| This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation. |
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output
cloudhub load-balancer mappings describe
> cloudhub load-balancer mappings describe <name> [certificateName]
This command lists the mapping rules for the load balancer specified in <name>.
If no certificateName is passed, Anypoint Platform CLI returns the mappings for the default SSL endpoint.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output
cloudhub load-balancer mappings add
> cloudhub load-balancer mappings add [options] <name> <index> <inputUri> <appName> <appUri> [certificateName]
This command adds a proxy mapping rule to the load balancer specified in <name> at the priority index specified in <index> in the CN passed under the certificateName option.
If no certificateName is passed, Anypoint Platform CLI adds the mappings to the default SSL endpoint.
| Value | Description | Example |
|---|---|---|
|
Name of the load balancer to which this rule is applied. |
|
|
Priority of the rule. |
1 |
|
Name of the URI of your input URL |
example.com |
|
Name of the app of your output URL to which the request is forwarded |
|
|
URI of the app of your output URL to which the request is forwarded |
/ |
For the values in the example above, for an input call to my-superapp.api.example.com/status?limit=10, the endpoint my-superapp-example: /status?limit=10 will be called for the application.
This command also takes the --upstreamProtocol option.
The --upstreamProtocol option sets the protocol used by your application to communicate internally with your load balancer. If no upstreamProtocol is set, HTTP is used as default.
| Value | Description | Example |
|---|---|---|
|
Look for upstream applications in HTTP port 8091 or HTTPS port 8092. |
|
|
cloudhub load-balancer mappings remove
> cloudhub load-balancer mappings remove [options] <name> <index> [certificateName]
This command removes the proxy mapping rules from the load balancer specified in <name> at the priority index specified in <index> and the CN specified as the certificateName option.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output
If no certificateName is passed, Anypoint Platform CLI removes the mappings for the default SSL endpoint.
cloudhub load-balancer dynamic-ips enable
> cloudhub load-balancer dynamic-ips enable [options] <name>
This command enables dynamic IPs for the load balancer specified in <name>.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output
cloudhub load-balancer dynamic-ips disable
> cloudhub load-balancer dynamic-ips disable [options] <name>
This command disables dynamic IPs for the load balancer specified in <name>.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output
cloudhub region list
> cloudhub region list [options]
This command lists all supported regions.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
cloudhub runtime list
> cloudhub runtime list [options]
This command lists all supported runtimes.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
cloudhub vpc list
> cloudhub vpc list [options]
This command lists all available VPCs. It returns ID, region, and environment of the network and whether it is the default VPC or not.
cloudhub vpc describe
> cloudhub vpc describe [options] <name>
This command displays information about the VPC that is specified in <name>.
You can start typing your VPC’s name and press tab for Anypoint Platform CLI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
cloudhub vpc describe-json
> cloudhub vpc describe [options] <name>
This command displays raw JSON response of the VPC that is specified in <name>.
You can start typing your VPC’s name and press tab for Anypoint Platform CLI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
cloudhub vpc create
> cloudhub vpc create [options] <name> <region> <cidrBlock> [environments...]
This command creates a VPC using the name in <name>, in the region specified in <region>, with the size passed in <cidrBlock> in the form of a Classless Inter-Domain Routing (CIDR) block, using CIDR notation and associates it to the environments passed as arguments thereafter.
| A VPC needs to be bound to a business group within your organization. When creating a VPC, make sure to assign it a business group using the business-groups add command. |
Besides the default --help option, this command also takes the --default option. When passed, the VPC is created as the default VPC for the selected environment.
cloudhub vpc delete
> cloudhub vpc delete <name>
This command deletes the VPC specified in <name>.
| This command does not prompt twice before deleting. If you send a delete instruction, it does not ask for confirmation. |
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
cloudhub vpc environments add
> cloudhub vpc environments add [options] <vpc> [environments...]
This command assigns the VPC defined in <vpc> to the environment(s) passed as argument(s) thereafter.
The --default option allows setting a VPC as the default for the organization, which applies to all environments which don’t have a VPC explicitly associated.
This command also takes the default --help option.
cloudhub vpc environments remove
> cloudhub vpc environments remove [options] <vpc> [environments...]
This command removes the VPC defined in <vpc> from the environment(s) passed as argument(s) thereafter.
Besides the default --help option, this command also takes the option --default, that removes this VPC as the default VPC for the environment.
cloudhub vpc business-groups add
> cloudhub vpc business-groups add [options] <vpc> <businessGroups...>
This command assigns the VPC defined in <vpc> to the business group(s) passed as argument(s) thereafter.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
cloudhub vpc business-groups remove
> cloudhub vpc business-groups remove [options] <vpc> <businessGroups...>
This command removes the VPC defined in <vpc> from the business group(s) passed as argument(s) thereafter
| This command does not prompt twice before removing the VPC from the specified resource. If you send a remove instruction, it does not ask for confirmation. |
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
cloudhub vpc dns-servers set
> cloudhub vpc dns-servers set [options] <vpc>
This command sets a list of local host names (internal domain names) to be resolved using your DNS servers for which you need to provide their IP addresses (whether private or public addresses).
Whenever those private domains are provided, your worker resolves them using your private DNS, so you can still use the internal host names of your private network.
| This feature is supported by workers running Mule versions 3.5.x, 3.6.x, 3.7.4, 3.8.0-HF1, 3.8.1 and 3.8.2. |
Besides the default --help, -f/--fields and -o/--output options, this command also takes:
| Option | Description |
|---|---|
|
IP for a DNS server to resolve special domains on. Can be specified up to 3 times |
|
A domain to resolve on the special DNS server list. Can be specified multiple times |
You can pass as many domains as you need, and up to 3 IP addresses.
For example, $ cloudhub vpc dns-servers set --domain example.com --server 192.168.1.10 <VPC Name>.
Every time you run this command, you overwrite your previous DNS set command.
To remove a DNS set, you need to use the vpc dns-servers unset command.
cloudhub vpc dns-servers unset
> cloudhub vpc dns-servers unset [options] <vpc>
This command clears the list of local host names (internal domain names) to be resolved using your DNS servers from the VPC passed in <vpc>.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
cloudhub vpc firewall-rules describe
> cloudhub vpc firewall-rules describe <vpc>
This command describes all the firewall rules for the VPC defined in <vpc>.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
cloudhub vpc firewall-rules add
> cloudhub vpc firewall-rules add [options] <vpc> <cidrBlock> <protocol> <fromPort> [toPort]
This command adds a firewall rule to the VPC defined in <vpc> using the values set in the variables:
| Value | Description | Example |
|---|---|---|
|
Name of the VPC to which this load balancer is bound. |
|
|
IP address in CIDR notation for the firewall to allow |
192.0.1.0/27 |
|
The protocol to use in the rules. It can be |
tcp |
|
The port from which the firewall will allow requests. It can go from 0 to 65535 |
8888 |
|
Optional. In case a port range is needed, the |
8090 |
|
When creating a VPC, make sure to allow your outbound address. |
You can start typing your VPC’s name and press tab for Anypoint Platform CLI to autocomplete it, or you can double tap tab for a full list of all the values you can pass.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
cloudhub vpc firewall-rules remove
> cloudhub vpc firewall-rules remove <vpc> <index>
This command removes the firewall rule from the workers inside the VPC specified in <vpc> at the index passed in the <index>.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
use environment
This command is only available for interactive mode.
> use environment [options] <name>
This command makes active the environment specified in <name>.
This command does not take any options, except for the default ones: --help, -f/--fields and -o/--output.
use business-group
This command is only available for interactive mode.
> use business-group [options] <name>
This command makes the business group you specified in <name> active.
|
If your business group or organization name contains spaces, you need to enclose its name between > use business-group "QA Organization" |