openstack.cloud.subnet module – Add/Remove subnet to an OpenStack network

Note

This module is part of the openstack.cloud collection (version 1.10.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.

  • openstacksdk

  • openstacksdk >= 0.36, < 0.99.0

  • python >= 3.6

Parameters

Parameter

Comments

allocation_pool_end

string

From the subnet pool the last IP that should be assigned to the virtual machines.

allocation_pool_start

string

From the subnet pool the starting address from which the IP should be allocated.

api_timeout

integer

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

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.

auth_type

string

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

string

Ignored. Present for backwards compatibility

ca_cert

aliases: cacert

string

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

cidr

string

The CIDR representation of the subnet that should be assigned to the subnet. Required when state is ‘present’ and a subnetpool is not specified.

client_cert

aliases: cert

string

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

client_key

aliases: key

string

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

cloud

any

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.

dns_nameservers

list / elements=string

List of DNS nameservers for this subnet.

enable_dhcp

boolean

Whether DHCP should be enabled for this subnet.

Choices:

  • false

  • true ← (default)

extra_specs

dictionary

Dictionary with extra key/value pairs passed to the API

Default: {}

gateway_ip

string

The ip that would be assigned to the gateway for this subnet

host_routes

list / elements=dictionary

A list of host route dictionaries for the subnet.

destination

string / required

The destination network (CIDR).

nexthop

string / required

The next hop (aka gateway) for the destination.

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • "admin"

  • "internal"

  • "public" ← (default)

ip_version

string

The IP version of the subnet 4 or 6

Choices:

  • "4" ← (default)

  • "6"

ipv6_address_mode

string

IPv6 address mode

Choices:

  • "dhcpv6-stateful"

  • "dhcpv6-stateless"

  • "slaac"

ipv6_ra_mode

string

IPv6 router advertisement mode

Choices:

  • "dhcpv6-stateful"

  • "dhcpv6-stateless"

  • "slaac"

name

string / required

The name of the subnet that should be created. Although Neutron allows for non-unique subnet names, this module enforces subnet name uniqueness.

network_name

string

Name of the network to which the subnet should be attached

Required when state is ‘present’

no_gateway_ip

boolean

The gateway IP would not be assigned for this subnet

Choices:

  • false ← (default)

  • true

project

string

Project name or ID containing the subnet (name admin-only)

region_name

string

Name of the region.

sdk_log_level

string

Log level of the OpenStackSDK

Choices:

  • "INFO" ← (default)

  • "DEBUG"

sdk_log_path

string

Path to the logfile of the OpenStackSDK. If empty no log is written

state

string

Indicate desired state of the resource

Choices:

  • "present" ← (default)

  • "absent"

timeout

integer

How long should ansible wait for the requested resource.

Default: 180

use_default_subnetpool

boolean

Use the default subnetpool for ip_version to obtain a CIDR.

Choices:

  • false ← (default)

  • true

validate_certs

aliases: verify

boolean

Whether or not SSL API requests should be verified.

Before Ansible 2.3 this defaulted to yes.

Choices:

  • false

  • true

wait

boolean

Should ansible wait until the requested resource is complete.

Choices:

  • false

  • true ← (default)

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

Authors

  • OpenStack Ansible SIG