---
schema_version: "1"
id: c8d0967065f52434fc5a1bfab93c577de713fac2fda62842f3338efd0295da13
title: CLI for CloudHub Dedicated Load Balancers
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/anypoint-cli/3.x/cloudhub-dlb.md
canonical_url: https://docs.mulesoft.com/anypoint-cli/3.x/cloudhub-dlb
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 5751270d6f9834c895815480929671744235535dea55bfbf7805dfb3c2487ac4
description: MuleSoft Documentation Site
release: 3.x
latest: false
---
---
product: Anypoint CLI
version: 3.x
---

# CLI for CloudHub Dedicated Load Balancers

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

> [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality.
> We maintained certain terms to avoid any effect on customer implementations.

<table><colgroup><col> <col></colgroup><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><a href="#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="#cloudhub-load-balancer-describe">cloudhub load-balancer describe</a></p></div></div></td><td><div><div><p>Show load balancer details</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-describe-json">cloudhub load-balancer describe-json</a></p></div></div></td><td><div><div><p>Show load balancer details in raw JSON response</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-create">cloudhub load-balancer create</a></p></div></div></td><td><div><div><p>Create a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="#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="#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="#cloudhub-load-balancer-delete">cloudhub load-balancer delete</a></p></div></div></td><td><div><div><p>Delete a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-ssl-endpoint-add">cloudhub load-balancer ssl-endpoint add</a></p></div></div></td><td><div><div><p>Add an additional certificate to an existing load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-ssl-endpoint-remove">cloudhub load-balancer ssl-endpoint remove</a></p></div></div></td><td><div><div><p>Remove a certificate from a load balancer</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-ssl-endpoint-set-default">cloudhub load-balancer ssl-endpoint set-default</a></p></div></div></td><td><div><div><p>Set the default certificate that the load balancer will serve</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-ssl-endpoint-describe">cloudhub load-balancer ssl-endpoint describe</a></p></div></div></td><td><div><div><p>Show the load balancer configuration for a particular certificate</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-whitelist-add">cloudhub load-balancer whitelist add</a></p></div></div></td><td><div><div><p>Add an IP or range of IPs to the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-whitelist-remove">cloudhub load-balancer whitelist remove</a></p></div></div></td><td><div><div><p>Remove an IP or range of IPs from the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-allowlist-add">cloudhub load-balancer allowlist add</a></p></div></div></td><td><div><div><p>Add an IP or range of IPs to the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-allowlist-remove">cloudhub load-balancer allowlist remove</a></p></div></div></td><td><div><div><p>Remove an IP or range of IPs from the load balancer allowlist</p></div></div></td></tr><tr><td><div><div><p><a href="#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. If no <code>certificateName</code> is given, the mappings for the default SSL endpoint are shown</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-mappings-add">cloudhub load-balancer mappings add</a></p></div></div></td><td><div><div><p>Add a proxy mapping rule at the specified index. If no <code>certificateName</code> is given, the mappings for the default SSL endpoint are shown</p></div></div></td></tr><tr><td><div><div><p><a href="#cloudhub-load-balancer-mappings-remove">cloudhub load-balancer mappings remove</a></p></div></div></td><td><div><div><p>Remove a proxy mapping rule. If no <code>certificateName</code> is given, the mappings for the default SSL endpoint are shown.</p></div></div></td></tr><tr><td><div><div><p><a href="#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="#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="#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="#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>

## 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.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</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.

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

<table><colgroup><col> <col></colgroup><thead><tr><th>Option</th><th>Description</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. 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></tr><tr><td><div><div><p><code>clientCertificate</code></p></div></div></td><td><div><div><p>Client certificate file</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></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></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></tr><tr><td><div><div><p><code>--transportDownstreamProtocols=TLSv1.2</code></p></div></div></td><td><div><div><p><code>--transportUpstreamProtocols</code></p></div></div></td></tr><tr><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>dynamic-ips</code></p></div></div></td><td><div><div><p>Uses dynamic IPs, which are not persistent through restarts</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 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>`.

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

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Option</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.

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

<table><colgroup><col> <col></colgroup><thead><tr><th>Option</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p>clientCertificate</p></div></div></td><td><div><div><p>Client certificate file</p></div></div></td></tr><tr><td><div><div><p>verificationMode</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></tr><tr><td><div><div><p>crl</p></div></div></td><td><div><div><p>Certificate Revocation List file</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 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>`.

> [!WARNING] 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:

<table><colgroup><col> <col></colgroup><thead><tr><th>Option</th><th>Description</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</p></div></div></td></tr></tbody></table>

## 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>`.

> [!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).

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>`.

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

> [!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).

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`

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

> [!WARNING] 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`

> [!NOTE] 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> <inputUri> <appName> <appUri>
\[certificateName\]

This command adds a proxy mapping rule to the load balancer specified in `<name>` in the CN passed
under the `certificateName` option.  
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>Option</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>example.com</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.

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.

<table><colgroup><col> <col></colgroup><thead><tr><th>Option</th><th>Description</th></tr></thead><tbody><tr><td><div><div><p><code>--upstreamProtocol &lt;protocol&gt;</code></p></div></div></td><td><div><div><p>Look for upstream applications in HTTP port 8091 or HTTPS port 8092. Supported Values: <code>http</code>, <code>https</code></p></div></div></td></tr><tr><td><div><div><p><code>--certificateName &lt;certificate name&gt;</code></p></div></div></td><td><div><div><p>Optional parameter</p></div></div></td></tr></tbody></table>

## 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`.