Skip to content

Latest commit

 

History

History
133 lines (110 loc) · 4.52 KB

nodebalancer_info.md

File metadata and controls

133 lines (110 loc) · 4.52 KB
Raw

nodebalancer_info

Get info about a Linode NodeBalancer.

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: Get a NodeBalancer by its id
  linode.cloud.nodebalancer_info:
    id: 12345
- name: Get a NodeBalancer by its label
  linode.cloud.nodebalancer_info:
    label: cool_nodebalancer

Parameters

Field Type Required Description
id int Optional The ID of this NodeBalancer. Optional if label is defined. (Conflicts With: label)
label str Optional The label of this NodeBalancer. Optional if id is defined. (Conflicts With: id)

Return Values

  • node_balancer - The NodeBalancer in JSON serialized form.

    • Sample Response: 
      {
  "client_conn_throttle": 0,
  "created": "2018-01-01T00:01:01",
  "hostname": "192.0.2.1.ip.linodeusercontent.com",
  "id": 12345,
  "ipv4": "12.34.56.78",
  "ipv6": null,
  "label": "balancer12345",
  "region": "us-east",
  "tags": [
    "example tag",
    "another example"
  ],
  "transfer": {
    "in": 28.91200828552246,
    "out": 3.5487728118896484,
    "total": 32.46078109741211
  },
  "updated": "2018-03-01T00:01:01"
}
    • See the Linode API response documentation for a list of returned fields

  • configs - A list of configs applied to the NodeBalancer.

    • Sample Response: 
      [
  {
    "algorithm": "roundrobin",
    "check": "http_body",
    "check_attempts": 3,
    "check_body": "it works",
    "check_interval": 90,
    "check_passive": true,
    "check_path": "/test",
    "check_timeout": 10,
    "cipher_suite": "recommended",
    "id": 4567,
    "nodebalancer_id": 12345,
    "nodes_status": {
      "down": 0,
      "up": 4
    },
    "port": 80,
    "protocol": "http",
    "proxy_protocol": "none",
    "ssl_cert": null,
    "ssl_commonname": null,
    "ssl_fingerprint": null,
    "ssl_key": null,
    "stickiness": "http_cookie"
  }
]
    • See the Linode API response documentation for a list of returned fields

  • nodes - A list of configs applied to the NodeBalancer.

    • Sample Response: 
      [
  {
    "address": "192.168.210.120:80",
    "config_id": 4567,
    "id": 54321,
    "label": "node54321",
    "mode": "accept",
    "nodebalancer_id": 12345,
    "status": "UP",
    "weight": 50
  }
]
    • See the Linode API response documentation for a list of returned fields

  • firewalls - A list IDs for firewalls attached to this NodeBalancer.