os_subnets_facts - Retrieve facts about one or more OpenStack subnets.

New in version 2.0.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
- Status

Synopsis

Retrieve facts about one or more subnets from OpenStack.

Requirements (on host that executes module)

python >= 2.6
python >= 2.7
shade

Options

parameter	required	default	choices	comments
api_timeout	no	None		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	no			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	no	password		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	no			Ignored. Present for backwards compatibility
cacert	no	None		A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
cert	no	None		A path to a client certificate to use as part of the SSL transaction.
cloud	no			Named cloud to operate against. 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.
endpoint_type	no	public	public internal admin	Endpoint URL type to fetch from the service catalog.
filters	no			A dictionary of meta data to use for further filtering. Elements of this dictionary may be additional dictionaries.
key	no	None		A path to a client key to use as part of the SSL transaction.
region_name	no			Name of the region.
subnet	no			Name or ID of the subnet
timeout	no	180		How long should ansible wait for the requested resource.
validate_certs	no			Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True. aliases: verify
wait	no	yes	yes no	Should ansible wait until the requested resource is complete.

Examples

- name: Gather facts about previously created subnets
  os_subnets_facts:
    auth:
      auth_url: https://your_api_url.com:9000/v2.0
      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://your_api_url.com:9000/v2.0
      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://your_api_url.com:9000/v2.0
      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 Return Values, the following are the fields unique to this module:

name

description

returned

type

sample

openstack_subnets

has all the openstack facts about the subnets

always, but can be null

complex

contains:

name	description	returned	type
name	Name given to the subnet.	success	string
enable_dhcp	DHCP enable flag for this subnet.	success	bool
network_id	Network ID this subnet belongs in.	success	string
tenant_id	Tenant id associated with this subnet.	success	string
dns_nameservers	DNS name servers for this subnet.	success	list of strings
allocation_pools	Allocation pools associated with this subnet.	success	list of dicts
gateway_ip	Subnet's gateway ip.	success	string
ip_version	IP version for this subnet.	success	int
cidr	Subnet's CIDR.	success	string
id	Unique UUID.	success	string

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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

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