linode-nodebalancer man page
linode-nodebalancer — command-line interface for Linode NodeBalancers
Synopsis
linode-nodebalancer [-a action] [action-options...] [options...]
-a create, --action create create a NodeBalancer
-a rename, --action rename rename a NodeBalancer
-a throttle, --action throttle set a client connections per second cap
-a delete, --action delete delete a NodeBalancer
-a list, --action list list info about NodeBalancers
-a show, --action show show detailed info about a NodeBalancer
-a config-create, --action config-create create a NodeBalancer config
-a config-update, --action config-update update a NodeBalancer config
-a config-delete, --action config-delete delete a NodeBalancer config
-a config-list, --action config-list list info about a NodeBalancer config
-a config-show, --action config-show show detailed info about a NodeBalancer config
-a node-create, --action node-create create a NodeBalancer node
-a node-update, --action node-update update a NodeBalancer node
-a node-delete, --action node-delete delete a NodeBalancer node
-a node-list, --action node-list list info about a NodeBalancer node
-a node-show, --action node-show show detailed info about a NodeBalancer node
--api-key=KEY your user's API key
-h, --help display this help and exit
-j, --json return output in JSON format
-u, --username=USER username for Linode CLI config file
Options
- -a, --action
An action to perform on Linode NodeBalancers. One of: create, rename, throttle, delete, list, show, config-create, config-update, config-delete, config-list, config-show, node-create, node-update, node-delete, node-list, node-show.
- --api-key
API key to use when communicating with the Linode API. The API key can also be set using an environment variable (LINODE_API_KEY). Alternatively, you can specify the API key in a .linodecli file in the working user's home directory, using the format `api-key foobar`.
- -u, --username:
Optional. Allows users to specify the username, if using with multiple accounts and configuration files.
- -j, --json:
Optional. JSON output.
- -h, --help
Displays help documentation.
Actions
Create
- Create a NodeBalancer.
- -l --label
Required. The name of the NodeBalancer.
- -L --location
Required. The datacenter to use for deployment. Locations are Dallas, Fremont, Atlanta, Newark, London, and Tokyo.
- -t --payment-term
Optional. Payment term, one of 1, 12, or 24 (months). Default: 1. This is ignored when using metered.
Rename
- Rename a NodeBalancer.
- -l --label
Required. The name of the NodeBalancer.
- -n --new-label
Required. The new name for the NodeBalancer.
Throttle
- Adjust the connections per second allowed per client IP for a NodeBalancer, to help mitigate abuse.
- -l --label
Required. The name of the NodeBalancer.
- -c --connections
Required. To help mitigate abuse, throttle connections per second, per client IP. 0 to disable. Max of 20.
Delete
- Delete a NodeBalancer.
- -l --label
Required. The NodeBalancer to delete.
List
- List information about one or more NodeBalancers.
- -l --label
Optional. A specific NodeBalancer to list.
Show
- Display detailed information about one or more NodeBalancers.
- -l --label
Required. A specific NodeBalancer to list.
Config-Create
- Create a NodeBalancer config (port).
- -l --label
Required. The NodeBalancer name to add the config/port.
- -p --port
Optional. The NodeBalancer config port to bind on (1-65534). Default is 80.
- -L --protocol
Optional. Options are 'tcp', 'http', and 'https'. Default is 'http'.
- -A --algorithm
Optional. Balancing algorithm. Options are 'roundrobin', 'leastconn', and 'source'. Default is 'roundrobin'.
- -S --stickiness
Optional. Session persistence. Options are 'none', 'table', and 'http_cookie'. Default is 'table'.
- -H --check-health
Optional. Perform active health checks on the backend nodes. One of 'connection', 'http', 'http_body'. Default is 'connection'.
- -I --check-interval
Optional. Seconds between health check probes (2-3600). Default is 5.
- -T --check-timeout
Optional. Seconds to wait before considering the probe a failure (1-30). Must be less than check_interval. Default is 3.
- -X --check-attempts
Optional. Number of failed probes before taking a node out of rotation (1-30). Default is 2.
- -P --check-path
Optional. When check-health='http', the path to request. Default is '/'.
- -B --check-body
Optional. When check-health='http_body', a regex against the expected result body.
- -C --ssl-cert
Optional. SSL certificate served by the NodeBalancer when the protocol is 'https'.
- -K --ssl-key
Optional. Unpassphrased private key for the SSL certificate when protocol is 'https'.
Config-Update
- Update a NodeBalancer config (port).
- -l --label
Required. The NodeBalancer name.
- -p --port
Required. The NodeBalancer config port.
- -N --new-port
Optional. Changes the config port to bind on (1-65534).
- -L --protocol
Optional. Protocol. Options are 'tcp', 'http', and 'https'.
- -A --algorithm
Optional. Balancing algorithm. Options are 'roundrobin', 'leastconn', and 'source'.
- -S --stickiness
Optional. Session persistence. Options are 'none', 'table', and 'http_cookie'.
- -H --check-health
Optional. Perform active health checks on the backend nodes. One of 'connection', 'http', 'http_body'.
- -I --check-interval
Optional. Seconds between health check probes (2-3600).
- -T --check-timeout
Optional. Seconds to wait before considering the probe a failure (1-30). Must be less than check_interval.
- -X --check-attempts
Optional. Number of failed probes before taking a node out of rotation (1-30).
- -P --check-path
Optional. When check-health='http', the path to request.
- -B --check-body
Optional. When check-health='http_body', a regex against the expected result body.
- -C --ssl-cert
Optional. SSL certificate served by the NodeBalancer when the protocol is 'https'.
- -K --ssl-key
Optional. Unpassphrased private key for the SSL certificate when protocol is 'https'.
Config-Delete
- Delete a NodeBalancer config (port).
- -l --label
The NodeBalancer name.
- -p --port
The NodeBalancer config port to delete.
Config-List
- List all configs (ports) for a specific NodeBalancer.
- -l --label
Required. A specific NodeBalancer to list.
Config-Show
- Display detailed information about a specific NodeBalancer config/port.
- -l --label
Required. A specific NodeBalancer to show.
- -p --port
Required. The NodeBalancer port or config port to show.
Node-Create
- Create a NodeBalancer Node.
- -l --label
Required. The label (name) of the NodeBalancer.
- -p --port
Required. The NodeBalancer port or config port.
- -n --name
Required. The Node name to update.
- -A --address
Required. The address:port combination used to communicate with this Node.
- -W --weight
Optional. Load balancing weight, 1-255. Higher means more connections. Default is 100.
- -M --mode
Optional. The connections mode to use. Options are 'accept', 'reject', and 'drain'. Default is 'accept'.
Node-Update
- Update a NodeBalancer Node.
- -l --label
Required. The label (name) of the NodeBalancer.
- -p --port
Required. The NodeBalancer port or config port.
- -n --name
Required. The Node name to update.
- -N --new-name
Optional. New name for the Node (rename).
- -A --address
Optional. The address:port combination used to communicate with this Node.
- -W --weight
Optional. Load balancing weight, 1-255. Higher means more connections.
- -M --mode
Optional. The connections mode to use. Options are 'accept', 'reject', and 'drain'.
Node-Delete
- Delete a NodeBalancer Node.
- -l --label
The NodeBalancer name.
- -p --port
The NodeBalancer port or config port.
- -n --name
The specific Node name to delete.
Node-List
- List all Nodes for a specific NodeBalancer port.
- -l --label
Required. A specific NodeBalancer.
- -p --port
Required. The NodeBalancer port or config port.
Node-Show
- Show detailed information about a specific Node for a specific NodeBalancer port.
- -l --label
Required. A specific NodeBalancer.
- -p --port
Required. The NodeBalancer port or config port.
- -n --name
Required. The name of the Node to show.
Copyright/License
Copyright 2015 Linode, LLC. Linode CLI is made available under the terms of the Perl Artistic License, or GPLv2 at the recipients discretion.
Perl Artistic License
Read it at <http://dev.perl.org/licenses/artistic.html>.
GNU General Public License (GPL) Version 2
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/
See the full license at <http://www.gnu.org/licenses/>.