NodeBalancer

This section details NodeBalancer-related Linode CLI commands.

list

Aliases: ls

Returns a paginated list of NodeBalancers you have access to.

Usage

The format accepted by this command.

linode-cli nodebalancers list [-h] [--ipv4 ipv4]
    [--region region] [--tags [tags] ] [--label label]
    [--order-by {ipv4,region,tags,label}] [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli nodebalancers list

Filterable Attributes

Arguments used to define a filter for response entries.

Name	Type	Description
--ipv4	str	This NodeBalancer’s public IPv4 address.
--label	str	This NodeBalancer’s label.
--region	str	The Region where this NodeBalancer is located.
--tags	[]str	An array of Tags applied to this object.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
client_conn_throttle	int	N/A	Throttle connections per second.
created	str	2018-01-01T00:01:01	When this NodeBalancer was created.
hostname	str	192.0.2.1.ip…rcontent.com	This NodeBalancer’s hostname, beginning with its IP address and ending with _.ip.linodeusercontent.com_.
id	int	12345	This NodeBalancer’s unique ID.
ipv4	str	203.0.113.1	This NodeBalancer’s public IPv4 address.
ipv6	str	N/A	This NodeBalancer’s public IPv6 address.
label	str	balancer12345	This NodeBalancer’s label.
region	str	us-east	The Region where this NodeBalancer is located.
tags	[]str	[“example ta…er example”]	An array of Tags applied to this object.
updated	str	2018-03-01T00:01:01	When this NodeBalancer was last updated.

transfer

Name	Type	Example	Description
transfer.in	float	28.9120082855225	The total outbound transfer, in MB, used for this NodeBalancer this month.
transfer.out	float	3.54877281188965	The total inbound transfer, in MB, used for this NodeBalancer this month.
transfer.total	float	32.4607810974121	The total transfer, in MB, used by this NodeBalancer this month.

---

view

Returns a single NodeBalancer you can access.

Usage

The format accepted by this command.

linode-cli nodebalancers view [-h] [--label label]
    [--region region] [--ipv4 ipv4] [--tags [tags] ]
    [--order-by {label,region,ipv4,tags}] [--order {asc,desc}]
    nodeBalancerId

Sample

Examples of how this command might be used.

linode-cli nodebalancers view 12345

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
nodeBalancerId	int	The ID of the NodeBalancer to access.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
client_conn_throttle	int	N/A	Throttle connections per second.
created	str	2018-01-01T00:01:01	When this NodeBalancer was created.
hostname	str	192.0.2.1.ip…rcontent.com	This NodeBalancer’s hostname, beginning with its IP address and ending with _.ip.linodeusercontent.com_.
id	int	12345	This NodeBalancer’s unique ID.
ipv4	str	203.0.113.1	This NodeBalancer’s public IPv4 address.
ipv6	str	N/A	This NodeBalancer’s public IPv6 address.
label	str	balancer12345	This NodeBalancer’s label.
region	str	us-east	The Region where this NodeBalancer is located.
tags	[]str	[“example ta…er example”]	An array of Tags applied to this object.
updated	str	2018-03-01T00:01:01	When this NodeBalancer was last updated.

transfer

Name	Type	Example	Description
transfer.in	float	28.9120082855225	The total outbound transfer, in MB, used for this NodeBalancer this month.
transfer.out	float	3.54877281188965	The total inbound transfer, in MB, used for this NodeBalancer this month.
transfer.total	float	32.4607810974121	The total transfer, in MB, used by this NodeBalancer this month.

---

create

Creates a NodeBalancer in the requested Region.

Usage

The format accepted by this command.

linode-cli nodebalancers create [-h] [--label label]
    [--tags tags] [--client_conn_throttle client_conn_throttle]
    [--region region] [--firewall_id firewall_id]
    [--configs configs] [--configs.check_path check_path]
    [--configs.ssl_key ssl_key]
    [--configs.check_passive check_passive]
    [--configs.nodes nodes] [--configs.nodes.address address]
    [--configs.nodes.label label] [--configs.nodes.weight weight]
    [--configs.nodes.mode mode] [--configs.algorithm algorithm]
    [--configs.check_timeout check_timeout]
    [--configs.protocol protocol]
    [--configs.stickiness stickiness]
    [--configs.cipher_suite cipher_suite]
    [--configs.check_body check_body]
    [--configs.ssl_cert ssl_cert]
    [--configs.check_attempts check_attempts]
    [--configs.port port]
    [--configs.proxy_protocol proxy_protocol]
    [--configs.check_interval check_interval]
    [--configs.check check]

Sample

Examples of how this command might be used.

linode-cli nodebalancers create \
    --region us-east \
    --label balancer12345 \
    --client_conn_throttle 0

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--region *	str	us-east	The ID of the Region to create this NodeBalancer in.
--client_conn_throttle	int	N/A	Throttle connections per second.
--configs (section)	json	N/A	A request object representing a NodeBalancer Config, including Nodes.
--firewall_id	int	N/A	The ID of the Firewall to assign to the NodeBalancer.
--label	str	balancer12345	This NodeBalancer’s label.
--tags	[]str	test	An array of Tags applied to this object.

configs

Name	Type	Example	Description
--configs.algorithm	str	roundrobin	What algorithm this NodeBalancer should use for routing traffic to backends.
--configs.check	str	http_body	The type of check to perform against backends to ensure they are serving requests.
--configs.check_attempts	int	3	How many times to attempt a check before considering a backend to be down.
--configs.check_body	str	it works	This value must be present in the response body of the check in order for it to pass.
--configs.check_interval	int	90	How often, in seconds, to check that backends are up and serving requests.
--configs.check_passive	bool	true	If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.
--configs.check_path	str	/test	The URL path to check on each backend.
--configs.check_timeout	int	10	How long, in seconds, to wait for a check attempt before considering it failed.
--configs.cipher_suite	str	recommended	What ciphers to use for SSL connections served by this NodeBalancer.
--configs.nodes (section)	json	N/A	A NodeBalancerNode represents a single backend serving requests for a single port of a NodeBalancer.
--configs.port	int	80	The port this Config is for.
--configs.protocol	str	http	The protocol this port is configured to serve.
--configs.proxy_protocol	str	none	ProxyProtocol is a TCP extension that sends initial TCP connection information such as source/destination IPs and ports to backend devices.
--configs.ssl_cert	str	<REDACTED>	(nullable) The PEM-formatted public SSL certificate (or the combined PEM-formatted SSL certificate and Certificate Authority chain) that should be served on this NodeBalancerConfig’s port.
--configs.ssl_key	str	<REDACTED>	(nullable) The PEM-formatted private key for the SSL certificate set in the ssl_cert field.
--configs.stickiness	str	http_cookie	Controls how session stickiness is handled on this port.

configs.nodes

Name	Type	Example	Description
--configs.nodes.address	str	192.168.210.120:80	The private IP Address where this backend can be reached.
--configs.nodes.label	str	node54321	The label for this node.
--configs.nodes.mode	str	accept	The mode this NodeBalancer should use when sending traffic to this backend.
--configs.nodes.weight	int	50	Used when picking a backend to serve a request and is not pinned to a single backend yet.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
client_conn_throttle	int	N/A	Throttle connections per second.
created	str	2018-01-01T00:01:01	When this NodeBalancer was created.
hostname	str	192.0.2.1.ip…rcontent.com	This NodeBalancer’s hostname, beginning with its IP address and ending with _.ip.linodeusercontent.com_.
id	int	12345	This NodeBalancer’s unique ID.
ipv4	str	203.0.113.1	This NodeBalancer’s public IPv4 address.
ipv6	str	N/A	This NodeBalancer’s public IPv6 address.
label	str	balancer12345	This NodeBalancer’s label.
region	str	us-east	The Region where this NodeBalancer is located.
tags	[]str	[“example ta…er example”]	An array of Tags applied to this object.
updated	str	2018-03-01T00:01:01	When this NodeBalancer was last updated.

transfer

Name	Type	Example	Description
transfer.in	float	28.9120082855225	The total outbound transfer, in MB, used for this NodeBalancer this month.
transfer.out	float	3.54877281188965	The total inbound transfer, in MB, used for this NodeBalancer this month.
transfer.total	float	32.4607810974121	The total transfer, in MB, used by this NodeBalancer this month.

---

update

Updates information about a NodeBalancer you can access.

Usage

The format accepted by this command.

linode-cli nodebalancers update [-h] [--label label]
    [--client_conn_throttle client_conn_throttle] [--tags tags]
    nodeBalancerId

Sample

Examples of how this command might be used.

linode-cli nodebalancers update 12345 \
    --label balancer12345 \
    --client_conn_throttle 0

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
nodeBalancerId	int	The ID of the NodeBalancer to access.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--client_conn_throttle	int	N/A	Throttle connections per second.
--label	str	balancer12345	This NodeBalancer’s label.
--tags	[]str	example tag	An array of Tags applied to this object.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
client_conn_throttle	int	N/A	Throttle connections per second.
created	str	2018-01-01T00:01:01	When this NodeBalancer was created.
hostname	str	192.0.2.1.ip…rcontent.com	This NodeBalancer’s hostname, beginning with its IP address and ending with _.ip.linodeusercontent.com_.
id	int	12345	This NodeBalancer’s unique ID.
ipv4	str	203.0.113.1	This NodeBalancer’s public IPv4 address.
ipv6	str	N/A	This NodeBalancer’s public IPv6 address.
label	str	balancer12345	This NodeBalancer’s label.
region	str	us-east	The Region where this NodeBalancer is located.
tags	[]str	[“example ta…er example”]	An array of Tags applied to this object.
updated	str	2018-03-01T00:01:01	When this NodeBalancer was last updated.

transfer

Name	Type	Example	Description
transfer.in	float	28.9120082855225	The total outbound transfer, in MB, used for this NodeBalancer this month.
transfer.out	float	3.54877281188965	The total inbound transfer, in MB, used for this NodeBalancer this month.
transfer.total	float	32.4607810974121	The total transfer, in MB, used by this NodeBalancer this month.

---

delete

Aliases: rm

Deletes a NodeBalancer.

Usage

The format accepted by this command.

linode-cli nodebalancers delete [-h] nodeBalancerId

Sample

Examples of how this command might be used.

linode-cli nodebalancers delete 12345

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
nodeBalancerId	int	The ID of the NodeBalancer to access.

---

firewalls

View information for Firewalls assigned to this NodeBalancer.

Usage

The format accepted by this command.

linode-cli nodebalancers firewalls [-h] [--created created]
    [--id id] [--tags [tags] ] [--updated updated] [--label label]
    [--order-by {created,id,tags,updated,label}]
    [--order {asc,desc}] nodeBalancerId

Sample

Examples of how this command might be used.

linode-cli nodebalancers firewalls $nodeBalancerId

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
nodeBalancerId	int	The ID of the NodeBalancer to access.

Filterable Attributes

Arguments used to define a filter for response entries.

Name	Type	Description
--created	str	When this Firewall was created.
--id	int	The Firewall’s unique ID.
--label	str	The Firewall’s label, for display purposes only.
--tags	[]str	An array of tags applied to this object.
--updated	str	When this Firewall was last updated.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
created	str	2018-01-01T00:01:01	When this Firewall was created.
id	int	123	The Firewall’s unique ID.
label	str	firewall123	The Firewall’s label, for display purposes only.
status	str	enabled	The status of this Firewall.
tags	[]str	[“example ta…er example”]	An array of tags applied to this object.
updated	str	2018-01-02T00:01:01	When this Firewall was last updated.

rules

Name	Type	Example	Description
rules.inbound.action	str	ACCEPT	Controls whether traffic is accepted or dropped by this rule.
rules.inbound.addresses.ipv4	[]str	[“192.0.2.0/2…1.100.2/32”]	A list of IPv4 addresses or networks.
rules.inbound.addresses.ipv6	[]str	[“2001:DB8::/128”]	A list of IPv6 addresses or networks.
rules.inbound.description	str	An example fi…description.	Used to describe this rule.
rules.inbound.label	str	firewallrule123	Used to identify this rule.
rules.inbound.ports	str	22-24, 80, 443	A string representing the port or ports affected by this rule: - The string may be a single port, a range of ports, or a comma-separated list of single ports and port ranges.
rules.inbound.protocol	str	TCP	The type of network traffic affected by this rule.
rules.inbound_policy	str	DROP	The default behavior for inbound traffic.
rules.outbound.action	str	ACCEPT	Controls whether traffic is accepted or dropped by this rule.
rules.outbound.addresses.ipv4	[]str	[“192.0.2.0/2…1.100.2/32”]	A list of IPv4 addresses or networks.
rules.outbound.addresses.ipv6	[]str	[“2001:DB8::/128”]	A list of IPv6 addresses or networks.
rules.outbound.description	str	An example fi…description.	Used to describe this rule.
rules.outbound.label	str	firewallrule123	Used to identify this rule.
rules.outbound.ports	str	22-24, 80, 443	A string representing the port or ports affected by this rule: - The string may be a single port, a range of ports, or a comma-separated list of single ports and port ranges.
rules.outbound.protocol	str	TCP	The type of network traffic affected by this rule.
rules.outbound_policy	str	DROP	The default behavior for outbound traffic.

---

config-view

Returns configuration information for a single port of this NodeBalancer.

Usage

The format accepted by this command.

linode-cli nodebalancers config-view [-h] [--order-by {}]
    [--order {asc,desc}] nodeBalancerId configId

Sample

Examples of how this command might be used.

linode-cli nodebalancers config-view \
    12345 4567

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
nodeBalancerId	int	The ID of the NodeBalancer to access.
configId	int	The ID of the Config to access.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
algorithm	str	roundrobin	What algorithm this NodeBalancer should use for routing traffic to backends.
check	str	http_body	The type of check to perform against backends to ensure they are serving requests.
check_attempts	int	3	How many times to attempt a check before considering a backend to be down.
check_body	str	it works	This value must be present in the response body of the check in order for it to pass.
check_interval	int	90	How often, in seconds, to check that backends are up and serving requests.
check_passive	bool	true	If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.
check_path	str	/test	The URL path to check on each backend.
check_timeout	int	10	How long, in seconds, to wait for a check attempt before considering it failed.
cipher_suite	str	recommended	What ciphers to use for SSL connections served by this NodeBalancer.
id	int	4567	This config’s unique ID.
nodebalancer_id	int	12345	The ID for the NodeBalancer this config belongs to.
port	int	80	The port this Config is for.
protocol	str	http	The protocol this port is configured to serve.
proxy_protocol	str	none	ProxyProtocol is a TCP extension that sends initial TCP connection information such as source/destination IPs and ports to backend devices.
ssl_cert	str	<REDACTED>	The PEM-formatted public SSL certificate (or the combined PEM-formatted SSL certificate and Certificate Authority chain) that should be served on this NodeBalancerConfig’s port.
ssl_commonname	str	www.example.com	The read-only common name automatically derived from the SSL certificate assigned to this NodeBalancerConfig.
ssl_fingerprint	str	00:01:02:03:0…:10:11:12:13	The read-only SHA1-encoded fingerprint automatically derived from the SSL certificate assigned to this NodeBalancerConfig.
ssl_key	str	<REDACTED>	The PEM-formatted private key for the SSL certificate set in the ssl_cert field.
stickiness	str	http_cookie	Controls how session stickiness is handled on this port.

nodes_status

Name	Type	Example	Description
nodes_status.down	int	N/A	The number of backends considered to be “DOWN” and unhealthy.
nodes_status.up	int	4	The number of backends considered to be “UP” and healthy, and that are serving requests.

---

config-create

Creates a NodeBalancer Config, which allows the NodeBalancer to accept traffic on a new port.

Usage

The format accepted by this command.

linode-cli nodebalancers config-create [-h]
    [--check_timeout check_timeout] [--algorithm algorithm]
    [--check_passive check_passive] [--ssl_key ssl_key]
    [--check_path check_path] [--cipher_suite cipher_suite]
    [--check_body check_body] [--stickiness stickiness]
    [--protocol protocol] [--check_attempts check_attempts]
    [--port port] [--ssl_cert ssl_cert] [--check check]
    [--check_interval check_interval]
    [--proxy_protocol proxy_protocol] nodeBalancerId

Sample

Examples of how this command might be used.

linode-cli nodebalancers config-create 12345 \
    --port 443 \
    --protocol https \
    --algorithm roundrobin \
    --stickiness http_cookie \
    --check http_body \
    --check_interval 90 \
    --check_timeout 10 \
    --check_attempts 3 \
    --check_path "/test" \
    --check_body "it works" \
    --check_passive true \
    --proxy_protocol "none" \
    --ssl_cert "-----BEGIN CERTIFICATE-----
                            CERTIFICATE_INFORMATION
                            -----END CERTIFICATE-----" \
    --ssl_key "-----BEGIN PRIVATE KEY-----
                         PRIVATE_KEY_INFORMATION
                         -----END PRIVATE KEY-----" \
    --cipher_suite recommended

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
nodeBalancerId	int	The ID of the NodeBalancer to access.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--algorithm	str	roundrobin	What algorithm this NodeBalancer should use for routing traffic to backends.
--check	str	http_body	The type of check to perform against backends to ensure they are serving requests.
--check_attempts	int	3	How many times to attempt a check before considering a backend to be down.
--check_body	str	it works	This value must be present in the response body of the check in order for it to pass.
--check_interval	int	90	How often, in seconds, to check that backends are up and serving requests.
--check_passive	bool	true	If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.
--check_path	str	/test	The URL path to check on each backend.
--check_timeout	int	10	How long, in seconds, to wait for a check attempt before considering it failed.
--cipher_suite	str	recommended	What ciphers to use for SSL connections served by this NodeBalancer.
--port	int	80	The port this Config is for.
--protocol	str	http	The protocol this port is configured to serve.
--proxy_protocol	str	none	ProxyProtocol is a TCP extension that sends initial TCP connection information such as source/destination IPs and ports to backend devices.
--ssl_cert	str	<REDACTED>	(nullable) The PEM-formatted public SSL certificate (or the combined PEM-formatted SSL certificate and Certificate Authority chain) that should be served on this NodeBalancerConfig’s port.
--ssl_key	str	<REDACTED>	(nullable) The PEM-formatted private key for the SSL certificate set in the ssl_cert field.
--stickiness	str	http_cookie	Controls how session stickiness is handled on this port.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
algorithm	str	roundrobin	What algorithm this NodeBalancer should use for routing traffic to backends.
check	str	http_body	The type of check to perform against backends to ensure they are serving requests.
check_attempts	int	3	How many times to attempt a check before considering a backend to be down.
check_body	str	it works	This value must be present in the response body of the check in order for it to pass.
check_interval	int	90	How often, in seconds, to check that backends are up and serving requests.
check_passive	bool	true	If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.
check_path	str	/test	The URL path to check on each backend.
check_timeout	int	10	How long, in seconds, to wait for a check attempt before considering it failed.
cipher_suite	str	recommended	What ciphers to use for SSL connections served by this NodeBalancer.
id	int	4567	This config’s unique ID.
nodebalancer_id	int	12345	The ID for the NodeBalancer this config belongs to.
port	int	80	The port this Config is for.
protocol	str	http	The protocol this port is configured to serve.
proxy_protocol	str	none	ProxyProtocol is a TCP extension that sends initial TCP connection information such as source/destination IPs and ports to backend devices.
ssl_cert	str	<REDACTED>	The PEM-formatted public SSL certificate (or the combined PEM-formatted SSL certificate and Certificate Authority chain) that should be served on this NodeBalancerConfig’s port.
ssl_commonname	str	www.example.com	The read-only common name automatically derived from the SSL certificate assigned to this NodeBalancerConfig.
ssl_fingerprint	str	00:01:02:03:0…:10:11:12:13	The read-only SHA1-encoded fingerprint automatically derived from the SSL certificate assigned to this NodeBalancerConfig.
ssl_key	str	<REDACTED>	The PEM-formatted private key for the SSL certificate set in the ssl_cert field.
stickiness	str	http_cookie	Controls how session stickiness is handled on this port.

nodes_status

Name	Type	Example	Description
nodes_status.down	int	N/A	The number of backends considered to be “DOWN” and unhealthy.
nodes_status.up	int	4	The number of backends considered to be “UP” and healthy, and that are serving requests.

---

config-update

Updates the configuration for a single port on a NodeBalancer.

Usage

The format accepted by this command.

linode-cli nodebalancers config-update [-h]
    [--ssl_cert ssl_cert] [--check_attempts check_attempts]
    [--port port] [--check_interval check_interval]
    [--proxy_protocol proxy_protocol] [--check check]
    [--ssl_key ssl_key] [--check_passive check_passive]
    [--check_path check_path] [--check_timeout check_timeout]
    [--algorithm algorithm] [--protocol protocol]
    [--check_body check_body] [--cipher_suite cipher_suite]
    [--stickiness stickiness] nodeBalancerId configId

Sample

Examples of how this command might be used.

linode-cli nodebalancers config-update \
    12345 4567 \
    --port 443 \
    --protocol https \
    --algorithm roundrobin \
    --stickiness http_cookie \
    --check http_body \
    --check_interval 90 \
    --check_timeout 10 \
    --check_attempts 3 \
    --check_path "/test" \
    --check_body "it works" \
    --check_passive true \
    --proxy_protocol "none" \
    --ssl_cert "-----BEGIN CERTIFICATE-----
                            CERTIFICATE_INFORMATION
                            -----END CERTIFICATE-----" \
    --ssl_key "-----BEGIN PRIVATE KEY-----
                         PRIVATE_KEY_INFORMATION
                         -----END PRIVATE KEY-----" \
    --cipher_suite recommended

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
nodeBalancerId	int	The ID of the NodeBalancer to access.
configId	int	The ID of the Config to access.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--algorithm	str	roundrobin	What algorithm this NodeBalancer should use for routing traffic to backends.
--check	str	http_body	The type of check to perform against backends to ensure they are serving requests.
--check_attempts	int	3	How many times to attempt a check before considering a backend to be down.
--check_body	str	it works	This value must be present in the response body of the check in order for it to pass.
--check_interval	int	90	How often, in seconds, to check that backends are up and serving requests.
--check_passive	bool	true	If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.
--check_path	str	/test	The URL path to check on each backend.
--check_timeout	int	10	How long, in seconds, to wait for a check attempt before considering it failed.
--cipher_suite	str	recommended	What ciphers to use for SSL connections served by this NodeBalancer.
--port	int	80	The port this Config is for.
--protocol	str	http	The protocol this port is configured to serve.
--proxy_protocol	str	none	ProxyProtocol is a TCP extension that sends initial TCP connection information such as source/destination IPs and ports to backend devices.
--ssl_cert	str	<REDACTED>	(nullable) The PEM-formatted public SSL certificate (or the combined PEM-formatted SSL certificate and Certificate Authority chain) that should be served on this NodeBalancerConfig’s port.
--ssl_key	str	<REDACTED>	(nullable) The PEM-formatted private key for the SSL certificate set in the ssl_cert field.
--stickiness	str	http_cookie	Controls how session stickiness is handled on this port.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
algorithm	str	roundrobin	What algorithm this NodeBalancer should use for routing traffic to backends.
check	str	http_body	The type of check to perform against backends to ensure they are serving requests.
check_attempts	int	3	How many times to attempt a check before considering a backend to be down.
check_body	str	it works	This value must be present in the response body of the check in order for it to pass.
check_interval	int	90	How often, in seconds, to check that backends are up and serving requests.
check_passive	bool	true	If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.
check_path	str	/test	The URL path to check on each backend.
check_timeout	int	10	How long, in seconds, to wait for a check attempt before considering it failed.
cipher_suite	str	recommended	What ciphers to use for SSL connections served by this NodeBalancer.
id	int	4567	This config’s unique ID.
nodebalancer_id	int	12345	The ID for the NodeBalancer this config belongs to.
port	int	80	The port this Config is for.
protocol	str	http	The protocol this port is configured to serve.
proxy_protocol	str	none	ProxyProtocol is a TCP extension that sends initial TCP connection information such as source/destination IPs and ports to backend devices.
ssl_cert	str	<REDACTED>	The PEM-formatted public SSL certificate (or the combined PEM-formatted SSL certificate and Certificate Authority chain) that should be served on this NodeBalancerConfig’s port.
ssl_commonname	str	www.example.com	The read-only common name automatically derived from the SSL certificate assigned to this NodeBalancerConfig.
ssl_fingerprint	str	00:01:02:03:0…:10:11:12:13	The read-only SHA1-encoded fingerprint automatically derived from the SSL certificate assigned to this NodeBalancerConfig.
ssl_key	str	<REDACTED>	The PEM-formatted private key for the SSL certificate set in the ssl_cert field.
stickiness	str	http_cookie	Controls how session stickiness is handled on this port.

nodes_status

Name	Type	Example	Description
nodes_status.down	int	N/A	The number of backends considered to be “DOWN” and unhealthy.
nodes_status.up	int	4	The number of backends considered to be “UP” and healthy, and that are serving requests.

---

config-delete

Deletes the Config for a port of this NodeBalancer.

Usage

The format accepted by this command.

linode-cli nodebalancers config-delete [-h] nodeBalancerId
    configId

Sample

Examples of how this command might be used.

linode-cli nodebalancers config-delete \
    12345 4567

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
nodeBalancerId	int	The ID of the NodeBalancer to access.
configId	int	The ID of the Config to access.

---

config-rebuild

Rebuilds a NodeBalancer Config and its Nodes that you have permission to modify.

Usage

The format accepted by this command.

linode-cli nodebalancers config-rebuild [-h]
    [--check_interval check_interval]
    [--proxy_protocol proxy_protocol] [--check check]
    [--ssl_cert ssl_cert] [--check_attempts check_attempts]
    [--port port] [--protocol protocol] [--check_body check_body]
    [--cipher_suite cipher_suite] [--stickiness stickiness]
    [--check_passive check_passive] [--ssl_key ssl_key]
    [--check_path check_path] [--check_timeout check_timeout]
    [--algorithm algorithm] [--nodes nodes] [--nodes.mode mode]
    [--nodes.label label] [--nodes.weight weight] [--nodes.id id]
    [--nodes.address address] nodeBalancerId configId

Sample

Examples of how this command might be used.

linode-cli nodebalancers config-rebuild \
    12345 4567 \
    --port 443 \
    --protocol https \
    --algorithm roundrobin \
    --stickiness http_cookie \
    --check http_body \
    --check_interval 90 \
    --check_timeout 10 \
    --check_attempts 3 \
    --check_path "/test" \
    --check_body "it works" \
    --check_passive true \
    --proxy_protocol "none" \
    --ssl_cert "-----BEGIN CERTIFICATE-----
                            CERTIFICATE_INFORMATION
                            -----END CERTIFICATE-----" \
    --ssl_key "-----BEGIN PRIVATE KEY-----
                         PRIVATE_KEY_INFORMATION
                         -----END PRIVATE KEY-----" \
    --cipher_suite recommended \
    --nodes '{"address":"192.168.210.120:80","label":"node1","weight":50,"mode":"accept"}' \
    --nodes '{"address":"192.168.210.122:80","label":"node2","weight":50,"mode":"accept"}'

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
nodeBalancerId	int	The ID of the NodeBalancer to access.
configId	int	The ID of the Config to access.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--algorithm	str	roundrobin	What algorithm this NodeBalancer should use for routing traffic to backends.
--check	str	http_body	The type of check to perform against backends to ensure they are serving requests.
--check_attempts	int	3	How many times to attempt a check before considering a backend to be down.
--check_body	str	it works	This value must be present in the response body of the check in order for it to pass.
--check_interval	int	90	How often, in seconds, to check that backends are up and serving requests.
--check_passive	bool	true	If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.
--check_path	str	/test	The URL path to check on each backend.
--check_timeout	int	10	How long, in seconds, to wait for a check attempt before considering it failed.
--cipher_suite	str	recommended	What ciphers to use for SSL connections served by this NodeBalancer.
--nodes (section)	json	N/A	NodeBalancer Node request object including ID.
--port	int	80	The port this Config is for.
--protocol	str	http	The protocol this port is configured to serve.
--proxy_protocol	str	none	ProxyProtocol is a TCP extension that sends initial TCP connection information such as source/destination IPs and ports to backend devices.
--ssl_cert	str	<REDACTED>	(nullable) The PEM-formatted public SSL certificate (or the combined PEM-formatted SSL certificate and Certificate Authority chain) that should be served on this NodeBalancerConfig’s port.
--ssl_key	str	<REDACTED>	(nullable) The PEM-formatted private key for the SSL certificate set in the ssl_cert field.
--stickiness	str	http_cookie	Controls how session stickiness is handled on this port.

nodes

Name	Type	Example	Description
--nodes.address	str	192.168.210.120:80	The private IP Address where this backend can be reached.
--nodes.id	int	54321	The unique ID of the Node to update.
--nodes.label	str	node54321	The label for this node.
--nodes.mode	str	accept	The mode this NodeBalancer should use when sending traffic to this backend.
--nodes.weight	int	50	Used when picking a backend to serve a request and is not pinned to a single backend yet.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
algorithm	str	roundrobin	What algorithm this NodeBalancer should use for routing traffic to backends.
check	str	http_body	The type of check to perform against backends to ensure they are serving requests.
check_attempts	int	3	How many times to attempt a check before considering a backend to be down.
check_body	str	it works	This value must be present in the response body of the check in order for it to pass.
check_interval	int	90	How often, in seconds, to check that backends are up and serving requests.
check_passive	bool	true	If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.
check_path	str	/test	The URL path to check on each backend.
check_timeout	int	10	How long, in seconds, to wait for a check attempt before considering it failed.
cipher_suite	str	recommended	What ciphers to use for SSL connections served by this NodeBalancer.
id	int	4567	This config’s unique ID.
nodebalancer_id	int	12345	The ID for the NodeBalancer this config belongs to.
port	int	80	The port this Config is for.
protocol	str	http	The protocol this port is configured to serve.
proxy_protocol	str	none	ProxyProtocol is a TCP extension that sends initial TCP connection information such as source/destination IPs and ports to backend devices.
ssl_cert	str	<REDACTED>	The PEM-formatted public SSL certificate (or the combined PEM-formatted SSL certificate and Certificate Authority chain) that should be served on this NodeBalancerConfig’s port.
ssl_commonname	str	www.example.com	The read-only common name automatically derived from the SSL certificate assigned to this NodeBalancerConfig.
ssl_fingerprint	str	00:01:02:03:0…:10:11:12:13	The read-only SHA1-encoded fingerprint automatically derived from the SSL certificate assigned to this NodeBalancerConfig.
ssl_key	str	<REDACTED>	The PEM-formatted private key for the SSL certificate set in the ssl_cert field.
stickiness	str	http_cookie	Controls how session stickiness is handled on this port.

nodes_status

Name	Type	Example	Description
nodes_status.down	int	N/A	The number of backends considered to be “DOWN” and unhealthy.
nodes_status.up	int	4	The number of backends considered to be “UP” and healthy, and that are serving requests.

---

configs-list

Returns a paginated list of NodeBalancer Configs associated with this NodeBalancer.

Usage

The format accepted by this command.

linode-cli nodebalancers configs-list [-h] [--order-by {}]
    [--order {asc,desc}] nodeBalancerId

Sample

Examples of how this command might be used.

linode-cli nodebalancers configs-list 12345

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
nodeBalancerId	int	The ID of the NodeBalancer to access.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
algorithm	str	roundrobin	What algorithm this NodeBalancer should use for routing traffic to backends.
check	str	http_body	The type of check to perform against backends to ensure they are serving requests.
check_attempts	int	3	How many times to attempt a check before considering a backend to be down.
check_body	str	it works	This value must be present in the response body of the check in order for it to pass.
check_interval	int	90	How often, in seconds, to check that backends are up and serving requests.
check_passive	bool	true	If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.
check_path	str	/test	The URL path to check on each backend.
check_timeout	int	10	How long, in seconds, to wait for a check attempt before considering it failed.
cipher_suite	str	recommended	What ciphers to use for SSL connections served by this NodeBalancer.
id	int	4567	This config’s unique ID.
nodebalancer_id	int	12345	The ID for the NodeBalancer this config belongs to.
port	int	80	The port this Config is for.
protocol	str	http	The protocol this port is configured to serve.
proxy_protocol	str	none	ProxyProtocol is a TCP extension that sends initial TCP connection information such as source/destination IPs and ports to backend devices.
ssl_cert	str	<REDACTED>	The PEM-formatted public SSL certificate (or the combined PEM-formatted SSL certificate and Certificate Authority chain) that should be served on this NodeBalancerConfig’s port.
ssl_commonname	str	www.example.com	The read-only common name automatically derived from the SSL certificate assigned to this NodeBalancerConfig.
ssl_fingerprint	str	00:01:02:03:0…:10:11:12:13	The read-only SHA1-encoded fingerprint automatically derived from the SSL certificate assigned to this NodeBalancerConfig.
ssl_key	str	<REDACTED>	The PEM-formatted private key for the SSL certificate set in the ssl_cert field.
stickiness	str	http_cookie	Controls how session stickiness is handled on this port.

nodes_status

Name	Type	Example	Description
nodes_status.down	int	N/A	The number of backends considered to be “DOWN” and unhealthy.
nodes_status.up	int	4	The number of backends considered to be “UP” and healthy, and that are serving requests.

---

node-view

Returns information about a single Node, a backend for this NodeBalancer’s configured port.

Usage

The format accepted by this command.

linode-cli nodebalancers node-view [-h] [--order-by {}]
    [--order {asc,desc}] nodeBalancerId configId nodeId

Sample

Examples of how this command might be used.

linode-cli nodebalancers node-view 12345 4567 54321

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
nodeBalancerId	int	The ID of the NodeBalancer to access.
configId	int	The ID of the Config to access.
nodeId	int	The ID of the Node to access.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
address	str	192.168.210.120:80	The private IP Address where this backend can be reached.
config_id	int	4567	The NodeBalancer Config ID that this Node belongs to.
id	int	54321	This node’s unique ID.
label	str	node54321	The label for this node.
mode	str	accept	The mode this NodeBalancer should use when sending traffic to this backend.
nodebalancer_id	int	12345	The NodeBalancer ID that this Node belongs to.
status	str	UP	The current status of this node, based on the configured checks of its NodeBalancer Config.
weight	int	50	Used when picking a backend to serve a request and is not pinned to a single backend yet.

---

node-create

Creates a NodeBalancer Node, a backend that can accept traffic for this NodeBalancer Config.

Usage

The format accepted by this command.

linode-cli nodebalancers node-create [-h] [--address address]
    [--weight weight] [--label label] [--mode mode] nodeBalancerId
    configId

Sample

Examples of how this command might be used.

linode-cli nodebalancers node-create \
    12345 4567 \
    --address 192.168.210.120:80 \
    --label node54321 \
    --weight 50 \
    --mode accept

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
nodeBalancerId	int	The ID of the NodeBalancer to access.
configId	int	The ID of the NodeBalancer config to access.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--address *	str	192.168.210.120:80	The private IP Address where this backend can be reached.
--label *	str	node54321	The label for this node.
--mode	str	accept	The mode this NodeBalancer should use when sending traffic to this backend.
--weight	int	50	Used when picking a backend to serve a request and is not pinned to a single backend yet.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
address	str	192.168.210.120:80	The private IP Address where this backend can be reached.
config_id	int	4567	The NodeBalancer Config ID that this Node belongs to.
id	int	54321	This node’s unique ID.
label	str	node54321	The label for this node.
mode	str	accept	The mode this NodeBalancer should use when sending traffic to this backend.
nodebalancer_id	int	12345	The NodeBalancer ID that this Node belongs to.
status	str	UP	The current status of this node, based on the configured checks of its NodeBalancer Config.
weight	int	50	Used when picking a backend to serve a request and is not pinned to a single backend yet.

---

node-update

Updates information about a Node, a backend for this NodeBalancer’s configured port.

Usage

The format accepted by this command.

linode-cli nodebalancers node-update [-h] [--label label]
    [--weight weight] [--mode mode] [--address address]
    nodeBalancerId configId nodeId

Sample

Examples of how this command might be used.

linode-cli nodebalancers node-update \
    12345 4567 54321 \
    --address 192.168.210.120:80 \
    --label node54321 \
    --weight 50 \
    --mode accept

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
nodeBalancerId	int	The ID of the NodeBalancer to access.
configId	int	The ID of the Config to access.
nodeId	int	The ID of the Node to access.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--address	str	192.168.210.120:80	The private IP Address where this backend can be reached.
--label	str	node54321	The label for this node.
--mode	str	accept	The mode this NodeBalancer should use when sending traffic to this backend.
--weight	int	50	Used when picking a backend to serve a request and is not pinned to a single backend yet.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
address	str	192.168.210.120:80	The private IP Address where this backend can be reached.
config_id	int	4567	The NodeBalancer Config ID that this Node belongs to.
id	int	54321	This node’s unique ID.
label	str	node54321	The label for this node.
mode	str	accept	The mode this NodeBalancer should use when sending traffic to this backend.
nodebalancer_id	int	12345	The NodeBalancer ID that this Node belongs to.
status	str	UP	The current status of this node, based on the configured checks of its NodeBalancer Config.
weight	int	50	Used when picking a backend to serve a request and is not pinned to a single backend yet.

---

node-delete

Deletes a Node from this Config.

Usage

The format accepted by this command.

linode-cli nodebalancers node-delete [-h] nodeBalancerId configId
    nodeId

Sample

Examples of how this command might be used.

linode-cli nodebalancers node-delete \
    12345 4567 54321

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
nodeBalancerId	int	The ID of the NodeBalancer to access.
configId	int	The ID of the Config to access.
nodeId	int	The ID of the Node to access.

nodes-list

Returns a paginated list of NodeBalancer nodes associated with this Config.

Usage

The format accepted by this command.

linode-cli nodebalancers nodes-list [-h] [--order-by {}]
    [--order {asc,desc}] nodeBalancerId configId

Sample

Examples of how this command might be used.

linode-cli nodebalancers nodes-list 12345 4567

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
nodeBalancerId	int	The ID of the NodeBalancer to access.
configId	int	The ID of the NodeBalancer config to access.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
address	str	192.168.210.120:80	The private IP Address where this backend can be reached.
config_id	int	4567	The NodeBalancer Config ID that this Node belongs to.
id	int	54321	This node’s unique ID.
label	str	node54321	The label for this node.
mode	str	accept	The mode this NodeBalancer should use when sending traffic to this backend.
nodebalancer_id	int	12345	The NodeBalancer ID that this Node belongs to.
status	str	UP	The current status of this node, based on the configured checks of its NodeBalancer Config.
weight	int	50	Used when picking a backend to serve a request and is not pinned to a single backend yet.