openstack.cloud.subnet_pool module – Create, update or delete a subnet pool from OpenStack
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_pool
.
Synopsis
Create, update or delete a subnet pool 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 |
---|---|
ID or name of the address scope associated with this subnet pool. |
|
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. |
|
The prefix length to allocate when the cidr or prefixlen attributes are omitted when creating a subnet. |
|
A per-project quota on the prefix space that can be allocated from the subnet pool for project subnets. |
|
The subnet pool description. |
|
Dictionary with extra key/value pairs passed to the API. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Whether this subnet pool is the default. Choices:
|
|
Whether this subnet pool is shared or not. This attribute cannot be updated. Choices:
|
|
The maximum prefix length that can be allocated from the subnet pool. |
|
The minimum prefix length that can be allocated from the subnet pool. |
|
Name to be give to the subnet pool. This attribute cannot be updated. |
|
Subnet pool prefixes in CIDR notation. |
|
Name or ID of the project. |
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Whether the subnet pool should be Choices:
|
|
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: Create an subnet pool.
openstack.cloud.subnet_pool:
cloud: mycloud
state: present
name: my_subnet_pool
prefixes:
- 10.10.10.0/24
- name: Create a subnet pool for a given project.
openstack.cloud.subnet_pool:
cloud: mycloud
state: present
name: my_subnet_pool
project: myproj
prefixes:
- 10.10.10.0/24
- name: Create a shared and default subnet pool in existing address scope
openstack.cloud.subnet_pool:
cloud: mycloud
state: present
name: my_subnet_pool
address_scope: my_adress_scope
is_default: True
default_quota: 10
maximum_prefix_length: 32
minimum_prefix_length: 8
default_prefix_length: 24
is_shared: True
prefixes:
- 10.10.10.0/8
- name: Delete subnet poool.
openstack.cloud.subnet_pool:
cloud: mycloud
state: absent
name: my_subnet_pool
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Dictionary describing the subnet pool. Returned: On success when state is |
|
The address scope ID. Returned: success Sample: |
|
Timestamp when the subnet pool was created. Returned: success Sample: |
|
The length of the prefix to allocate when the cidr or prefixlen attributes are omitted when creating a subnet. Returned: success Sample: |
|
The per-project quota on the prefix space that can be allocated from the subnet pool for project subnets. Returned: success Sample: |
|
The subnet pool description. Returned: success Sample: |
|
Subnet Pool ID. Returned: success Sample: |
|
The IP version of the subnet pool 4 or 6. Returned: success Sample: |
|
Indicates whether this is the default subnet pool. Returned: success Sample: |
|
Indicates whether this subnet pool is shared across all projects. Returned: success Sample: |
|
The maximum prefix length that can be allocated from the subnet pool. Returned: success Sample: |
|
The minimum prefix length that can be allocated from the subnet pool. Returned: success Sample: |
|
Subnet Pool name. Returned: success Sample: |
|
A list of subnet prefixes that are assigned to the subnet pool. Returned: success Sample: |
|
The ID of the project. Returned: success Sample: |
|
Revision number of the subnet pool. Returned: success Sample: |
|
A list of associated tags. Returned: success |
|
The ID of the project. Deprecated. Returned: success Sample: |
|
Timestamp when the subnet pool was last updated. Returned: success |