linode-cli-nodebalancers

manages Linode NodeBalancers

TLDR

List node balancers

$ linode-cli nodebalancers list

Create node balancer

$ linode-cli nodebalancers create --region [us-east] --label [my-balancer]

View node balancer

$ linode-cli nodebalancers view [nodebalancer_id]

Add a port configuration (e.g. HTTP on port 80)

$ linode-cli nodebalancers config-create [nodebalancer_id] --port [80] --protocol [http] --algorithm [roundrobin] --check [http] --check_path [/]

List configs

$ linode-cli nodebalancers configs-list [nodebalancer_id]

Add a backend node

$ linode-cli nodebalancers node-create [nodebalancer_id] [config_id] --address [192.168.1.1:80] --label [web1]

List backend nodes and their health status

$ linode-cli nodebalancers nodes-list [nodebalancer_id] [config_id]

Delete node balancer

$ linode-cli nodebalancers delete [nodebalancer_id]

SYNOPSIS

linode-cli nodebalancers action [ids] [options]

linode-cli nodebalancers manages Linode (Akamai Cloud) NodeBalancers, managed load balancers that distribute incoming traffic across backend Linodes.Each NodeBalancer has one or more configs, one per listening port, which define the protocol, algorithm, session stickiness, TLS termination and health checks. Each config has its own set of backend nodes. Run linode-cli nodebalancers action --help to see every argument for an action.

PARAMETERS

list, ls

List all NodeBalancers.

create

Create a NodeBalancer (--region is required).

view ID

View NodeBalancer details.

update ID

Update a NodeBalancer (label, tags, clientconnthrottle).

delete, rm ID

Delete a NodeBalancer.

types

List NodeBalancer types and pricing.

firewalls ID

Update the firewalls assigned to a NodeBalancer.

configs-list ID

List port configurations.

config-create ID

Create a port configuration.

config-view, config-update, config-delete ID CONFIGID_

View, update or delete a configuration.

config-rebuild ID CONFIGID_

Replace a configuration and its full set of nodes in one call.

nodes-list ID CONFIGID_

List backend nodes of a configuration.

node-create ID CONFIGID_

Add a backend node.

node-view, node-update, node-delete ID CONFIGID NODEID

View, update or delete a backend node.

vpcs-list, vpc-view ID

Show VPC configurations of a NodeBalancer.

--region REGION

Datacenter region.

--label NAME

NodeBalancer, or node, label.

--tags TAG

Tag to apply; repeat for several.

--client_conn_throttle N

Throttle new connections per second per client IP (0 disables).

--firewall_id ID

Firewall to assign at creation.

--port PORT

Port the configuration listens on.

--protocol PROTO

http, https, tcp or udp.

--algorithm ALG

Balancing algorithm: roundrobin, leastconn or source (UDP also supports ring_hash).

--stickiness MODE

Session stickiness: none, table, http_cookie (UDP: session, source_ip).

--check TYPE

Active health check: none, connection, http or http_body.

--check_path PATH

URL path used by HTTP health checks.

--ssl_cert, --ssl_key PEM

Certificate and private key for HTTPS configurations.

--address IP:PORT

Backend node address (private IPv4, public IPv6 or VPC IPv4 plus port).

--mode MODE

Node mode: accept, reject, drain or backup.

--weight N

Node weight (1-255).

--help

Display help information for an action.

INSTALL

brew install linode-cli

nix profile install nixpkgs#linode-cli

CAVEATS

Requires a configured API token (linode-cli configure or LINODE_CLI_TOKEN). NodeBalancers are billed hourly up to a monthly cap. Backend nodes should use private IPs in the same region. Available flags are generated from the Linode API specification and change with CLI updates.

HISTORY

linode-cli nodebalancers is part of the Linode CLI, a Python tool generated from the Linode API v4 OpenAPI specification. Linode was acquired by Akamai in 2022 and the service is now branded Akamai Cloud.

RESOURCES

Source code · Documentation