+
+

CLI for 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.

Was this article helpful?

๐Ÿ’™ Thanks for your feedback!

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