Give Feedback

load_balancers_info

Generated on 4 Jul 2025 from digitalocean.cloud version v1.2.1

Synopsis

Retrieve a list of all of the load balancers in your account. View the API documentation at (https://docs.digitalocean.com/reference/api/api-reference/#operation/loadBalancers_list).

Parameter	Choices / Default	Description
`client_override_options` dict		Client override options (developer use). For example, can be used to override the DigitalOcean API endpoint for an internal test suite. If provided, these options will knock out existing options.
`module_override_options` dict		Module override options (developer use). Can be used to override module options to support experimental or future options. If provided, these options will knock out existing options.
`state` str	Choices: `present` (default) `absent`	State of the resource, `present` to create, `absent` to destroy.
`timeout` int	Default: `300`	Polling timeout in seconds.
`token` str		DigitalOcean API token. There are several environment variables which can be used to provide this value. `DIGITALOCEAN_ACCESS_TOKEN`, `DIGITALOCEAN_TOKEN`, `DO_API_TOKEN`, `DO_API_KEY`, `DO_OAUTH_TOKEN` and `OAUTH_TOKEN`

- name: Get load balancers
  digitalocean.cloud.load_balancers_info:
    token: "{{ token }}"

Key	Returned	Description
`error` dict	failure	DigitalOcean API error. Sample: `{ "Message": "Informational error message.", "Reason": "Unauthorized", "Status Code": 401 }`
`load_balancers` list	always	Load balancers.
`msg` str	always	Domain result information. Sample: `[ "Current domains", "No domains" ]`