nodebalancer_node.md

nodebalancer_node

Manage Linode NodeBalancer Nodes.

• Minimum Required Fields
• Examples
• Parameters
• Return Values

Minimum Required Fields

Field	Type	Required	Description
api_token	str	Required	The Linode account personal access token. It is necessary to run the module. It can be exposed by the environment variable LINODE_API_TOKEN instead. See details in Usage.

Examples

- name: Create a NodeBalancer
  linode.cloud.nodebalancer:
    label: my-nodebalancer
    region: us-east
    state: present
    configs:
      - port: 80
        protocol: http
        algorithm: roundrobin
  register: nodebalancer_result

- name: Create an Instance
  linode.cloud.instance:
    label: my-instance
    region: us-east
    private_ip: true
    type: g6-standard-1
    state: present
  register: instance_result

- name: Attach the Instance to the NodeBalancer
  linode.cloud.nodebalancer_node:
    nodebalancer_id: nodebalancer_result.node_balancer.id
    config_id: nodebalancer_result.configs[0].id

    label: my-node

    # Use the private ip address of the instance
    address: '{{ instance_result.instance.ipv4[1] }}:80'

    state: present

Parameters

Field	Type	Required	Description
nodebalancer_id	int	Required	The ID of the NodeBalancer that contains this node.
config_id	int	Required	The ID of the NodeBalancer Config that contains this node.
label	str	Required	The label for this node. This is used to identify nodes within a config.
state	str	Required	Whether the NodeBalancer node should be present or absent. (Choices: present, absent)
address	str	Optional	The private IP Address where this backend can be reached. This must be a private IP address. (Updatable)
mode	str	Optional	The mode this NodeBalancer should use when sending traffic to this backend. (Choices: accept, reject, drain, backup; Updatable)
weight	int	Optional	Nodes with a higher weight will receive more traffic. (Updatable)

Return Values

• node - The NodeBalancer Node in JSON serialized form.

  • Sample Response:

    {
      "address": "123.123.123.123:80",
      "config_id": 12345,
      "id": 12345,
      "label": "mynode",
      "mode": "accept",
      "nodebalancer_id": 12345,
      "status": "Unknown",
      "weight": 10
    }

  • See the Linode API response documentation for a list of returned fields