opentelekomcloud.cloud.subnet_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 subnet 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 all subnets
- opentelekomcloud.cloud.subnet_info:
  register: subnet_info

Inputs

    
vpc:
    description:
    - Name or id of the vpc subnets should be listed within.
    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

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

name_or_id:
    description:
    - Name or id of the subnet.
    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

subnets:
  contains:
    availability_zone:
      description: Identifies the AZ to which the subnet belongs.
      type: str
    cidr:
      description: Specifies the subnet CIDR block.
      type: str
    description:
      description: Provides supplementary information about the subnet.
      type: str
    dhcp_enable:
      description: Specifies whether the DHCP function is enabled for the subnet.
      type: bool
    dnsList:
      description: Specifies the IP address list of DNS servers on the subnet.
      type: list
    extra_dhcp_opts:
      contains:
        opt_name:
          description: Specifies the NTP server address name configured for the subnet.
          type: str
        opt_value:
          description: Specifies the NTP server address configured for the subnet.
          type: str
      description: Specifies the NTP server address configured for the subnet.
      elements: dict
      type: list
    gateway_ip:
      description: Specifies the subnet gateway address.
      type: str
    id:
      description: Specifies the ID of the subnet.
      type: str
    name:
      description: Specifies the subnets name.
      type: str
    neutron_network_id:
      description: Specifies the ID of the corresponding network (OpenStack Neutron
        API).
      type: str
    neutron_subnet_id:
      description: Specifies the ID of the corresponding subnet (OpenStack Neutron
        API).
      type: str
    primary_dns:
      description: Specifies the IP address of DNS server 1 on the subnet.
      type: str
    secondary_dns:
      description: Specifies the IP address of DNS server 2 on the subnet.
      type: str
    status:
      description: Specifies the status of the subnet.
      type: str
    vpc_id:
      description: Specifies the ID of the VPC to which the subnet belongs.
      type: str
  description: Dictionary describing subnets.
  returned: On Success.
  type: complex