configs

Overview

Name	configs
Type	Resource
Id	linode.nodebalancers.configs

Fields

Name	Datatype	Description
id	integer	This config's unique ID
algorithm	string	What algorithm this NodeBalancer should use for routing traffic to backends.
check	string	The type of check to perform against backends to ensure they are serving requests. This is used to determine if backends are up or down. If none no check is performed. connection requires only a connection to the backend to succeed. * http and http_body rely on the backend serving HTTP, and that the response returned matches what is expected.
check_attempts	integer	How many times to attempt a check before considering a backend to be down.
check_body	string	This value must be present in the response body of the check in order for it to pass. If this value is not present in the response body of a check request, the backend is considered to be down.
check_interval	integer	How often, in seconds, to check that backends are up and serving requests. Must be greater than check_timeout.
check_passive	boolean	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	string	The URL path to check on each backend. If the backend does not respond to this request it is considered to be down.
check_timeout	integer	How long, in seconds, to wait for a check attempt before considering it failed. Must be less than check_interval.
cipher_suite	string	What ciphers to use for SSL connections served by this NodeBalancer. * legacy is considered insecure and should only be used if necessary.
nodebalancer_id	integer	The ID for the NodeBalancer this config belongs to.
nodes_status	object	A structure containing information about the health of the backends for this port. This information is updated periodically as checks are performed against backends.
port	integer	The port this Config is for. These values must be unique across configs on a single NodeBalancer (you can't have two configs for port 80, for example). While some ports imply some protocols, no enforcement is done and you may configure your NodeBalancer however is useful to you. For example, while port 443 is generally used for HTTPS, you do not need SSL configured to have a NodeBalancer listening on port 443.
protocol	string	The protocol this port is configured to serve. The http and tcp protocols do not support ssl_cert and ssl_key. The https protocol is mutually required with ssl_cert and ssl_key. Review our guide on Available Protocols for information on protocol features.
proxy_protocol	string	ProxyProtocol is a TCP extension that sends initial TCP connection information such as source/destination IPs and ports to backend devices. This information would be lost otherwise. Backend devices must be configured to work with ProxyProtocol if enabled. If ommited, or set to none, the NodeBalancer doesn't send any auxilary data over TCP connections. This is the default. If set to v1, the human-readable header format (Version 1) is used. Requires tcp protocol. * If set to v2, the binary header format (Version 2) is used. Requires tcp protocol.
ssl_cert	string	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. Line breaks must be represented as "\n" in the string for requests (but not when using the Linode CLI). Diffie-Hellman Parameters can be included in this value to enable forward secrecy. The contents of this field will not be shown in any responses that display the NodeBalancerConfig. Instead, <REDACTED> will be printed where the field appears. The read-only ssl_commonname and ssl_fingerprint fields in a NodeBalancerConfig response are automatically derived from your certificate. Please refer to these fields to verify that the appropriate certificate was assigned to your NodeBalancerConfig.
ssl_commonname	string	The read-only common name automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.
ssl_fingerprint	string	The read-only SHA1-encoded fingerprint automatically derived from the SSL certificate assigned to this NodeBalancerConfig. Please refer to this field to verify that the appropriate certificate is assigned to your NodeBalancerConfig.
ssl_key	string	The PEM-formatted private key for the SSL certificate set in the ssl_cert field. Line breaks must be represented as "\n" in the string for requests (but not when using the Linode CLI). The contents of this field will not be shown in any responses that display the NodeBalancerConfig. Instead, <REDACTED> will be printed where the field appears. The read-only ssl_commonname and ssl_fingerprint fields in a NodeBalancerConfig response are automatically derived from your certificate. Please refer to these fields to verify that the appropriate certificate was assigned to your NodeBalancerConfig.
stickiness	string	Controls how session stickiness is handled on this port. If set to none connections will always be assigned a backend based on the algorithm configured. If set to table sessions from the same remote address will be routed to the same backend. * For HTTP or HTTPS clients, http_cookie allows sessions to be routed to the same backend based on a cookie set by the NodeBalancer.

Methods

Name	Accessible by	Required Params	Description
getNodeBalancerConfig	SELECT	configId, nodeBalancerId	Returns configuration information for a single port of this NodeBalancer.
getNodeBalancerConfigs	SELECT	nodeBalancerId	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.
createNodeBalancerConfig	INSERT	nodeBalancerId	Creates a NodeBalancer Config, which allows the NodeBalancer to accept traffic on a new port. You will need to add NodeBalancer Nodes to the new Config before it can actually serve requests.
deleteNodeBalancerConfig	DELETE	configId, nodeBalancerId	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.
_getNodeBalancerConfig	EXEC	configId, nodeBalancerId	Returns configuration information for a single port of this NodeBalancer.
_getNodeBalancerConfigs	EXEC	nodeBalancerId	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.
rebuildNodeBalancerConfig	EXEC	configId, nodeBalancerId	Rebuilds a NodeBalancer Config and its Nodes that you have permission to modify. Use this command to update a NodeBalancer's Config and Nodes with a single request.
updateNodeBalancerConfig	EXEC	configId, nodeBalancerId	Updates the configuration for a single port on a NodeBalancer.