openstack.cloud.subnets_info module – Retrieve information about one or more OpenStack subnets.
Note
This module is part of the openstack.cloud collection (version 2.2.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install openstack.cloud
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: openstack.cloud.subnets_info
.
Synopsis
Retrieve information about one or more subnets from OpenStack.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
openstacksdk >= 1.0.0
Parameters
Parameter |
Comments |
---|---|
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. |
|
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 (for example, user_domain_name or 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. |
|
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. |
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests. |
|
A path to a client certificate to use as part of the SSL transaction. |
|
A path to a client key to use as part of the SSL transaction. |
|
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. |
|
A dictionary of meta data to use for further filtering. Elements of this dictionary may be additional dictionaries. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Name or ID of the subnet. Alias ‘subnet’ added in version 2.8. |
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
How long should ansible wait for the requested resource. Default: |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Should ansible wait until the requested resource is complete. Choices:
|
Notes
Note
The standard OpenStack environment variables, such as
OS_USERNAME
may be used instead of providing explicit values.Auth information is driven by openstacksdk, 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 https://docs.openstack.org/openstacksdk/
Examples
- name: Gather information about previously created subnets
openstack.cloud.subnets_info:
auth:
auth_url: https://identity.example.com
username: user
password: password
project_name: someproject
register: result
- name: Show openstack subnets
debug:
msg: "{{ result.subnets }}"
- name: Gather information about a previously created subnet by name
openstack.cloud.subnets_info:
auth:
auth_url: https://identity.example.com
username: user
password: password
project_name: someproject
name: subnet1
register: result
- name: Show openstack subnets
debug:
msg: "{{ result.subnets }}"
- name: Gather information about a previously created subnet with filter
# Note: name and filters parameters are not mutually exclusive
openstack.cloud.subnets_info:
auth:
auth_url: https://identity.example.com
username: user
password: password
project_name: someproject
filters:
project_id: 55e2ce24b2a245b09f181bf025724cbe
register: result
- name: Show openstack subnets
debug:
msg: "{{ result.subnets }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
has all the openstack information about the subnets Returned: always, but can be empty list |
|
Allocation pools associated with this subnet. Returned: success |
|
Subnet’s CIDR. Returned: success |
|
Date and time when the resource was created. Returned: success |
|
Description of the subnet. Returned: success |
|
DNS name servers for this subnet. Returned: success |
|
Whether to publish DNS records for IPs from this subnet. Returned: success |
|
Subnet’s gateway ip. Returned: success |
|
Additional routes for the subnet. Returned: success |
|
The ID of the subnet. Returned: success |
|
IP version for this subnet. Returned: success |
|
The IPv6 address modes specifies mechanisms for assigning IP addresses. Returned: success |
|
The IPv6 router advertisement specifies whether the networking service should transmit ICMPv6 packets, for a subnet. Returned: success |
|
Is DHCP enabled. Returned: success |
|
Name given to the subnet. Returned: success |
|
Network ID this subnet belongs in. Returned: success |
|
The prefix length to use for subnet allocation from a subnet pool. Returned: success |
|
The ID of the project. Returned: success |
|
The revision number of the resource. Returned: success |
|
The ID of a network segment the subnet is associated with. Returned: success |
|
The service types associated with the subnet. Returned: success |
|
The ID of the subnet pool associated with the subnet. Returned: success |
|
The list of tags on the resource. Returned: success |
|
Date and time when the resource was updated. Returned: success |
|
Whether to use the default subnet pool to obtain a CIDR. Returned: success |