openstack.cloud.network module – Creates/removes networks 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.network
.
Synopsis
Add, update or remove network 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 |
---|---|
Whether the state should be marked as up or down. Choices:
|
|
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 DNS domain value to set. Network will use Openstack defaults if this option is not provided. |
|
Whether this network is externally accessible. Choices:
|
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
The maximum transmission unit (MTU) value to address fragmentation. Network will use OpenStack defaults if this option is not provided. |
|
Name to be assigned to the network. |
|
Whether port security is enabled on the network or not. Network will use OpenStack defaults if this option is not utilised. Choices:
|
|
Project name or ID containing the network (name admin-only) |
|
The type of physical network that maps to this network resource. |
|
The physical network where this network object is implemented. |
|
An isolated segment on the physical network. The network_type attribute defines the segmentation model. For example, if the network_type value is vlan, this ID is a vlan identifier. If the network_type value is gre, this ID is a gre key. |
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Whether this network is shared or not. Choices:
|
|
Indicate desired state of the resource. 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
# Create an externally accessible network named 'ext_network'.
- openstack.cloud.network:
cloud: mycloud
state: present
name: ext_network
external: true
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Id of network Returned: On success when network exists. |
|
Dictionary describing the network. Returned: On success when network exists. |
|
Availability zone hints Returned: success |
|
Availability zones Returned: success |
|
Created at timestamp Returned: success |
|
Description Returned: success |
|
Dns domain Returned: success |
|
Id Returned: success |
|
Ipv4 address scope id Returned: success |
|
Ipv6 address scope id Returned: success |
|
Is admin state up Returned: success |
|
Is default Returned: success |
|
Is port security enabled Returned: success |
|
Is router external Returned: success |
|
Is shared Returned: success |
|
Is vlan transparent Returned: success |
|
Mtu Returned: success |
|
Name Returned: success |
|
Project id Returned: success |
|
Provider network type Returned: success |
|
Provider physical network Returned: success |
|
Provider segmentation id Returned: success |
|
Qos policy id Returned: success |
|
Revision number Returned: success |
|
Segments Returned: success |
|
Status Returned: success |
|
Subnet ids Returned: success |
|
Tags Returned: success |
|
Updated at timestamp Returned: success |