configurations

Creates, updates, deletes, gets or lists a configurations resource.

Overview

Name	`configurations`
Type	Resource
Id	`linode.nodebalancers.configurations`

Fields

The following fields are returned by SELECT queries:

get_node_balancer_config
get_node_balancer_configs

The requested NodeBalancer config.

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_node_balancer_config`	`select`			Returns configuration information for a single port of this NodeBalancer. Learn more... Learn more...
`get_node_balancer_configs`	`select`		`page`, `page_size`	Returns a paginated list of NodeBalancer Configs associated with this NodeBalancer. NodeBalancer Configs represent individual ports that this NodeBalancer will accept traffic on, one Config per port. For example, if you wanted to accept standard HTTP traffic, you would need a Config listening on port 80. Learn more... Learn more...
`post_node_balancer_config`	`insert`	`data__nodes`		Creates a NodeBalancer configuration, which allows the NodeBalancer to accept traffic on a new port. You will need to add NodeBalancer nodes to the new configuration before it can actually serve requests. > 🚧 > > You can configure UDP on the same NodeBalancer that also uses TCP, HTTP, or HTTPS, but only when managing it through the API. If UDP is configured and you make changes to the TCP, HTTP or HTTPS settings in Cloud Manager, the existing UDP configuration will be overwritten. This is because Cloud Manager doesn't currently support UDP. CLI: HTTPS. <br /> linode-cli nodebalancers config-create 12345 \<br /> --port 443 \<br /> --protocol https \<br /> --algorithm roundrobin \<br /> --stickiness http_cookie \<br /> --check http_body \<br /> --check_interval 90 \<br /> --check_timeout 10 \<br /> --check_attempts 3 \<br /> --check_path "/test" \<br /> --check_body "it works" \<br /> --check_passive true \<br /> --proxy_protocol "none" \<br /> --ssl_cert "-----BEGIN CERTIFICATE-----<br /> CERTIFICATE_INFORMATION<br /> -----END CERTIFICATE-----" \<br /> --ssl_key "-----BEGIN PRIVATE KEY-----<br /> PRIVATE_KEY_INFORMATION<br /> -----END PRIVATE KEY-----" \<br /> --cipher_suite recommended<br /> Learn more... - CLI: UDP. `<br /> linode-cli nodebalancers config-create 12345 \<br /> --port 80 \<br /> --protocol udp \<br /> --algorithm ring_hash \<br /> --stickiness session \<br /> --check http_body \<br /> --check_interval 90 \<br /> --check_timeout 10 \<br /> --check_attempts 3 \<br /> --check_path "/test" \<br /> --check_body "it works" \<br /> --udp_check_port 80<br />` Learn more... - CLI: TCP. `<br /> linode-cli nodebalancers config-create 12345 \<br /> --port 80 \<br /> --protocol tcp \<br /> --algorithm roundrobin \<br /> --stickiness none \<br /> --check http_body \<br /> --check_interval 90 \<br /> --check_timeout 10 \<br /> --check_attempts 3 \<br /> --check_path "/test" \<br /> --check_body "it works" \<br /> --proxy_protocol "v2"<br />` Learn more... - CLI: HTTP. `<br /> linode-cli nodebalancers config-create 12345 \<br /> --port 440 \<br /> --protocol http \<br /> --algorithm roundrobin \<br /> --stickiness http_cookie \<br /> --check http_body \<br /> --check_interval 90 \<br /> --check_timeout 10 \<br /> --check_attempts 3 \<br /> --check_path "/test" \<br /> --check_body "it works"<br />` Learn more... Learn more...
`put_node_balancer_config`	`replace`			Updates the configuration for a single port on a NodeBalancer. > 🚧 > > You can configure UDP on the same NodeBalancer that also uses TCP, HTTP, or HTTPS, but only when managing it through the API. If UDP is configured and you make changes to the TCP, HTTP or HTTPS settings in Cloud Manager, the existing UDP configuration will be overwritten. This is because Cloud Manager doesn't currently support UDP. CLI: HTTPS. <br /> linode-cli nodebalancers config-update \<br /> 12345 4567 \<br /> --port 443 \<br /> --protocol https \<br /> --algorithm roundrobin \<br /> --stickiness http_cookie \<br /> --check http_body \<br /> --check_interval 90 \<br /> --check_timeout 10 \<br /> --check_attempts 3 \<br /> --check_path "/test" \<br /> --check_body "it works" \<br /> --check_passive true \<br /> --proxy_protocol "none" \<br /> --ssl_cert "-----BEGIN CERTIFICATE-----<br /> CERTIFICATE_INFORMATION<br /> -----END CERTIFICATE-----" \<br /> --ssl_key "-----BEGIN PRIVATE KEY-----<br /> PRIVATE_KEY_INFORMATION<br /> -----END PRIVATE KEY-----" \<br /> --cipher_suite recommended<br /> Learn more... - CLI: UDP. `<br /> linode-cli nodebalancers config-update \<br /> 12345 4567 \<br /> --port 80 \<br /> --protocol udp \<br /> --algorithm ring_hash \<br /> --stickiness session \<br /> --check http_body \<br /> --check_interval 90 \<br /> --check_timeout 10 \<br /> --check_attempts 3 \<br /> --check_path "/test" \<br /> --check_body "it works" \<br /> --udp_check_port 80<br />` Learn more... - CLI: TCP. `<br /> linode-cli nodebalancers config-update \<br /> 12345 4567 \<br /> --port 80 \<br /> --protocol tcp \<br /> --algorithm roundrobin \<br /> --stickiness none \<br /> --stickiness http_cookie \<br /> --check http_body \<br /> --check_interval 90 \<br /> --check_timeout 10 \<br /> --check_attempts 3 \<br /> --check_path "/test" \<br /> --check_body "it works" \<br /> --proxy_protocol "v2"<br />` Learn more... - CLI: HTTP. `<br /> linode-cli nodebalancers config-update \<br /> 12345 4567 \<br /> --port 440 \<br /> --protocol http \<br /> --algorithm roundrobin \<br /> --stickiness http_cookie \<br /> --check http_body \<br /> --check_interval 90 \<br /> --check_timeout 10 \<br /> --check_attempts 3 \<br /> --check_path "/test" \<br /> --check_body "it works"<br />` Learn more... Learn more...
`delete_node_balancer_config`	`delete`			Deletes the Config for a port of this NodeBalancer. This cannot be undone. Once completed, this NodeBalancer will no longer respond to requests on the given port. This also deletes all associated NodeBalancerNodes, but the Linodes they were routing traffic to will be unchanged and will not be removed. Learn more... Learn more...
`post_rebuild_node_balancer_config`	`exec`	`nodes`		Rebuilds a NodeBalancer config and its nodes that you have permission to modify. Use this operation to update a NodeBalancer's config and nodes with a single request. > 🚧 > > You can configure UDP on the same NodeBalancer that also uses TCP, HTTP, or HTTPS, but only when managing it through the API. If UDP is configured and you make changes to the TCP, HTTP or HTTPS settings in Cloud Manager, the existing UDP configuration will be overwritten. This is because Cloud Manager doesn't currently support UDP. CLI: HTTPS. <br /> linode-cli nodebalancers config-rebuild \<br /> 12345 4567 \<br /> --port 443 \<br /> --protocol https \<br /> --algorithm roundrobin \<br /> --stickiness http_cookie \<br /> --check http_body \<br /> --check_interval 90 \<br /> --check_timeout 10 \<br /> --check_attempts 3 \<br /> --check_path "/test" \<br /> --check_body "it works" \<br /> --check_passive true \<br /> --proxy_protocol "none" \<br /> --ssl_cert "-----BEGIN CERTIFICATE-----<br /> CERTIFICATE_INFORMATION<br /> -----END CERTIFICATE-----" \<br /> --ssl_key "-----BEGIN PRIVATE KEY-----<br /> PRIVATE_KEY_INFORMATION<br /> -----END PRIVATE KEY-----" \<br /> --cipher_suite recommended \<br /> --nodes.label "node1" --nodes.address "192.168.210.120:80" --nodes.mode "accept" --nodes.weight 50 \<br /> --nodes '[{"address":"192.168.210.122:80","label":"node2","weight":50,"mode":"accept"}]' \<br /> --nodes '[{"address":"10.0.0.45:80","label":"vpc-node","weight":10,"mode":"accept","subnet_id:1"}]'<br /> Learn more... - CLI: UDP. <br /> linode-cli nodebalancers config-rebuild \<br /> 12345 4567 \<br /> --port 80 \<br /> --protocol udp \<br /> --algorithm ring_hash \<br /> --udp_check_port 80 \<br /> --nodes.label "node1" --nodes.address "192.168.210.120:80" --nodes.mode "accept" --nodes.weight 50 \<br /> --nodes '[{"address":"192.168.210.122:80","label":"node2","weight":50}]' \<br /> --nodes '[{"address":"10.0.0.45:80","label":"vpc-node","weight":10,"mode":"accept","subnet_id:1"}]'<br /> Learn more... - CLI: TCP. <br /> linode-cli nodebalancers config-rebuild \<br /> 12345 4567 \<br /> --port 80 \<br /> --protocol tcp \<br /> --algorithm roundrobin \<br /> --stickiness none \<br /> --proxy_protocol "v2"<br /> --nodes.label "node1" --nodes.address "192.168.210.120:80" --nodes.mode "accept" --nodes.weight 50 \<br /> --nodes '[{"address":"192.168.210.122:80","label":"node2","weight":50,"mode":"accept"}]' \<br /> --nodes '[{"address":"10.0.0.45:80","label":"vpc-node","weight":10,"mode":"accept","subnet_id:1"}]'<br /> Learn more... - CLI: HTTP. <br /> linode-cli nodebalancers config-rebuild \<br /> 12345 4567 \<br /> --port 440 \<br /> --protocol http \<br /> --algorithm roundrobin \<br /> --stickiness none \<br /> --check http_body \<br /> --check_interval 90 \<br /> --check_timeout 10 \<br /> --check_attempts 3 \<br /> --check_path "/test" \<br /> --check_body "it works" \<br /> --nodes.label "node1" --nodes.address "192.168.210.120:80" --nodes.mode "accept" --nodes.weight 50 \<br /> --nodes '[{"address":"192.168.210.122:80","label":"node2","weight":50,"mode":"accept"}]' \<br /> --nodes '[{"address":"10.0.0.45:80","label":"vpc-node","weight":10,"mode":"accept","subnet_id:1"}]'<br /> Learn more... Learn more...

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`page`	`integer`	The page of a collection to return.
`page_size`	`integer`	The number of items to return per page.

`SELECT` examples

get_node_balancer_config
get_node_balancer_configs

Returns configuration information for a single port of this NodeBalancer.

Learn more...

Learn more...

SELECT
*
FROM linode.nodebalancers.configurations;

Returns a paginated list of NodeBalancer Configs associated with this NodeBalancer. NodeBalancer Configs represent individual ports that this NodeBalancer will accept traffic on, one Config per port.

For example, if you wanted to accept standard HTTP traffic, you would need a Config listening on port 80.

Learn more...

Learn more...

SELECT
*
FROM linode.nodebalancers.configurations
WHERE page = '{{ page }}'
AND page_size = '{{ page_size }}';

`INSERT` examples

post_node_balancer_config
Manifest

Creates a NodeBalancer configuration, which allows the NodeBalancer to accept traffic on a new port. You will need to add NodeBalancer nodes to the new configuration before it can actually serve requests.

> 🚧
>
> You can configure UDP on the same NodeBalancer that also uses TCP, HTTP, or HTTPS, but only when managing it through the API. If UDP is configured and you make changes to the TCP, HTTP or HTTPS settings in Cloud Manager, the existing UDP configuration will be overwritten. This is because Cloud Manager doesn't currently support UDP. CLI: HTTPS.

 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 

Learn more...

- CLI: UDP.

 linode-cli nodebalancers config-create 12345 \ --port 80 \ --protocol udp \ --algorithm ring_hash \ --stickiness session \ --check http_body \ --check_interval 90 \ --check_timeout 10 \ --check_attempts 3 \ --check_path "/test" \ --check_body "it works" \ --udp_check_port 80 

Learn more...

- CLI: TCP.

 linode-cli nodebalancers config-create 12345 \ --port 80 \ --protocol tcp \ --algorithm roundrobin \ --stickiness none \ --check http_body \ --check_interval 90 \ --check_timeout 10 \ --check_attempts 3 \ --check_path "/test" \ --check_body "it works" \ --proxy_protocol "v2" 

Learn more...

- CLI: HTTP.

 linode-cli nodebalancers config-create 12345 \ --port 440 \ --protocol http \ --algorithm roundrobin \ --stickiness http_cookie \ --check http_body \ --check_interval 90 \ --check_timeout 10 \ --check_attempts 3 \ --check_path "/test" \ --check_body "it works" 

Learn more...

Learn more...

INSERT INTO linode.nodebalancers.configurations (
data__nodes
)
SELECT 
'{{ nodes }}' --required
;

# Description fields are for documentation purposes
- name: configurations
  props:
    - name: nodes
      value: array
      description: >
        The NodeBalancer nodes that serve this config.

Some considerations for Nodes when rebuilding a config:

  - Current Nodes excluded from the request body will be deleted from the Config.
  - Current Nodes (identified by their Node ID) will be updated.
  - New Nodes (included without a Node ID) will be created.
        

`REPLACE` examples

put_node_balancer_config

Updates the configuration for a single port on a NodeBalancer.

> 🚧
>
> You can configure UDP on the same NodeBalancer that also uses TCP, HTTP, or HTTPS, but only when managing it through the API. If UDP is configured and you make changes to the TCP, HTTP or HTTPS settings in Cloud Manager, the existing UDP configuration will be overwritten. This is because Cloud Manager doesn't currently support UDP. CLI: HTTPS.

 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 

Learn more...

- CLI: UDP.

 linode-cli nodebalancers config-update \ 12345 4567 \ --port 80 \ --protocol udp \ --algorithm ring_hash \ --stickiness session \ --check http_body \ --check_interval 90 \ --check_timeout 10 \ --check_attempts 3 \ --check_path "/test" \ --check_body "it works" \ --udp_check_port 80 

Learn more...

- CLI: TCP.

 linode-cli nodebalancers config-update \ 12345 4567 \ --port 80 \ --protocol tcp \ --algorithm roundrobin \ --stickiness none \ --stickiness http_cookie \ --check http_body \ --check_interval 90 \ --check_timeout 10 \ --check_attempts 3 \ --check_path "/test" \ --check_body "it works" \ --proxy_protocol "v2" 

Learn more...

- CLI: HTTP.

 linode-cli nodebalancers config-update \ 12345 4567 \ --port 440 \ --protocol http \ --algorithm roundrobin \ --stickiness http_cookie \ --check http_body \ --check_interval 90 \ --check_timeout 10 \ --check_attempts 3 \ --check_path "/test" \ --check_body "it works" 

Learn more...

Learn more...

REPLACE linode.nodebalancers.configurations
SET 
-- No updatable properties
WHERE 
;

`DELETE` examples

delete_node_balancer_config

Deletes the Config for a port of this NodeBalancer.

This cannot be undone.

Once completed, this NodeBalancer will no longer respond to requests on the given port. This also deletes all associated NodeBalancerNodes, but the Linodes they were routing traffic to will be unchanged and will not be removed.

Learn more...

Learn more...

DELETE FROM linode.nodebalancers.configurations;

Lifecycle Methods

post_rebuild_node_balancer_config

Rebuilds a NodeBalancer config and its nodes that you have permission to modify.

Use this operation to update a NodeBalancer's config and nodes with a single request.

> 🚧
>
> You can configure UDP on the same NodeBalancer that also uses TCP, HTTP, or HTTPS, but only when managing it through the API. If UDP is configured and you make changes to the TCP, HTTP or HTTPS settings in Cloud Manager, the existing UDP configuration will be overwritten. This is because Cloud Manager doesn't currently support UDP. CLI: HTTPS.

 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.label "node1" --nodes.address "192.168.210.120:80" --nodes.mode "accept" --nodes.weight 50 \ --nodes '[{"address":"192.168.210.122:80","label":"node2","weight":50,"mode":"accept"}]' \ --nodes '[{"address":"10.0.0.45:80","label":"vpc-node","weight":10,"mode":"accept","subnet_id:1"}]' 

Learn more...

- CLI: UDP.

 linode-cli nodebalancers config-rebuild \ 12345 4567 \ --port 80 \ --protocol udp \ --algorithm ring_hash \ --udp_check_port 80 \ --nodes.label "node1" --nodes.address "192.168.210.120:80" --nodes.mode "accept" --nodes.weight 50 \ --nodes '[{"address":"192.168.210.122:80","label":"node2","weight":50}]' \ --nodes '[{"address":"10.0.0.45:80","label":"vpc-node","weight":10,"mode":"accept","subnet_id:1"}]' 

Learn more...

- CLI: TCP.

 linode-cli nodebalancers config-rebuild \ 12345 4567 \ --port 80 \ --protocol tcp \ --algorithm roundrobin \ --stickiness none \ --proxy_protocol "v2" --nodes.label "node1" --nodes.address "192.168.210.120:80" --nodes.mode "accept" --nodes.weight 50 \ --nodes '[{"address":"192.168.210.122:80","label":"node2","weight":50,"mode":"accept"}]' \ --nodes '[{"address":"10.0.0.45:80","label":"vpc-node","weight":10,"mode":"accept","subnet_id:1"}]' 

Learn more...

- CLI: HTTP.

 linode-cli nodebalancers config-rebuild \ 12345 4567 \ --port 440 \ --protocol http \ --algorithm roundrobin \ --stickiness none \ --check http_body \ --check_interval 90 \ --check_timeout 10 \ --check_attempts 3 \ --check_path "/test" \ --check_body "it works" \ --nodes.label "node1" --nodes.address "192.168.210.120:80" --nodes.mode "accept" --nodes.weight 50 \ --nodes '[{"address":"192.168.210.122:80","label":"node2","weight":50,"mode":"accept"}]' \ --nodes '[{"address":"10.0.0.45:80","label":"vpc-node","weight":10,"mode":"accept","subnet_id:1"}]' 

Learn more...

Learn more...

EXEC linode.nodebalancers.configurations.post_rebuild_node_balancer_config 
@@json=
'{
"nodes": "{{ nodes }}"
}';

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

REPLACE examples​

DELETE examples​

Lifecycle Methods​