openstack.cloud.subnet module – Add/Remove subnet to an OpenStack network
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.subnet
.
Synopsis
Add or Remove a subnet to an OpenStack network
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
openstacksdk >= 1.0.0
Parameters
Parameter |
Comments |
---|---|
From the subnet pool the last IP that should be assigned to the virtual machines. |
|
From the subnet pool the starting address from which the IP should be allocated. |
|
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. |
|
The CIDR representation of the subnet that should be assigned to the subnet. Required when state is ‘present’ and a subnetpool is not specified. |
|
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. |
|
Description of the subnet |
|
The gateway IP would not be assigned for this subnet Choices:
|
|
List of DNS nameservers for this subnet. |
|
Dictionary with extra key/value pairs passed to the API Default: |
|
The ip that would be assigned to the gateway for this subnet |
|
A list of host route dictionaries for the subnet. |
|
The destination network (CIDR). |
|
The next hop (aka gateway) for the destination. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
The IP version of the subnet 4 or 6 Choices:
|
|
IPv6 address mode Choices:
|
|
IPv6 router advertisement mode Choices:
|
|
Whether DHCP should be enabled for this subnet. Choices:
|
|
The name of the subnet that should be created. Although Neutron allows for non-unique subnet names, this module enforces subnet name uniqueness. |
|
Name or id of the network to which the subnet should be attached Required when state is ‘present’ |
|
The prefix length to use for subnet allocation from a subnet pool |
|
Project name or ID containing the subnet (name admin-only) |
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Indicate desired state of the resource Choices:
|
|
The subnet pool name or ID from which to obtain a CIDR |
|
How long should ansible wait for the requested resource. Default: |
|
Use the default subnetpool for ip_version to obtain a CIDR. Choices:
|
|
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
# Create a new (or update an existing) subnet on the specified network
- openstack.cloud.subnet:
state: present
network_name: network1
name: net1subnet
cidr: 192.168.0.0/24
dns_nameservers:
- 8.8.8.7
- 8.8.8.8
host_routes:
- destination: 0.0.0.0/0
nexthop: 12.34.56.78
- destination: 192.168.0.0/24
nexthop: 192.168.0.1
# Delete a subnet
- openstack.cloud.subnet:
state: absent
name: net1subnet
# Create an ipv6 stateless subnet
- openstack.cloud.subnet:
state: present
name: intv6
network_name: internal
ip_version: 6
cidr: 2db8:1::/64
dns_nameservers:
- 2001:4860:4860::8888
- 2001:4860:4860::8844
ipv6_ra_mode: dhcpv6-stateless
ipv6_address_mode: dhcpv6-stateless
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Id of subnet Returned: On success when subnet exists. |
|
Dictionary describing the subnet. Returned: On success when subnet exists. |
|
Allocation pools associated with this subnet. Returned: success |
|
Subnet’s CIDR. Returned: success |
|
Created at timestamp Returned: success |
|
Description Returned: success |
|
DNS name servers for this subnet. Returned: success |
|
Whether to publish DNS records for fixed IPs. Returned: success |
|
Subnet’s gateway ip. Returned: success |
|
A list of host routes. Returned: success |
|
Unique UUID. Returned: success |
|
IP version for this subnet. Returned: success |
|
The IPv6 address modes which are ‘dhcpv6-stateful’, ‘dhcpv6-stateless’ or ‘slaac’. Returned: success |
|
The IPv6 router advertisements modes which can be ‘slaac’, ‘dhcpv6-stateful’, ‘dhcpv6-stateless’. Returned: success |
|
DHCP enable flag for this subnet. 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 |
|
Project id associated with this subnet. Returned: success |
|
Revision number of the resource Returned: success |
|
The ID of the segment this subnet is associated with. Returned: success |
|
Service types for this subnet Returned: success |
|
The subnet pool ID from which to obtain a CIDR. Returned: success |
|
Tags Returned: success |
|
Timestamp when the subnet was last updated. Returned: success |
|
Whether to use the default subnet pool to obtain a CIDR. Returned: success |