CLI for CloudHub Dedicated Load Balancers
| Command | Description |
|---|---|
Lists all load balancers in an organization |
|
Shows load balancer details |
|
Creates a load balancer |
|
Starts a load balancer |
|
Stops a load balancer |
|
Deletes a load balancer |
|
Adds an additional certificate to an existing load balancer |
|
Removes a certificate from a load balancer |
|
Sets the default certificate that the load balancer will serve |
|
Shows the load balancer configuration for a particular certificate |
|
Adds an IP or range of IPs to the load balancer allowlist |
|
Removes an IP or range of IPs from the load balancer allowlist |
|
Lists the proxy mapping rules for a load balancer. If no |
|
Adds a proxy mapping rule at the specified index. If no |
|
Removes a proxy mapping rule. If no |
|
Enables dynamic IPs |
|
Disables dynamic IPs |
cloudhub:load-balancer:list
> cloudhub:load-balancer:list [flags]
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 has the --output flag. Use the --output flag to specify the response format. Supported values are table (default) and json.
This command also accepts the default flag --help.
cloudhub:load-balancer:describe
> cloudhub:load-balancer:describe [flags] <name>
This command 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.
This command has the --output flag. Use the --output flag to specify the response format. Supported values are table (default) and json.
This command also accepts the default flag --help.
cloudhub:load-balancer:create
> cloudhub:load-balancer:create [flags] <vpc> <name> <certificate> <privateKey>
This command creates a load balancer using the specified values in the variables.
| Value | Description | Example |
|---|---|---|
|
Name of the Anypoint VPC to which this load balancer is bound. |
|
|
Name for the load balancer. |
|
|
Absolute path to the |
|
|
Absolute path to the |
|
|
The name for the load balancer that you pass in |
Besides the default --help flag, this command also accepts:
| Flag | Description |
|---|---|
|
Specifies the Load balancer HTTP behavior. It can be set to |
|
Client certificate file |
|
Specifies the client verification mode. It can be set to |
|
Certificate revocation list file |
|
Supports TLSv1 in addition to TLSv1.1 and TLSv1.2 |
|
Uses dynamic IPs, which are not persistent through restarts |
| CloudHub does not implement the Online Certificate Status Protocol (OCSP). To keep your certification revocation list up to date, it’s recommended to use the CloudHub API to update your certificates programmatically. |
For more configuration information, see Configure SSL Endpoints and Certificates.
cloudhub:load-balancer:start
> cloudhub:load-balancer:start [flags] <name>
This command starts the load balancer specified in <name>.
This command accepts only the default flag --help.
cloudhub:load-balancer:stop
> cloudhub:load-balancer:stop [flags] <name>
This command stops the load balancer specified in <name>.
This command accepts only the default flag --help.
cloudhub:load-balancer:delete
> cloudhub:load-balancer:delete [flags] <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 accepts only the default flag --help.
cloudhub:load-balancer:ssl-endpoint:add
> cloudhub:load-balancer:ssl-endpoint:add [flags] <name> <certificate> <privateKey>
This command adds an SSL endpoint to the load balancer specified in <name>, using the certificate and private key passed.
| Value | Description | Example |
|---|---|---|
|
Name for the load balancer. |
|
|
Absolute path to the |
|
|
Absolute path to the |
|
| CloudHub does not implement the Online Certificate Status Protocol (OCSP). To keep your certification revocation list up to date, it’s recommended to use the CloudHub API to update your certificates programmatically. |
Besides the default --help flag, this command also accepts:
| Flag | Description |
|---|---|
|
Client certificate file |
|
Specifies the client verification mode. It can be set to |
|
Certificate Revocation List file |
|
Supports TLSv1 in addition to TLSv1.1 and TLSv1.2 |
For more configuration information, see Configure SSL Endpoints and Certificates.
cloudhub:load-balancer:ssl-endpoint:remove
> cloudhub:load-balancer:ssl-endpoint:remove [flags] <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 accepts only the default flag --help.
cloudhub:load-balancer:ssl-endpoint:set-default
> cloudhub:load-balancer:ssl-endpoint:set-default [flags] <name> <certificateName>
This command sets the certificate specified in <certificateName> as the default certificate for the load balancer passed in <name>.
Besides the default --help flag, this command also accepts:
| Flag | Description |
|---|---|
|
Specifies the Load balancer HTTP behavior |
cloudhub:load-balancer:ssl-endpoint:describe
> cloudhub:load-balancer:ssl-endpoint:set-describe [flags] <name> <certificateName>
This command shows information about the configuration of the load balancer passed in <name> for the the certificate specified in <certificateName>.
This command has the --output flag. Use the --output flag to specify the response format. Supported values are table (default) and json
This command also accepts the default flag --help.
cloudhub:load-balancer:allowlist:add
> cloudhub:load-balancer:allowlist:add [flags] <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. |
This command accepts only the default flag --help.
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 accepts only the default flag --help.
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 has the --output flag. Use the --output flag to specify the response format. Supported values are table (default) and json.
This command also accepts the default flag --help.
cloudhub:load-balancer:mappings:add
> cloudhub:load-balancer:mappings:add [flags] <name> <index> <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 flag.
If no certificateName is passed, Anypoint Platform CLI adds the mappings to the default SSL endpoint.
| Value | Description | Example |
|---|---|---|
|
Name of the load balancer to which this rule is applied. |
|
|
Name of the URI of your input URL |
example.com |
|
Name of the app of your output URL to which the request is forwarded |
|
|
URI of the app of your output URL to which the request is forwarded |
/ |
For the values in the example above, for an input call to my-superapp.api.example.com/status?limit=10, the endpoint my-superapp-example: /status?limit=10 will be called for the application.
This command also has the --upstreamProtocol flag.
The --upstreamProtocol flag 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.
| Flag | Description |
|---|---|
|
Look for upstream applications in HTTP port 8091 or HTTPS port 8092.
Supported Values: |
|
Optional flag |
cloudhub:load-balancer:mappings:remove
> cloudhub:load-balancer:mappings:remove [flags] <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 flag.
This command accepts only the default flag --help.
If no certificateName is passed, Anypoint Platform CLI removes the mappings for the default SSL endpoint.