opentelekomcloud.cloud.loadbalancer_v3_info (0.14.2) — module

Get load balancer (VLB) from OpenTelekomCloud

| "added in version" 0.14.0 of opentelekomcloud.cloud"

Authors: Polina Gubina (@polina-gubina)

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 info about Dedicated Load Balancer from the OTC service (VLB).


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get all loadbalancers
- opentelekomcloud.cloud.loadbalancer_v3_info:
  register: loadbalancers
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get filtered loadbalancers
- opentelekomcloud.cloud.loadbalancer_v3_info:
    vpc: 16dbd25d-c55c-405b-9e56-11b03e7e7dc1
    eips: []
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get one loadbalancer by name or id
- opentelekomcloud.cloud.loadbalancer_v3_info:
    name_or_id: 16dbd25d-c55c-405b-9e56-11b03e7e7dc1
  register: loadbalancer

Inputs

    
vpc:
    description:
    - Specifies the name or ID of the VPC where the load balancer works.
    type: str

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

eips:
    description:
    - Specifies the EIP bound to the load balancer.
    elements: str
    type: list

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

limit:
    description:
    - Specifies the number of records on each page. Minimum 0. Maximum 2000.
    type: int

marker:
    description:
    - Specifies the ID of the last record on the previous page.
    - This parameter must be used together with limit.
    - If this parameter is not specified, the first page will be queried.
    - This parameter cannot be left blank or set to an invalid ID.
    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

port_id:
    description:
    - Specifies the ID of the port bound to the virtual IP address of the load balancer.
    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

publicips:
    description:
    - Specifies the public IP address bound to the load balancer.
    elements: str
    type: list

subnet_id:
    description:
    - Specifies the ID of the subnet where the load balancer works.
    type: str

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

ip_address:
    description:
    - Specifies the virtual IP address bound to the load balancer.
    type: str

ip_version:
    description:
    - Specifies the IP version. The value can be only 4 (IPv4).
    type: int

name_or_id:
    description: Specifies the load balancer name or ID.
    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

description:
    description:
    - Provides supplementary information about the load balancer.
    type: str

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

l4_flavor_id:
    description:
    - Specifies the ID of the flavor at Layer 4.
    type: str

l7_flavor_id:
    description:
    - Specifies the ID of the flavor at Layer 7.
    type: str

page_reverse:
    description:
    - Specifies the page direction.
    - Default is false.
    - This parameter must be used together with limit.
    - The last page in the list requested with page_reverse set to false will not contain
      the "next" link, and the last page in the list requested with page_reverse set to
      true will not contain the "previous" link.
    type: bool

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

member_address:
    description:
    - Specifies the private IP address of the backend server.
    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

member_device_id:
    description:
    - Specifies the ID of the cloud server that serves as a backend server. This parameter
      is used only as a query condition and is not included in the response.
    type: str

operating_status:
    description:
    - Specifies the operating status of the load balancer. The value can only be ONLINE,
      indicating that the load balancer is working normally.
    type: str

availability_zones:
    description:
    - Specifies the list of AZs where the load balancer is created.
    elements: str
    type: list

elb_virsubnet_type:
    description:
    - Specifies the type of the subnet on the downstream plane.
    - ipv4 IPv4 subnets.
    - dualstack subnets that support IPv4/IPv6 dual stack.
    - IPv6 is unsupported. The value cannot be 6.
    type: str

l4_scale_flavor_id:
    description:
    - Specifies the elastic flavor that is reserved for now.
    type: str

l7_scale_flavor_id:
    description:
    - Specifies the elastic flavor that is reserved for now.
    type: str

provisioning_status:
    description:
    - Specifies the provisioning status of the load balancer. The value can only be ACTIVE,
      indicating that the load balancer is provisioned successfully.
    type: str

Outputs

loadbalancers:
  contains:
    availability_zones:
      description:
      - Specifies the list of AZs where the load balancer is created.
      type: list
    created_at:
      description: Specifies the time when the load balancer was created.
      type: str
    description:
      description: Provides supplementary information about the load balancer.
      type: str
    eips:
      contains:
        eip_address:
          description: Specifies the specific IP address.
          type: str
        eip_id:
          description: Specifies the EIP ID.
          type: str
        ip_version:
          description:
          - Specifies the IP version. 4 indicates IPv4, and 6 indicates IPv6.
          type: int
      description: Specifies the EIP bound to the load balancer.
      elements: dict
      type: list
    floating_ips:
      contains:
        ip_version:
          description:
          - Specifies the IP version. The value can be 4 (IPv4) or 6 (IPv6).
          type: int
        publicip_address:
          description: Specifies the IP address.
          type: str
        publicip_id:
          description: Specifies the EIP ID.
          type: str
      description:
      - Specifies the EIP bound to the load balancer.
      elements: dict
      type: list
    guaranteed:
      description:
      - Specifies whether the load balancer is a dedicated load balancer.
      - The value can be true or false. true indicates a dedicated load balancer,
        and false indicates a shared load balancer. When dedicated load balancers
        are launched in the eu-de region, either true or false will be returned when
        you use the API to query or update a load balancer.
      type: bool
    id:
      description: Unique UUID.
      type: str
    ip_address:
      description:
      - Specifies the private IPv4 address bound to the load balancer.
      type: str
    l4_flavor_id:
      description:
      - Specifies the Layer-4 flavor.
      type: str
    l4_scale_flavor_id:
      description:
      - Specifies the reserved Layer 4 flavor.
      type: str
    l7_flavor_id:
      description:
      - Specifies the Layer-7 flavor.
      type: str
    l7_scale_flavor_id:
      description:
      - Specifies the reserved Layer 7 flavor.
      type: str
    listeners:
      contains:
        id:
          description: ID of the listener.
          type: str
      description: Lists the IDs of listeners added to the load balancer.
      elements: dict
      type: list
    name:
      description: Specifies the name of the load balancer.
      type: str
    network_ids:
      description:
      - Specifies the ID of the subnet on the downstream plane.
      - The ports used by the load balancer dynamically occupy IP addresses. in the
        subnet.
      type: list
    operating_status:
      description:
      - Specifies the operating status of the load balancer. The value can only be
        ONLINE.
      type: str
    pools:
      contains:
        id:
          description: ID of the pool.
          type: str
      description:
      - Lists the IDs of backend server groups associated with the load balancer.
      elements: dict
      type: list
    port_id:
      description:
      - Specifies the ID of the port bound to the virtual IP address (the value of
        vip_address) of the load balancer.
      type: str
    project_id:
      description: Specifies the project ID of the load balancer.
      type: str
    provider:
      description:
      - Specifies the provider of the load balancer. The value can only be vlb.
      type: str
    provisioning_status:
      description:
      - Specifies the provisioning status of the load balancer.
      - The value can only be ACTIVE.
      type: str
    subnet_id:
      description:
      - Specifies the ID of the IPv4 subnet where the load balancer works.
      type: str
    tags:
      contains:
        key:
          description: Key of the tag.
          type: str
        value:
          description: Value of the tag.
          type: str
      description: Lists the tags added to the load balancer.
      elements: dict
      type: list
    updated_at:
      description: Specifies the time when the load balancer was updated.
      type: str
    vpc_id:
      description: Specifies the ID of the VPC where the load balancer works.
      type: str
  description: Dictionary describing the load balancer.
  returned: On success when C(state=present)
  type: complex