+
+

CloudHub Command-Line Interface

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

Anypoint Platform provides a scripting and command-line tool for CloudHub. The command-line interface (CLI) supports both the interactive shell and standard CLI modes and works with:

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

runtime-mgr cloudhub-alert list

> runtime-mgr cloudhub-alert list [options]

This command lists all alerts associated with your current environment.

This command accepts only the default options: --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 accepts only the default options: --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 number of vCores assigned and the last time it was updated.

This command accepts only the default options: --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.
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.

This command accepts only the default options: --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 accepts only the default options: --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 accepts only the default options: --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 accepts only the default options: --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 accepts only the default options: --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 accepts only the default options: --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.

If successful, this command’s output includes the deployment status of UNDEPLOYED, which indicates that CloudHub uploaded the application successfully.

The options this command can take are:

Option Description

--runtime

Name and version of the runtime environment.
Use this option to specify the name and version of the runtime you want to deploy.
Some examples of this value are 2.1.1-API-Gateway, 3.9.1-visualizer or 4.1.1.
Tap your tab key after this option for the CLI to show you all your available options. (This value is the latest CloudHub Runtime version by default.)

--workers

Number of workers. (This value is '1' by default)

--workerSize

Size of the workers in vCores. (This value is '1' by default)

--region

Name of the region to deploy to.
For a list of all supported regions, use the cloudhub region list command.

--property

Set a property (name:value). Can be specified multiple times.
The property to be set must be passed enclosed in quotes and characters : and = must be escaped.
(e.g. --property "salesforce.password:qa\=34534").

Character : is not supported for the property’s name.

--propertiesFile

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.

--persistentQueues

Enable or disable persistent queues. Can take true or false values. (This value is false by default)

--persistentQueuesEncrypted

Enable or disable persistent queue encryption. Can take true or false values. (This value is false by default)

--staticIPsEnabled

Enable or disable static IPs. Can take true or false values. (This value is false by default)

--objectStoreV1

Enable or disable Object Store V1. Can take true or false values

--autoRestart

Automatically restart app when not responding. Can take true or false values. (This value is true by default.)

--help

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.

This command’s output includes Status, which is the application’s previous deployment status state.

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 accepts only the default options: --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 your user to have read/write access to the /tmp directory of the OS where CLI is installed.

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

Option Description

--property

Set a property (name:value). Can be specified multiple times.

Enclose the property in quotes and escape the : and = characters, for example:

--property "salesforce.password:qa\=34534"

When copying an application containing safely hidden application properties, pass the properties in the copy command using the --property option. For information about safely hidden application properties, see Safely Hide Application Properties.

CloudHub Dedicated Load Balancers

Command Description

Lists all load balancers in an organization

Show load balancer details

Show load balancer details in raw 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

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 index. If no certificateName is given, the mappings for the default SSL endpoint are shown

Remove a proxy mapping rule. If 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 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 Anypoint VPC ID to which the load balancer is bound.

This command accepts only the default options: --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 Anypoint VPC Id to which the load balancer is bound.

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

cloudhub load-balancer describe-json

> cloudhub load-balancer describe [options] <name>

This command displays a raw JSON response from 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 accepts only the default options: --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

vpc

Name of the Anypoint VPC to which this load balancer is bound.
If your Anypoint VPC name contains spaces, you need to pass it between ยด"ยด characters.

vpc-demo

name

Name for the load balancer.

newtestloadbalancer

certificate

Absolute path to the .pem file of your server certificate in your local hard drive.
Your certificate files need to be PEM encoded and not encrypted.

/Users/mule/Documents/cert.pem

privateKey

Absolute path to the .pem file of your private key of the server certificate in your local hard drive.
Your private key file needs to be passphraseless.

/Users/mule/Documents/privateKey.pem

The name for the load balancer that you pass in <name> must be unique.
By default, your load balancer listens external requests on HTTPS and communicates with your workers internally through HTTP.
If you configured your Mule application within the Anypoint VPC to listen on HTTPS, make sure you set upstreamProtocol to HTTPS when creating the mapping list using the load-balancer mappings add command.

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

Value Description

http

Specifies the Load balancer HTTP behavior. It can be set to on (accepts HTTP requests and forwards it to your configured default sslendpoint), off (refuses all HTTP requests), or redirect (redirects to HTTPS).

clientCertificate

Client certificate file

verificationMode

Specifies the client verification mode. It can be set to on (verify always), off (don’t verify), or optional (verification optional).

crl

Certificate revocation list file

tlsv1

Supports TLSv1 in addition to TLSv1.1 and TLSv1.2

dynamic-ips

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

Name for the load balancer.

newtestloadbalancer

certificate

Absolute path to the .pem file of your certificate in your local hard drive.
Your certificate files need to be PEM encoded and not encrypted.

/Users/mule/Documents/cert.pem

privateKey

Absolute path to the .pem file of your private key in your local hard drive.
Your private key file needs to be passphraseless.

/Users/mule/Documents/privateKey.pem

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

clientCertificate

Client certificate file

verificationMode

Specifies the client verification mode. It can be set to on (verify always) off (don’t verify) or optional (Verification optional).

crl

Certificate Revocation List file

tlsv1

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

http

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 allowlist add

> cloudhub load-balancer allowlist 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

We favor the use of the term "allowlist" in adherence to our Inclusive Product Language Program.

cloudhub load-balancer allowlist remove

> cloudhub load-balancer allowlist 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

We favor the use of the term "allowlist" in adherence to our Inclusive Product Language Program.

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

Name of the load balancer to which this rule is applied.

testloadbalancer

index

Priority of the rule.

1

inputUri

Name of the URI of your input URL

example.com

appName

Name of the app of your output URL to which the request is forwarded

{app}-example

appUri

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 upstream protocol is set, HTTP is used as default.

Option Description

--upstreamProtocol <protocol>

Look for upstream applications in HTTP port 8091 or HTTPS port 8092. Supported Values: http, https

--certificateName <certificate name>

Optional parameter

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 accepts only the default options: --help, -f/--fields and -o/--output.

cloudhub runtime list

> cloudhub runtime list [options]

This command lists all supported runtimes.

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

CloudHub Anypoint VPCs

Command Description

Lists all Anypoint VPCs

Show Anypoint VPC details

Show raw Anypoint VPC JSON response

Create a new Anypoint VPC

Delete an existing Anypoint VPC

Modifies the Anypoint VPC association to Runtime Manager environments.

Modifies the Anypoint VPC association to Runtime Manager environments.

Share an Anypoint VPC with a list of Business Groups.

Share an Anypoint 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 Anypoint VPC

Add a firewall rule for Mule applications in this Anypoint VPC

Remove a firewall rule for Mule applications in this Anypoint VPC

cloudhub vpc list

> cloudhub VPC list [options]

This command lists all available Anypoint VPCs. It returns ID, region, and environment of the network and whether it is the default Anypoint VPC or not.

cloudhub vpc describe

> cloudhub vpc describe [options] <name>

This command displays information about the Anypoint VPC that is specified in <name>.

You can start typing your Anypoint 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 accepts only the default options: --help, -f/--fields and -o/--output.

cloudhub vpc describe-json

> cloudhub vpc describe [options] <name>

This command displays a raw JSON response of the Anypoint VPC that is specified in <name>.

You can start typing your Anypoint 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 accepts only the default options: --help, -f/--fields and -o/--output.

cloudhub vpc create

> cloudhub vpc create [options] <name> <region> <cidrBlock> [environments...]

This command creates an Anypoint 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 argument(s) thereafter.

An Anypoint VPC needs to be bound to a business group within your organization. When creating an Anypoint 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 Anypoint VPC is created as the default Anypoint VPC for the selected environment.

cloudhub vpc delete

> cloudhub vpc delete <name>

This command deletes the Anypoint 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 accepts only the default options: --help, -f/--fields and -o/--output.

cloudhub vpc environments add

> cloudhub vpc environments add [options] <vpc> [environments...]

This command assigns the Anypoint VPC defined in <vpc> to the environment(s) passed as argument(s) thereafter.
The --default option allows setting an Anypoint VPC as the default for the organization, which applies to all environments which don’t have an Anypoint 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 Anypoint 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 Anypoint VPC as the default Anypoint VPC for the environment.

cloudhub vpc business-groups add

> cloudhub vpc business-groups add [options] <vpc> <businessGroups...>

This command assigns the Anypoint VPC defined in <vpc> to the business group(s) passed as argument(s) thereafter.

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

cloudhub vpc business-groups remove

> cloudhub vpc business-groups remove [options] <vpc> <businessGroups...>

This command removes the Anypoint VPC defined in <vpc> from the business group(s) passed as argument(s) thereafter

This command does not prompt twice before removing the Anypoint VPC from the specified resource. If you send a remove instruction, it does not ask for confirmation.

This command accepts only the default options: --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

server

IP address for a DNS server to resolve special domains on. Can be specified up to 3 times

domain

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 Anypoint VPC passed in <vpc>.

This command accepts only the default options: --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 Anypoint VPC defined in <vpc>.

This command accepts only the default options: --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 Anypoint VPC defined in <vpc> using the values set in the variables:

Value Description Example

vpc

Name of the Anypoint VPC to which this load balancer is bound.
If your Anypoint VPC name contains spaces, you need to pass it between ยด"ยด characters

vpc-demo

cidrBlock

IP address in CIDR notation for the firewall to allow

192.0.1.0/27

protocol

The protocol to use in the rules. It can be tcp or udp

tcp

fromPort

The port from which the firewall will allow requests. It can go from 0 to 65535

8888

toPort

optional In case a port range is needed, the fromPort and toPort variables define such range

8090

When creating an Anypoint VPC, make sure to allow your outbound address.
By default, all IP addresses are blocked, and you need to authorize IP addresses or range of addresses to your Anypoint VPC firewall rule.

You can start typing your Anypoint 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 accepts only the default options: --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 Anypoint VPC specified in <vpc> at the index passed in the <index>.

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

Was this article helpful?

๐Ÿ’™ Thanks for your feedback!

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