---
schema_version: "1"
id: c16b4507619e5b1d0d79cb8a236e33c273f0bd504d18db6efe8b3e3930788d5f
title: CloudHub Command-Line Interface
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/cloudhub/cloudhub-cli.md
canonical_url: https://docs.mulesoft.com/cloudhub/cloudhub-cli
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 3afd9ed9c0809b290ce046a202104986e4e7e144597d8195a09739ecba9bd48e
description: MuleSoft Documentation Site
latest: true
---
---
product: CloudHub
---

# CloudHub Command-Line Interface

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

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](#cloudhub-apps)

- [CloudHub Dedicated Load Balancers](#cloudhub-dlb)

- [CloudHub Anypoint VPCs](#cloudhub-vpc)

## CloudHub Applications

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-alert-history-describe">runtime-mgr:cloudhub-alert-history:describe</a></p></div></div></td><td><div><div><p>Describes the history of the alarm</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-alert-list">runtime-mgr:cloudhub-alert:list</a></p></div></div></td><td><div><div><p>Lists all alerts in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-application-copy">runtime-mgr:cloudhub-application:copy</a></p></div></div></td><td><div><div><p>Copies a CloudHub application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-application-delete">runtime-mgr:cloudhub:application:delete</a></p></div></div></td><td><div><div><p>Deletes an application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#deploy-to-cloudhub">runtime-mgr:cloudhub-application:deploy</a></p></div></div></td><td><div><div><p>Deploys a new application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-application-describe">runtime-mgr:cloudhub-application:describe</a></p></div></div></td><td><div><div><p>Shows application details</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-application-download-logs">runtime-mgr:cloudhub-application:download:logs</a></p></div></div></td><td><div><div><p>Download application logs to specified directory</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-application-list">runtime-mgr:cloudhub:application:list</a></p></div></div></td><td><div><div><p>Lists all applications in the environment</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-application-modify">runtime-mgr:cloudhub-application:modify</a></p></div></div></td><td><div><div><p>Modifies an existing application, optionally updating the ZIP file</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-application-restart">runtime-mgr:cloudhub-application:restart</a></p></div></div></td><td><div><div><p>Restarts a running application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-application-start">runtime-mgr:cloudhub-application:start</a></p></div></div></td><td><div><div><p>Starts an application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-application-stop">runtime-mgr:cloudhub-application:stop</a></p></div></div></td><td><div><div><p>Stops a running application</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#runtime-mgr-cloudhub-application-tail-logs">runtime-mgr:cloudhub-application:tail:logs</a></p></div></div></td><td><div><div><p>Tail application logs</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#cloudhub-region-list">cloudhub:region:list</a></p></div></div></td><td><div><div><p>Lists all supported regions</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-apps#cloudhub-runtime-list">cloudhub:runtime:list</a></p></div></div></td><td><div><div><p>Lists all available runtimes</p></div></div></td></tr></tbody></table>

### runtime-mgr:cloudhub-alert-history:describe

\> runtime-mgr:cloudhub-alert-history:describe \[flags\] <name>

Describes the history of the alarm passed in `<name>`

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### runtime-mgr:cloudhub-alert:list

\> runtime-mgr:cloudhub-alert:list \[flags\]

Lists all alerts associated with your current environment

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### runtime-mgr:cloudhub-application:copy

\> runtime-mgr:cloudhub-application:copy <source> <target> \[flags\]

Copies the CloudHub application passed in `source` to the target passed in `target`  
Arguments `source` and `target` should be formatted as follows: `([group_id]/)<asset_id>/<version>`
If `group_id` is not specified, it defaults to the currently selected Organization ID

For example:

\> runtime-mgr:cloudhub-application:copy Services:QA/application-1 Development:QA/application-2

Copies the application named `application-1` from the QA environment of the Services organization to
the QA environment of the Development organization.  
If the Anypoint Platform CLI is using the QA environment in the Services organization, the command
can simply take the application name as a `source`:

\> runtime-mgr:cloudhub-application:copy application-1 Development/QA/application-2

> [!NOTE] 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 flags](https://docs.mulesoft.com/cloudhub/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--property</code></p></div></div></td><td><div><div><p>Set a property (<code>name:value</code>).</p></div></div></td><td><div><div><p><code>--property "salesforce.password:qa\=34534"</code></p></div></div></td></tr></tbody></table>

> [!NOTE] This command has multi-option flags. When using multi-option flags in a command, either
> put the parameter before the flags or use a \`-- \` (two dashes followed by a space) before the
> parameter.

> [!NOTE] When copying an application containing safely hidden application properties, pass the
> properties in the `copy` command using the `--property` flag. For information about safely hidden
> application properties, see [Safely Hide Application Properties](https://docs.mulesoft.com/cloudhub/secure-application-properties).

### runtime-mgr:cloudhub-application:delete

\> runtime-mgr:cloudhub-application:delete \[flags\] <name>

Deletes the running application you specify in `<name>`

> [!WARNING] This command does not prompt twice before deleting. If you send a delete instruction,
> it does not ask for confirmation.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### runtime-mgr:cloudhub-application:deploy

\> runtime-mgr:cloudhub-application:deploy <name> <zipfile> \[flags\]

Deploys the Mule deployable archive ZIP file that you specify in `<zipfile>` using the name you set
in `<name>`  
You will have to provide the absolute or relative path to the deployable ZIP file in your local hard
drive and the name you give to your application has to be unique.

> [!NOTE] If successful, this command’s output includes the deployment status of `UNDEPLOYED`, which
> indicates that CloudHub uploaded the application successfully.

In addition to the [default flags](https://docs.mulesoft.com/cloudhub/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--runtime</code></p></div></div></td><td><div><div><p>Name and version of the runtime environment.<br>Use this flag to specify the name and version of the runtime you want to deploy<br>If you don’t specify a runtime version, CloudHub API deploys the latest version available considering the values you select for <code>--javaVersion</code> and <code>--releaseChannel</code>.</p></div></div></td><td><div><div><p><code>--runtime 2.1.1-API-Gateway</code>, <code>--runtime 4.6-e-java8</code> (Edge), <code>--runtime 4.6-e-java17</code> (Edge), <code>--runtime 4.6-java8</code> (LTS), <code>--runtime 4.6-java17</code> (LTS)</p></div></div></td></tr><tr><td><div><div><p><code>--releaseChannel</code></p></div></div></td><td><div><div><p>Set the name of the release channel to be used for the selected Mule version<br>Supported values are <code>NONE</code>, <code>EDGE</code>, and <code>LTS</code><br>If you don’t specify a value, CloudHub API imposes the default value. The default release channel is <code>EDGE</code><br>If you don’t specify a Mule version, the default Mule version for the selected release channel is used. If the selected release channel doesn’t exist, you get an error.</p></div></div></td><td><div><div><p><code>--releaseChannel EDGE</code></p></div></div></td></tr><tr><td><div><div><p><code>--javaVersion</code></p></div></div></td><td><div><div><p>Set the name of the Java version to be used for the selected Mule version<br>Supported values are <code>8</code> and <code>17</code><br>If you don’t specify a value, CloudHub API imposes the default value. The default Java version for Mule 4.6 and earlier versions is '8'.<br>If you don’t specify a Mule version, the default Mule version for the selected Java version is used. If the Java version you select is not available for the specified Mule version, you get an error.</p></div></div></td><td><div><div><p><code>--javaVersion 8</code></p></div></div></td></tr><tr><td><div><div><p><code>--workers</code></p></div></div></td><td><div><div><p>Number of workers<br>Default value is '1'</p></div></div></td><td><div><div><p><code>--workers 3</code></p></div></div></td></tr><tr><td><div><div><p><code>--workerSize</code></p></div></div></td><td><div><div><p>Size of the workers in vCores<br>(Default value is '1'</p></div></div></td><td><div><div><p><code>--workerSize 2</code></p></div></div></td></tr><tr><td><div><div><p><code>--region</code></p></div></div></td><td><div><div><p>Name of the region to deploy to</p></div></div></td><td><div><div><p><code>--region Canada</code></p></div></div></td></tr><tr><td><div><div><p><code>--property</code></p></div></div></td><td><div><div><p>Set a property (<code>name:value</code>)<br>Character <code>:</code> is not supported for the property’s name</p></div></div></td><td><div><div><p><code>--property "salesforce.password:qa\=34534"</code></p></div></div></td></tr><tr><td><div><div><p>`--propertiesFile</p></div></div></td><td><div><div><p>Overwrite all properties with values from this file<br>The file format is 1 or more lines in <code>name:value</code> format<br>Set the absolute path of the properties file in your local hard drive</p></div></div></td><td><div><div><p><code>--propertiesFile exampleFile.JSON</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]persistentQueues</code></p></div></div></td><td><div><div><p>Enable or disable persistent queues<br>Default value is <code>disabled</code></p></div></div></td><td><div><div><p><code>--[no-]persistentQueues</code></p></div></div></td></tr><tr><td><div><div><p>`--[no-]persistentQueuesEncrypted `</p></div></div></td><td><div><div><p>Enable or disable persistent queue encryption<br>Default value is <code>disabled</code></p></div></div></td><td><div><div><p><code>--[no-]persistentQueuesEncrypted</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]staticIPsEnabled</code></p></div></div></td><td><div><div><p>Enable or disable static IPs<br>Default value is <code>disabled</code></p></div></div></td><td><div><div><p><code>--[no-]staticIPsEnabled</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]objectStoreV1</code></p></div></div></td><td><div><div><p>Enable or disable Object Store V<br><code>objectStoreV2</code> can’t also be provided when using <code>objectStoreV1</code> flag</p></div></div></td><td><div><div><p><code>--[no-]objectStoreV1</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]objectStoreV2</code></p></div></div></td><td><div><div><p>Enable or disable Object Store V2<br><code>objectStoreV1</code> can’t also be provided when using <code>objectStoreV2</code> flag</p></div></div></td><td><div><div><p><code>--[no-]objectStoreV2</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]autoRestart</code></p></div></div></td><td><div><div><p>Automatically restart app when not responding<br>Default value is <code>enabled</code></p></div></div></td><td><div><div><p><code>--[no-]autoRestart</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specify the response format<br>Supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr><tr><td><div><div><p><code>--timeout</code></p></div></div></td><td><div><div><p>Set the timeout value in miliseconds<br>Can take values between <code>60000</code> and <code>300000</code></p></div></div></td><td><div><div><p><code>--timeout 90000</code></p></div></div></td></tr></tbody></table>

> [!NOTE] You won’t be able to allocate static IPs Anypoint Platform CLI. You can simply enable and
> disable them.

> [!IMPORTANT] If you deploy without using any flags, your application deploys using all your
> default values.

> [!NOTE] This command has multi-option flags. When using multi-option flags in a command, either
> put the parameter before the flags or use a \`-- \` (two dashes followed by a space) before the
> parameter.

### runtime-mgr:cloudhub-application:describe

\> runtime-mgr:cloudhub-application:describe \[flags\] <name>

Displays information on the application you pass in `<name>`  
Use the flag `-o json` to get the raw JSON response of the application you specify in `<name>`.  
The command returns data such as the application’s domain, its status, the last time it was updated,
the Mule version, the ZIP file name, the region, monitoring, and workers; as well as `TRUE` or
`FALSE` information for persistent queues and static IPs enablement.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### runtime-mgr:cloudhub-application:download-logs

\> runtime-mgr:cloudhub-application:download-logs \[flags\] <name> <directory>

Downloads logs the for application specified in `<name>` to the specified directory

Contrarily to what you see in the UI, the logs you download from the CLI won’t separate system logs
from worker logs.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### runtime-mgr:cloudhub-application:list

\> runtime-mgr:cloudhub-application:list \[flags\]

Lists all applications available in your Anypoint Platform CLI  
It returns your application name, its status, the number of vCores assigned and the last time it was
updated.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### runtime-mgr:cloudhub-application:modify

\> runtime-mgr:cloudhub-application:modify <name> \[zipfile\] \[flags\]

Updates the settings of an existing application  
Optionally, you can update it by uploading a new ZIP file. This command can take all the same flags
as the `deploy` command.

> [!NOTE] This command’s output includes `Status`, which is the application’s previous deployment
> status state.

> [!NOTE] This command has multi-option flags. When using multi-option flags in a command, either
> put the parameter before the flags or use a \`-- \` (two dashes followed by a space) before the
> parameter.

In addition to the [default flags](https://docs.mulesoft.com/cloudhub/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--runtime</code></p></div></div></td><td><div><div><p>Name and version of the runtime environment.<br>Use this flag to specify the name and version of the runtime you want to deploy<br>If you don’t specify a runtime version, CloudHub API deploys the latest version available considering the values you select for <code>--javaVersion</code> and <code>--releaseChannel</code>.</p></div></div></td><td><div><div><p><code>--runtime 2.1.1-API-Gateway</code>, <code>--runtime 4.6-e-java8</code> (Edge), <code>--runtime 4.6-e-java17</code> (Edge), <code>--runtime 4.6-java8</code> (LTS), <code>--runtime 4.6-java17</code> (LTS)</p></div></div></td></tr><tr><td><div><div><p><code>--releaseChannel</code></p></div></div></td><td><div><div><p>Set the name of the release channel to be used for the selected Mule version<br>Supported values are <code>NONE</code>, <code>EDGE</code>, and <code>LTS</code><br>If you don’t specify a value, CloudHub API imposes the default value. The default release channel is <code>EDGE</code><br>If you don’t specify a Mule version, the default Mule version for the selected release channel is used. If the selected release channel doesn’t exist, you get an error.</p></div></div></td><td><div><div><p><code>--releaseChannel EDGE</code></p></div></div></td></tr><tr><td><div><div><p><code>--javaVersion</code></p></div></div></td><td><div><div><p>Set the name of the Java version to be used for the selected Mule version<br>Supported values are <code>8</code> and <code>17</code><br>If you don’t specify a value, CloudHub API imposes the default value. The default Java version for Mule 4.6 and earlier versions is '8'.<br>If you don’t specify a Mule version, the default Mule version for the selected Java version is used. If the Java version you select is not available for the specified Mule version, you get an error.</p></div></div></td><td><div><div><p><code>--javaVersion 8</code></p></div></div></td></tr><tr><td><div><div><p><code>--workers</code></p></div></div></td><td><div><div><p>Number of workers<br>Default value is '1'</p></div></div></td><td><div><div><p><code>--workers 3</code></p></div></div></td></tr><tr><td><div><div><p><code>--workerSize</code></p></div></div></td><td><div><div><p>Size of the workers in vCores<br>(Default value is '1'</p></div></div></td><td><div><div><p><code>--workerSize 2</code></p></div></div></td></tr><tr><td><div><div><p><code>--region</code></p></div></div></td><td><div><div><p>Name of the region to deploy to</p></div></div></td><td><div><div><p><code>--region Canada</code></p></div></div></td></tr><tr><td><div><div><p><code>--property</code></p></div></div></td><td><div><div><p>Set a property (<code>name:value</code>)<br>Character <code>:</code> is not supported for the property’s name</p></div></div></td><td><div><div><p><code>--property "salesforce.password:qa\=34534"</code></p></div></div></td></tr><tr><td><div><div><p>`--propertiesFile</p></div></div></td><td><div><div><p>Overwrite all properties with values from this file<br>The file format is 1 or more lines in <code>name:value</code> format<br>Set the absolute path of the properties file in your local hard drive</p></div></div></td><td><div><div><p><code>--propertiesFile exampleFile.JSON</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]persistentQueues</code></p></div></div></td><td><div><div><p>Enable or disable persistent queues<br>Default value is <code>disabled</code></p></div></div></td><td><div><div><p><code>--[no-]persistentQueues</code></p></div></div></td></tr><tr><td><div><div><p>`--[no-]persistentQueuesEncrypted `</p></div></div></td><td><div><div><p>Enable or disable persistent queue encryption<br>Default value is <code>disabled</code></p></div></div></td><td><div><div><p><code>--[no-]persistentQueuesEncrypted</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]staticIPsEnabled</code></p></div></div></td><td><div><div><p>Enable or disable static IPs<br>Default value is <code>disabled</code></p></div></div></td><td><div><div><p><code>--[no-]staticIPsEnabled</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]objectStoreV1</code></p></div></div></td><td><div><div><p>Enable or disable Object Store V<br><code>objectStoreV2</code> can’t also be provided when using <code>objectStoreV1</code> flag</p></div></div></td><td><div><div><p><code>--[no-]objectStoreV1</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]objectStoreV2</code></p></div></div></td><td><div><div><p>Enable or disable Object Store V2<br><code>objectStoreV1</code> can’t also be provided when using <code>objectStoreV2</code> flag</p></div></div></td><td><div><div><p><code>--[no-]objectStoreV2</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]autoRestart</code></p></div></div></td><td><div><div><p>Automatically restart app when not responding<br>Default value is <code>enabled</code></p></div></div></td><td><div><div><p><code>--[no-]autoRestart</code></p></div></div></td></tr><tr><td><div><div><p><code>--output</code></p></div></div></td><td><div><div><p>Specify the response format<br>Supported values are <code>table</code> (default) and <code>json</code></p></div></div></td><td><div><div><p><code>--output json</code></p></div></div></td></tr><tr><td><div><div><p><code>--timeout</code></p></div></div></td><td><div><div><p>Set the timeout value in miliseconds<br>Can take values between <code>60000</code> and <code>300000</code></p></div></div></td><td><div><div><p><code>--timeout 90000</code></p></div></div></td></tr></tbody></table>

### runtime-mgr:cloudhub-application:restart

\> runtime-mgr:cloudhub-application:restart \[flags\] <name>

Restarts the running application you specify in `<name>`

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### runtime-mgr:cloudhub-application:start

\> runtime-mgr:cloudhub-application:start \[flags\] <name>

Starts the running application you specify in `<name>`

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### runtime-mgr:cloudhub-application:stop

\> runtime-mgr:cloudhub-application:stop \[flags\] <name>

Stops the running application you specify in `<name>`

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### runtime-mgr:cloudhub-application:tail-logs

\> runtime-mgr:cloudhub-application:tail-logs \[flags\] <name>

Tails application logs

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:region:list

\> cloudhub:region:list \[flags\]

Lists all supported regions

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:runtime:list

\> cloudhub:runtime:list \[flags\]

Lists all supported runtimes

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

## CloudHub Dedicated Load Balancers

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-allowlist-add">cloudhub:load-balancer:allowlist:add</a></p></div></div></td><td><div><div><p>Adds an IP or range of IPs to the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-allowlist-remove">cloudhub:load-balancer:allowlist:remove</a></p></div></div></td><td><div><div><p>Removes an IP or range of IPs from the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-create">cloudhub:load-balancer:create</a></p></div></div></td><td><div><div><p>Creates a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-delete">cloudhub:load-balancer:delete</a></p></div></div></td><td><div><div><p>Deletes a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-describe">cloudhub:load-balancer:describe</a></p></div></div></td><td><div><div><p>Shows load balancer details</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-dynamic-ips-disable">cloudhub:load-balancer:dynamic-ips:disable</a></p></div></div></td><td><div><div><p>Disables dynamic IPs</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-dynamic-ips-enable">cloudhub:load-balancer:dynamic-ips:enable</a></p></div></div></td><td><div><div><p>Enables dynamic IPs</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-list">cloudhub:load-balancer:list</a></p></div></div></td><td><div><div><p>Lists all load balancers in an organization</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-mappings-add">cloudhub:load-balancer:mappings:add</a></p></div></div></td><td><div><div><p>Adds a proxy mapping rule at the specified index</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-mappings-describe">cloudhub:load-balancer:mappings:describe</a></p></div></div></td><td><div><div><p>Lists the proxy mapping rules for a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-mappings-remove">cloudhub:load-balancer:mappings:remove</a></p></div></div></td><td><div><div><p>Removes a proxy mapping rule</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-ssl-endpoint-add">cloudhub:load-balancer:ssl-endpoint:add</a></p></div></div></td><td><div><div><p>Adds an additional certificate to an existing load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-ssl-endpoint-describe">cloudhub:load-balancer:ssl-endpoint:describe</a></p></div></div></td><td><div><div><p>Shows the load balancer configuration for a particular certificate</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-ssl-endpoint-remove">cloudhub:load-balancer:ssl-endpoint:remove</a></p></div></div></td><td><div><div><p>Removes a certificate from a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-ssl-endpoint-set-default">cloudhub:load-balancer:ssl-endpoint:set-default</a></p></div></div></td><td><div><div><p>Sets the default certificate that the load balancer will serve</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-start">cloudhub:load-balancer:start</a></p></div></div></td><td><div><div><p>Starts a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-stop">cloudhub:load-balancer:stop</a></p></div></div></td><td><div><div><p>Stops a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-whitelist-add">cloudhub:load-balancer:whitelist:add</a></p></div></div></td><td><div><div><p>Adds an IP or range of IPs to the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-dlb#cloudhub-load-balancer-whitelist-remove">cloudhub:load-balancer:whitelist:remove</a></p></div></div></td><td><div><div><p>Removes an IP or range of IPs from the load balancer allowlist</p></div></div></td></tr></tbody></table>

### cloudhub:load-balancer:allowlist:add

\> cloudhub:load-balancer:allowlist:add \[flags\] <name> <cidrBlock>

Adds a range of IP addresses specified in `<cidrBlock>` to the allowlist of the load balancer
specified in `<name>`

> [!NOTE] 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](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#IPv4_CIDR_blocks).

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:load-balancer:allowlist:remove

\> cloudhub:load-balancer:allowlist:remove <name> <cidrBlock>

Removes an IP or range of IPs addresses specified in `<cidrBlock>` to the allowlist of the load
balancer specified in `<name>`

> [!WARNING] This command does not prompt twice before deleting. If you send a delete instruction,
> it does not ask for confirmation.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:load-balancer:create

\> cloudhub:load-balancer:create \[flags\] <vpc> <name> <certificate> <privateKey>

Creates a load balancer using the specified values in the following variables:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Value</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><p><code>vpc</code></p></td><td><div><div><p>Name of the Anypoint VPC to which this load balancer is bound.<br>If your Anypoint VPC name contains spaces, you need to pass it between ´"´ characters.</p></div></div></td><td><div><div><p><code>vpc-demo</code></p></div></div></td></tr><tr><td><p><code>name</code></p></td><td><div><div><p>Name for the load balancer.</p></div></div></td><td><div><div><p><code>newtestloadbalancer</code></p></div></div></td></tr><tr><td><p><code>certificate</code></p></td><td><div><div><p>Absolute path to the <code>.pem</code> file of your server certificate in your local hard drive.<br>Your certificate files need to be PEM encoded and not encrypted.</p></div></div></td><td><div><div><p><code>/Users/mule/Documents/cert.pem</code></p></div></div></td></tr><tr><td><p><code>privateKey</code></p></td><td><div><div><p>Absolute path to the <code>.pem</code> file of your private key of the server certificate in your local hard drive.<br>Your private key file needs to be passphraseless.</p></div></div></td><td><div><div><p><code>/Users/mule/Documents/privateKey.pem</code></p></div></div></td></tr></tbody></table>

> [!CAUTION] 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](#cloudhub-load-balancer-mappings-add) command.

In addition to the [default flags](https://docs.mulesoft.com/cloudhub/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--clientCertificate</code></p></div></div></td><td><div><div><p>Client certificate file</p></div></div></td><td><div><div><p><code>--clientCertificate /Users/mule/Documents/CertificateFile.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>--crl</code></p></div></div></td><td><div><div><p>Certificate revocation list file</p></div></div></td><td><div><div><p><code>--crl /Users/mule/Documents/crlFile.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>--http</code></p></div></div></td><td><div><div><p>Specifies the Load balancer HTTP behavior. It can be set to <code>on</code> (accepts HTTP requests and forwards it to your configured default <code><em>sslendpoint</em></code>), <code>off</code> (refuses all HTTP requests), or <code>redirect</code> (redirects to HTTPS).</p></div></div></td><td><div><div><p><code>--http off</code></p></div></div></td></tr><tr><td><div><div><p><code>--transportDownstreamProtocols</code></p></div></div></td><td><div><div><p>TLS version used for communication between customer and DLB<br>Supported values: <code>TLSv1.2</code>, <code>TLSv1.3</code></p></div></div></td><td><div><div><p><code>--transportDownstreamProtocols=TLSv1.2</code></p></div></div></td></tr><tr><td><div><div><p><code>--transportUpstreamProtocols</code></p></div></div></td><td><div><div><p>TLS version used for communication between DLB and Mule worker<br>Supported values: <code>TLSv1.2</code>, <code>TLSv1.3</code></p></div></div></td><td><div><div><p><code>--transportUpstreamProtocols=TLSv1.2</code></p></div></div></td></tr><tr><td><div><div><p><code>--[no-]dynamic-ips</code></p></div></div></td><td><div><div><p>Uses dynamic IPs, which are not persistent through restarts</p></div></div></td><td><div><div><p><code>--[no-]dynamic-ips</code></p></div></div></td></tr><tr><td><div><div><p><code>--verificationMode</code></p></div></div></td><td><div><div><p>Specifies the client verification mode. It can be set to <code>on</code> (verify always), <code>off</code> (don’t verify), or <code>optional</code> (verification optional).</p></div></div></td><td><div><div><p><code>--verificationMode optional</code></p></div></div></td></tr></tbody></table>

> [!NOTE] 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](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/cloudhub-api/)
> to update your certificates programmatically.

For more configuration information, see
[Configure SSL Endpoints and Certificates](https://docs.mulesoft.com/cloudhub/lb-ssl-endpoints).

### cloudhub:load-balancer:delete

\> cloudhub:load-balancer:delete \[flags\] <name>

Deletes the load balancer specified in `<name>`.

> [!WARNING] This command does not prompt twice before deleting. If you send a delete instruction,
> it does not ask for confirmation.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:load-balancer:describe

\> cloudhub:load-balancer:describe \[flags\] <name>

Displays information about the load balancer that is specified in `<name>`  
Use the flag `-o json` to get the raw JSON response of the application you specify in `<name>`  
It displays load balancer’s name, domain, its state and the Anypoint VPC Id to which the load
balancer is bound.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:load-balancer:dynamic-ips:disable

\> cloudhub:load-balancer:dynamic-ips:disable \[flags\] <name>

Disables dynamic IPs for the load balancer specified in `<name>`

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:load-balancer:dynamic-ips:enable

\> cloudhub:load-balancer:dynamic-ips:enable \[flags\] <name>

Enables dynamic IPs for the load balancer specified in `<name>`

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:load-balancer:list

\> cloudhub:load-balancer:list \[flags\]

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.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:load-balancer:mappings:add

\> cloudhub:load-balancer:mappings:add \[flags\] <name> <index> <inputUri> <appName> <appUri>
\[certificateName\]

Adds a proxy mapping rule to the load balancer specified in `<name>` in the CN passed under the
`certificateName` flag.  
If no `certificateName` is passed, Anypoint Platform CLI adds the mappings to the default SSL
endpoint.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Value</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>name</code></p></div></div></td><td><div><div><p>Name of the load balancer to which this rule is applied.</p></div></div></td><td><div><div><p><code>testloadbalancer</code></p></div></div></td></tr><tr><td><div><div><p><code>inputUri</code></p></div></div></td><td><div><div><p>Name of the URI of your input URL</p></div></div></td><td><div><div><p><code>example.com</code></p></div></div></td></tr><tr><td><div><div><p><code>appName</code></p></div></div></td><td><div><div><p>Name of the app of your output URL to which the request is forwarded</p></div></div></td><td><div><div><p><code>{app}-example</code></p></div></div></td></tr><tr><td><div><div><p><code>appUri</code></p></div></div></td><td><div><div><p>URI of the app of your output URL to which the request is forwarded</p></div></div></td><td><div><div><p>/</p></div></div></td></tr></tbody></table>

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.

If no upstream protocol is set, HTTP is used as default.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p>`--certificateName `</p></div></div></td><td><div><div><p>Certificate name</p></div></div></td><td><div><div><p><code>--certificateName exampleName</code></p></div></div></td></tr><tr><td><div><div><p><code>--upstreamProtocol &lt;protocol&gt;</code></p></div></div></td><td><div><div><p>Set the protocol used by your application to communicate internally with your load balancer<br>Supported Values: <code>http</code>, <code>https</code></p></div></div></td><td><div><div><p><code>--upstreamProtocol http</code></p></div></div></td></tr></tbody></table>

### cloudhub:load-balancer:mappings:describe

\> cloudhub:load-balancer:mappings:describe <name> \[certificateName\]

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.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:load-balancer:mappings:remove

\> cloudhub:load-balancer:mappings:remove \[flags\] <name> <index> \[certificateName\]

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` flag  
If no `certificateName` is passed, Anypoint Platform CLI removes the mappings for the default SSL
endpoint.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:load-balancer:ssl-endpoint:add

\> cloudhub:load-balancer:ssl-endpoint:add \[flags\] <name> <certificate> <privateKey>

Adds an SSL endpoint to the load balancer specified in `<name>`, using the certificate and private
key passed:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Value</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>name</code></p></div></div></td><td><div><div><p>Name for the load balancer.</p></div></div></td><td><div><div><p><code>newtestloadbalancer</code></p></div></div></td></tr><tr><td><div><div><p><code>certificate</code></p></div></div></td><td><div><div><p>Absolute path to the <code>.pem</code> file of your certificate in your local hard drive.<br>Your certificate files need to be PEM encoded and not encrypted.</p></div></div></td><td><div><div><p><code>/Users/mule/Documents/cert.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>privateKey</code></p></div></div></td><td><div><div><p>Absolute path to the <code>.pem</code> file of your private key in your local hard drive.<br>Your private key file needs to be passphraseless.</p></div></div></td><td><div><div><p><code>/Users/mule/Documents/privateKey.pem</code></p></div></div></td></tr></tbody></table>

> [!NOTE] 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](https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/cloudhub-api/)
> to update your certificates programmatically.

In addition to the [default flags](https://docs.mulesoft.com/cloudhub/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--clientCertificate</code></p></div></div></td><td><div><div><p>Client certificate file</p></div></div></td><td><div><div><p><code>--clientCertificate /Users/mule/Documents/CertificateFile.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>--crl</code></p></div></div></td><td><div><div><p>Certificate Revocation List file</p></div></div></td><td><div><div><p><code>--clientCertificate /Users/mule/Documents/crlFile.pem</code></p></div></div></td></tr><tr><td><div><div><p><code>--verificationMode</code></p></div></div></td><td><div><div><p>Specifies the client verification mode. It can be set to <code>on</code> (verify always) <code>off</code> (don’t verify) or <code>optional</code> (Verification optional).</p></div></div></td><td><div><div><p><code>--verificationMode on</code></p></div></div></td></tr></tbody></table>

For more configuration information, see
[Configure SSL Endpoints and Certificates](https://docs.mulesoft.com/cloudhub/lb-ssl-endpoints).

### cloudhub:load-balancer:ssl-endpoint:describe

\> cloudhub:load-balancer:ssl-endpoint:set-describe \[flags\] <name> <certificateName>

Shows information about the configuration of the load balancer passed in `<name>` for the
certificate specified in `<certificateName>`

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:load-balancer:ssl-endpoint:remove

\> cloudhub:load-balancer:ssl-endpoint:remove \[flags\] <name> <certificateName>

Removes the ssl certificate specified in `<certificateName>` from the load balancer specified in
`<name>`

> [!WARNING] This command does not prompt twice before deleting. If you send a delete instruction,
> it does not ask for confirmation.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:load-balancer:ssl-endpoint:set-default

\> cloudhub:load-balancer:ssl-endpoint:set-default \[flags\] <name> <certificateName>

Sets the certificate specified in `<certificateName>` as the default certificate for the load
balancer passed in `<name>`

In addition to the [default flags](https://docs.mulesoft.com/cloudhub/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--http</code></p></div></div></td><td><div><div><p>Specifies the Load balancer HTTP behavior<br>It can be set to <code>on</code> (accepts HTTP requests and forwards it to your configured default <code><em>sslendpoint</em></code>), <code>off</code> (refuses all HTTP requests), or <code>redirect</code> (redirects to HTTPS)</p></div></div></td><td><div><div><p><code>--http redirect</code></p></div></div></td></tr></tbody></table>

### cloudhub:load-balancer:start

\> cloudhub:load-balancer:start \[flags\] <name>

Starts the load balancer specified in `<name>`

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:load-balancer:stop

\> cloudhub:load-balancer:stop \[flags\] <name>

Stops the load balancer specified in `<name>`

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:load-balancer:whitelist:add

\> cloudhub:load-balancer:whitelist:add \[flags\] <name> <cidrBlock>

Adds a range of IP addresses specified in `<cidrBlock>` to the allowlist of the load balancer
specified in `<name>`.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:load-balancer:whitelist:remove

\> cloudhub:load-balancer:whitelist:remove \[flags\] <name> <cidrBlock>

Removes an IP or range of IPs specified in `<cidrBlock>` from the allowlist of the load balancer
specified in `<name>`.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

## CloudHub Anypoint VPCs

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-business-groups-add">cloudhub:vpc:business-groups:add</a></p></div></div></td><td><div><div><p>Shares an Anypoint VPC with a list of Business Groups</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-business-groups-remove">cloudhub:vpc:business-groups:remove</a></p></div></div></td><td><div><div><p>Shares an Anypoint VPC with a list of Business Groups</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-create">cloudhub:vpc:create</a></p></div></div></td><td><div><div><p>Creates a new Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-delete">cloudhub:vpc:delete</a></p></div></div></td><td><div><div><p>Deletes an existing Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-describe">cloudhub:vpc:describe</a></p></div></div></td><td><div><div><p>Show Anypoint VPC details</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-dns-servers-set">cloudhub:vpc:dns-servers:set</a></p></div></div></td><td><div><div><p>Sets the domain names that are resolved using your internal DNS servers</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-dns-servers-unset">cloudhub:vpc:dns-servers:unset</a></p></div></div></td><td><div><div><p>Clears the list domain names that are resolved using your internal DNS servers</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-environments-add">cloudhub:vpc:environments:add</a></p></div></div></td><td><div><div><p>Modifies the Anypoint VPC association to Runtime Manager environments</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-environments-remove">cloudhub:vpc:environments:remove</a></p></div></div></td><td><div><div><p>Modifies the Anypoint VPC association to Runtime Manager environments</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-firewall-rules-add">cloudhub:vpc:firewall-rules:add</a></p></div></div></td><td><div><div><p>Adds a firewall rule for Mule applications in this Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-firewall-rules-describe">cloudhub:vpc:firewall-rules:describe</a></p></div></div></td><td><div><div><p>Shows firewall rule for Mule applications in this Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-firewall-rules-remove">cloudhub:vpc:firewall-rules:remove</a></p></div></div></td><td><div><div><p>Removes a firewall rule for Mule applications in this Anypoint VPC</p></div></div></td></tr><tr><td><div><div><p><a href="https://docs.mulesoft.com/anypoint-cli/latest/cloudhub-vpc#cloudhub-vpc-list">cloudhub:vpc:list</a></p></div></div></td><td><div><div><p>Lists all Anypoint VPCs</p></div></div></td></tr></tbody></table>

### cloudhub:vpc:business-groups:add

\> cloudhub:vpc:business-groups:add \[flags\] <vpc> <businessGroups...>

Assigns the Anypoint VPC defined in `<vpc>` to the business group(s) passed as argument(s)
thereafter

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:vpc:business-groups:remove

\> cloudhub:vpc:business-groups:remove \[flags\] <vpc> <businessGroups...>

Removes the Anypoint VPC defined in `<vpc>` from the business group(s) passed as argument(s)
thereafter

> [!WARNING] 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 the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:vpc:create

\> cloudhub:vpc:create \[flags\] <name> <region> <cidrBlock> \[environments...\]

Creates an Anypoint VPC using the name in `<name>`, in the region specified in `<region>`, with the
[size](https://docs.mulesoft.com/cloudhub/vpc-provisioning-concept#faq_how_to_size_vpc) passed in `<cidrBlock>` in the form of a
Classless Inter-Domain Routing (CIDR) block, using
[CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#IPv4_CIDR_blocks) and
associates it to the [environments](https://docs.mulesoft.com/access-management/environments) passed as argument(s)
thereafter.

> [!NOTE] 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](#cloudhub-vpc-business-groups-add) command.

This command accepts the `--default` flag. When passed, the Anypoint VPC is created as the default
Anypoint VPC for the selected environment.

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:vpc:delete

\> cloudhub:vpc:delete <name>

Deletes the Anypoint VPC specified in `<name>`

> [!WARNING] This command does not prompt twice before deleting. If you send a delete instruction,
> it does not ask for confirmation.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:vpc:describe

\> cloudhub:vpc:describe \[flags\] <name>

Displays information about the Anypoint VPC that is specified in `<name>`

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:vpc:dns-servers:set

\> cloudhub:vpc:dns-servers:set \[flags\] <vpc>

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.

> [!NOTE] 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.

In addition to the [default flags](https://docs.mulesoft.com/cloudhub/#default-options), this command accepts the following flags:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flag</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>--domain</code></p></div></div></td><td><div><div><p>A domain to resolve on the special DNS server list<br>Can be specified multiple times</p></div></div></td><td><div><div><p><code>--domain example.com</code></p></div></div></td></tr><tr><td><div><div><p><code>--server</code></p></div></div></td><td><div><div><p>IP address for a DNS server to resolve special domains on<br>Can be specified up to 3 times</p></div></div></td><td><div><div><p><code>--server 192.168.1.10</code></p></div></div></td></tr></tbody></table>

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](#cloudhub-vpc-dns-servers-unset)
command.

### cloudhub:vpc:dns-servers:unset

\> cloudhub:vpc:dns-servers:unset \[flags\] <vpc>

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 the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:vpc:environments:add

\> cloudhub:vpc:environments:add \[flags\] <vpc> \[environments...\]

Assigns the Anypoint VPC defined in `<vpc>` to the environment(s) passed as argument(s) thereafter
The `--default` flag 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 accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:vpc:environments:remove

\> cloudhub:vpc:environments:remove \[flag\] <vpc> \[environments...\]

Removes the Anypoint VPC defined in `<vpc>` from the environment(s) passed as argument(s) thereafter

This command accepts the `--default` flag, that removes this Anypoint VPC as the default Anypoint
VPC for the environment.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:vpc:firewall-rules:add

\> cloudhub:vpc:firewall-rules:add \[flags\] <vpc> <cidrBlock> <protocol> <fromPort> \[toPort\]

Adds a firewall rule to the Anypoint VPC defined in `<vpc>` using the values set in the variables:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Value</th><th>Description</th><th>Example</th></tr></thead><tbody><tr><td><div><div><p><code>vpc</code></p></div></div></td><td><div><div><p>Name of the Anypoint VPC to which this load balancer is bound<br>If your Anypoint VPC name contains spaces, you need to pass it between ´"´ characters</p></div></div></td><td><div><div><p><code>vpc-demo</code></p></div></div></td></tr><tr><td><div><div><p><code>cidrBlock</code></p></div></div></td><td><div><div><p>IP address in CIDR notation for the firewall to allow</p></div></div></td><td><div><div><p><code>192.0.1.0/27</code></p></div></div></td></tr><tr><td><div><div><p><code>protocol</code></p></div></div></td><td><div><div><p>The protocol to use in the rules. It can be <code>tcp</code> or <code>udp</code></p></div></div></td><td><div><div><p><code>tcp</code></p></div></div></td></tr><tr><td><div><div><p><code>fromPort</code></p></div></div></td><td><div><div><p>The port from which the firewall will allow requests. It can go from 0 to 65535</p></div></div></td><td><div><div><p><code>8888</code></p></div></div></td></tr><tr><td><div><div><p><code>toPort</code></p></div></div></td><td><div><div><p><strong>optional</strong> In case a port range is needed, the <code>fromPort</code> and <code>toPort</code> variables define such range</p></div></div></td><td><div><div><p><code>8090</code></p></div></div></td></tr></tbody></table>

> [!CAUTION] 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.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:vpc:firewall-rules:describe

\> cloudhub:vpc:firewall-rules:describe <vpc>

Describes all the firewall rules for the Anypoint VPC defined in `<vpc>`

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:vpc:firewall-rules:remove

\> cloudhub:vpc:firewall-rules:remove <vpc> <index>

Removes the firewall rule from the workers inside the Anypoint VPC specified in `<vpc>` at the index
passed in the `<index>`

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

### cloudhub:vpc:list

\> cloudhub:vpc:list \[flags\]

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

Use the `--output` flag to specify the response format. Supported values are `table` (default) and
`json`.

This command accepts the [default flags](https://docs.mulesoft.com/cloudhub/#default-options).

## See Also

- [Anypoint Platform CLI 3.x](https://docs.mulesoft.com/anypoint-cli/latest/)