opentelekomcloud.cloud.lb_pool_info (0.14.2) — module

Install collection

Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2

Add to requirements.yml

  collections:
    - name: opentelekomcloud.cloud
      version: 0.14.2

Description

Get Enhanced Load Balancer backend server group from the OTC.

Requirements

• openstacksdk
• openstacksdk >= 0.36.0
• otcextensions
• python >= 3.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Get a lb pool info.
- lb_pool_info:
    name: pool-test
  register: lb_pool_info

Inputs

    
auth:
    description:
    - Dictionary containing auth information as needed by the cloud's auth plugin strategy.
      For the default I(password) plugin, this would contain I(auth_url), I(username),
      I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name)
      or I(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.
    type: dict

name:
    description:
    - Optional name or id of the pool
    type: str

wait:
    default: true
    description:
    - Should ansible wait until the requested resource is complete.
    type: bool

cloud:
    description:
    - Named cloud or cloud config to operate against. If I(cloud) is a string, it references
      a named cloud config as defined in an OpenStack clouds.yaml file. Provides default
      values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is
      provided or if OpenStack OS_* environment variables are present. If I(cloud) is
      a dict, it contains a complete cloud configuration like would be in a section of
      clouds.yaml.
    type: raw

ca_cert:
    aliases:
    - cacert
    description:
    - A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
    type: str

timeout:
    default: 180
    description:
    - How long should ansible wait for the requested resource.
    type: int

auth_type:
    description:
    - 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 I(auth) parameter should be updated accordingly.
    type: str

interface:
    aliases:
    - endpoint_type
    choices:
    - admin
    - internal
    - public
    default: public
    description:
    - Endpoint URL type to fetch from the service catalog.
    type: str

client_key:
    aliases:
    - key
    description:
    - A path to a client key to use as part of the SSL transaction.
    type: str

api_timeout:
    description:
    - 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.
    type: int

client_cert:
    aliases:
    - cert
    description:
    - A path to a client certificate to use as part of the SSL transaction.
    type: str

region_name:
    description:
    - Name of the region.
    type: str

sdk_log_path:
    description:
    - Path to the logfile of the OpenStackSDK. If empty no log is written
    type: str

sdk_log_level:
    choices:
    - ERROR
    - WARN
    - INFO
    - DEBUG
    default: WARN
    description: Log level of the OpenStackSDK
    type: str

validate_certs:
    aliases:
    - verify
    description:
    - Whether or not SSL API requests should be verified.
    - Before Ansible 2.3 this defaulted to C(yes).
    type: bool

Outputs

lb_pool_info:
  contains:
    admin_state_up:
      description: Specifies the administrative status of the backend server group.
      type: bool
    description:
      description: Provides supplementary information about the backend server group.
      type: str
    healthmonitor_id:
      description: Specifies the ID of the health check configured for the backend
        server group.
      type: int
    id:
      description: Specifies the ID of the backend server group.
      sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69
      type: str
    lb_algorithm:
      description: Specifies the load balancing algorithm of the backend server group.
      sample: ROUND_ROBIN
      type: int
    listeners:
      description: Lists the IDs of listeners associated with the backend server group.
      type: list
    loadbalancers:
      description: Lists the IDs of load baancers associated with the backend server
        group.
      type: list
    members:
      description: Lists the IDs of backend servers in the backend server group.
      type: list
    name:
      description: Specifies the backend server group name.
      sample: elb_test_pool
      type: str
    protocol:
      description: Specifies the protocol that the backend server group uses to receive
        requests.
      sample: TCP
      type: str
    session_persistence:
      description: Specifies whether to enable the sticky session feature.
      type: dict
  description: Dictionary describing backend server groups.
  returned: On Success.
  type: complex