lb_member_info

updated: None

lb_member_info

Note

This plugin is part of the opentelekomcloud.cloud collection (version 0.0.1).

To install it use: ansible-galaxy collection install opentelekomcloud.cloud.

To use it in a playbook, specify: opentelekomcloud.cloud.lb_member_info.

New in version 0.0.3: of opentelekomcloud.cloud

Synopsis

  • Get Enhanced Load Balancer members from the OTC.

Requirements

The below requirements are needed on the host that executes this module.

  • openstacksdk

  • openstacksdk >= 0.36.0

  • otcextensions

  • python >= 3.6

Parameters

Parameter Choices/Defaults Comments
address
string
Optional the private IP address of the backend server.
admin_state_up
boolean
    Choices:
  • no
  • yes
Optional the administrative status of the backend server.
api_timeout
integer
How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.
auth
dictionary
Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or os_project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.
auth_type
string
Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.
ca_cert
string
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

aliases: cacert
client_cert
string
A path to a client certificate to use as part of the SSL transaction.

aliases: cert
client_key
string
A path to a client key to use as part of the SSL transaction.

aliases: key
cloud
raw
Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.
interface
string
    Choices:
  • admin
  • internal
  • public ←
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
name
string
Optional name or id of the member.
pool
string / required
Specifies the ID or Name of the backend server group.
project_id
string
Optional the ID of the project where the backend server is used.
protocol_port
integer
Optional the port used by the backend server.
region_name
string
Name of the region.
subnet
string
Optional the ID or Name of the subnet where the backend server works.
timeout
integer
Default:
180
How long should ansible wait for the requested resource.
validate_certs
boolean
    Choices:
  • no ←
  • yes
Whether or not SSL API requests should be verified.
Before Ansible 2.3 this defaulted to yes.

aliases: verify
wait
boolean
    Choices:
  • no
  • yes ←
Should ansible wait until the requested resource is complete.
weight
integer
Optional the backend server weight.

Notes

Note

  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

  • Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

Examples

# Get a lb member info.
- lb_member_info:
    name: member-test
  register: lb_mmbr_info

Return Values

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

Key Returned Description
members
complex
On Success.
Dictionary describing members.
 
address
string
success
Specifies the private IP address of the backend server.
 
admin_state_up
boolean
success
Specifies the administrative status of the backend server.
 
id
string
success
Specifies the backend server ID.

Sample:
39007a7e-ee4f-4d13-8283-b4da2e037c69
  members_links
list / elements=string
success
Provides links to the previous or next page during pagination query, respectively.
 
name
string
success
Specifies the backend server name.

Sample:
bs_test
 
operating_status
string
success
Specifies the health check result of the backend server.
 
protocol_port
integer
success
Specifies the port used by the backend server.
 
subnet_id
string
success
Specifies the ID of the subnet where the backend server works.
 
weight
integer
success
Specifies the backend server weight.


Authors

  • Anton Sidelnikov (@anton-sidelnikov)

updated: None