vultr.cloud.load_balancer_info module – Get information about Vultr load balancers

Note

This module is part of the vultr.cloud collection (version 1.14.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vultr.cloud.

To use it in a playbook, specify: vultr.cloud.load_balancer_info.

New in vultr.cloud 1.14.0

Synopsis

  • Retrieve details about load balancers on Vultr.

Parameters

Parameter

Comments

api_endpoint

string

URL to API endpint (without trailing slash).

Fallback environment variable VULTR_API_ENDPOINT.

Default: "https://api.vultr.com/v2"

api_key

string / required

API key of the Vultr API.

Fallback environment variable VULTR_API_KEY.

api_results_per_page

integer

added in vultr.cloud 1.14.0

When receiving large numbers of resources, specify how many results should be returned per call to API.

This does not determine how many results are returned; all resources are returned according to other filters.

Vultr API maximum is 500.

Fallback environment variable VULTR_API_RESULTS_PER_PAGE.

Default: 100

api_retries

integer

Amount of retries in case of the Vultr API retuns an HTTP error code, such as - 429 Too Many Requests - 500 Internal Server Error - 504 Gateway Time-out

Fallback environment variable VULTR_API_RETRIES.

Default: 5

api_retry_max_delay

integer

Retry backoff delay in seconds is exponential up to this max. value, in seconds.

Fallback environment variable VULTR_API_RETRY_MAX_DELAY.

Default: 12

api_timeout

integer

HTTP timeout to Vultr API.

Fallback environment variable VULTR_API_TIMEOUT.

Default: 180

validate_certs

boolean

Validate SSL certs of the Vultr API.

Choices:

  • false

  • true ← (default)

Notes

Note

Examples

---
- name: Get Vultr load balancer information
  vultr.cloud.load_balancer_info:
  register: result

- name: Print the information
  ansible.builtin.debug:
  var: result.vultr_load_balancer_info

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

vultr_api

dictionary

Response from Vultr API with additional details.

Returned: success

auto_ssl

dictionary

Auto SSL configuration for the load balancer.

Returned: success

date_created

string

Date and time when the load balancer was created.

Returned: success

Sample: "2020-10-10T01:56:20+00:00"

firewall_rules

list / elements=dictionary

Firewall rules applied to the load balancer.

Returned: success

forwarding_rules

list / elements=dictionary

List of forwarding rules for the load balancer.

Returned: success

generic_info

dictionary

Generic information about the load balancer.

Returned: success

global_regions

list / elements=string

Global regions configuration for the load balancer.

Returned: success

has_ssl

boolean

Whether SSL is enabled for the load balancer.

Returned: success

Sample: false

health_check

dictionary

Health check configuration for the load balancer.

Returned: success

http2

boolean

Whether HTTP/2 is enabled.

Returned: success

Sample: false

http3

boolean

Whether HTTP/3 is enabled.

Returned: success

Sample: false

id

string

Unique ID of the load balancer.

Returned: success

Sample: "cb67a646-66fd-4dfb-b839-443f2e6c0b60"

instances

list / elements=string

List of instances attached to the load balancer.

Returned: success

ipv4

string

IPv4 address of the load balancer.

Returned: success

Sample: "192.0.2.1"

ipv6

string

IPv6 address of the load balancer.

Returned: success

Sample: "2001:db8::1"

label

string

Label of the load balancer.

Returned: success

Sample: "Example Load Balancer"

node_ips

list / elements=string

List of node IPs in the load balancer.

Returned: success

nodes

integer

Number of nodes in the load balancer.

Returned: success

Sample: 1

region

string

Region of the load balancer.

Returned: success

Sample: "ewr"

status

string

Status of the load balancer.

Returned: success

Sample: "pending"

Authors

  • Garrett Haughawout (@ghaughawout)