os_subnets_facts – Retrieve facts about one or more OpenStack subnets.

From Get docs
Ansible/docs/2.7/modules/os subnets facts module


os_subnets_facts – Retrieve facts about one or more OpenStack subnets.

New in version 2.0.


Synopsis

  • Retrieve facts about one or more subnets from OpenStack.

Requirements

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

  • openstacksdk
  • python >= 2.7

Parameters

Parameter Choices/Defaults Comments

api_timeout

-

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 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 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

-

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.

availability_zone

-

Ignored. Present for backwards compatibility

cacert

-

A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

cert

-

A path to a client certificate to use as part of the SSL transaction.

cloud

-

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.

filters

-

A dictionary of meta data to use for further filtering. Elements of this dictionary may be additional dictionaries.

interface

-

added in 2.3

  • public

  • internal
  • admin

Endpoint URL type to fetch from the service catalog.


aliases: endpoint_type

key

-

A path to a client key to use as part of the SSL transaction.

region_name

-

Name of the region.

subnet

-

Name or ID of the subnet

timeout

-

Default:

180

How long should ansible wait for the requested resource.

verify

boolean

  • no
  • yes

Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.


aliases: validate_certs

wait

boolean

  • no
  • yes

Should ansible wait until the requested resource is complete.



Notes

Note

  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.
  • Auth information is driven by os-client-config, 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 http://docs.openstack.org/developer/os-client-config


Examples

- name: Gather facts about previously created subnets
  os_subnets_facts:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject

- name: Show openstack subnets
  debug:
    var: openstack_subnets

- name: Gather facts about a previously created subnet by name
  os_subnets_facts:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
    name: subnet1

- name: Show openstack subnets
  debug:
    var: openstack_subnets

- name: Gather facts about a previously created subnet with filter
  # Note: name and filters parameters are not mutually exclusive
  os_subnets_facts:
    auth:
      auth_url: https://identity.example.com
      username: user
      password: password
      project_name: someproject
    filters:
      tenant_id: 55e2ce24b2a245b09f181bf025724cbe

- name: Show openstack subnets
  debug:
    var: openstack_subnets

Return Values

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

Key Returned Description

openstack_subnets

complex

always, but can be null

has all the openstack facts about the subnets


allocation_pools

list of dicts

success

Allocation pools associated with this subnet.


cidr

string

success

Subnet's CIDR.


dns_nameservers

list of strings

success

DNS name servers for this subnet.


enable_dhcp

boolean

success

DHCP enable flag for this subnet.


gateway_ip

string

success

Subnet's gateway ip.


id

string

success

Unique UUID.


ip_version

integer

success

IP version for this subnet.


name

string

success

Name given to the subnet.


network_id

string

success

Network ID this subnet belongs in.


tenant_id

string

success

Tenant id associated with this subnet.





Status

Authors

  • Davide Agnello (@dagnello)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/os_subnets_facts_module.html