opentelekomcloud.cloud.lb_member (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

Add or Remove a member for a pool for Enhanced Load Balancer from the OTC load-balancer service(ELB).

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.

# Add a server group member to load balancer.
- opentelekomcloud.cloud.lb_member:
    state: present
    name: member
    pool: "{{ pool }}"
    address: "{{ server_address }}"
    subnet: "{{ subnet_name_id }}"
    protocol_port: 8080

Scanned by Steampunk Spotter

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

# Delete a server group member from load balancer.
- opentelekomcloud.cloud.lb_member:
    state: absent
    name: member
    pool: pool

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:
    - Specifies the backend server name.
    required: true
    type: str

pool:
    description:
    - Specifies the ID or Name of the backend server group.
    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

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Should the resource be present or absent.
    type: str

subnet:
    description:
    - Specifies the ID or Name of the subnet where the backend server works.
    type: str

weight:
    description:
    - Specifies the backend server weight.
    type: int

address:
    description:
    - Specifies the private IP address of the backend server.
    type: str

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

protocol_port:
    description:
    - Specifies the port used by the backend server.
    type: int

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

admin_state_up:
    description:
    - Specifies the administrative status of the backend server.
    type: bool

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

member:
  contains:
    address:
      description: Specifies the private IP address of the backend server.
      sample: 192.168.0.10
      type: str
    admin_state_up:
      description: Specifies the administrative status of the backend server.
      type: bool
    id:
      description: Specifies the backend server ID.
      sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69
      type: str
    name:
      description: Specifies the backend server name.
      sample: server_test
      type: str
    operating_status:
      description: Specifies the health check result of the backend server.
      type: int
    protocol_port:
      description: Specifies the port used by the backend server.
      sample: 8080
      type: int
    subnet_id:
      description: Specifies the ID of the subnet where the backend server works.
      type: str
    weight:
      description: Specifies the backend server weight.
      type: int
  description: Specifies the member.
  returned: On Success.
  type: complex