os_network – Creates/removes networks from OpenStack

Synopsis

  • Add or remove network from OpenStack.

Requirements

The below requirements are needed on the host that executes this module.

  • openstacksdk

  • openstacksdk >= 0.12.0

  • python >= 2.7

Parameters

Parameter Choices/Defaults Comments
admin_state_up
boolean
    Choices:
  • no
  • yes ←
Whether the state should be marked as up or down.
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, os_user_domain_name or os_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
-
Ignored. Present for backwards compatibility
ca_cert
string
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

aliases: cacert
client_cert
string
A path to a client certificate to use as part of the SSL transaction.

aliases: cert
client_key
string
A path to a client key to use as part of the SSL transaction.

aliases: key
cloud
raw
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_domain
-
added in 2.9
The DNS domain value to set. Network will use Openstack defaults if this option is not provided.
external
boolean
    Choices:
  • no ←
  • yes
Whether this network is externally accessible.
interface
string
    Choices:
  • admin
  • internal
  • public ←
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
mtu
integer
added in 2.9
The maximum transmission unit (MTU) value to address fragmentation. Network will use OpenStack defaults if this option is not provided. Requires openstacksdk>=0.18.
name
- / required
Name to be assigned to the network.
port_security_enabled
boolean
added in 2.8
    Choices:
  • no
  • yes
Whether port security is enabled on the network or not. Network will use OpenStack defaults if this option is not utilised. Requires openstacksdk>=0.18.
project
-
Project name or ID containing the network (name admin-only)
provider_network_type
-
The type of physical network that maps to this network resource.
provider_physical_network
-
The physical network where this network object is implemented.
provider_segmentation_id
-
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.
region_name
string
Name of the region.
shared
boolean
    Choices:
  • no ←
  • yes
Whether this network is shared or not.
state
-
    Choices:
  • present ←
  • absent
Indicate desired state of the resource.
timeout
integer
Default:
180
How long should ansible wait for the requested resource.
validate_certs
boolean
    Choices:
  • no ←
  • yes
Whether or not SSL API requests should be verified.
Before Ansible 2.3 this defaulted to yes.

aliases: verify
wait
boolean
    Choices:
  • no
  • yes ←
Should ansible wait until the requested resource is complete.

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'.
- os_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 Returned Description
network
complex
On success when state is 'present'.
Dictionary describing the network.
 
admin_state_up
boolean
The administrative state of the network.

Sample:
True
 
dns_domain
string
The DNS domain of a network resource. Requires openstacksdk>=0.29.

Sample:
sample.openstack.org.
 
id
string
Network ID.

Sample:
4bb4f9a5-3bd2-4562-bf6a-d17a6341bb56
 
mtu
integer
The MTU of a network resource.
 
name
string
Network name.

Sample:
ext_network
 
port_security_enabled
boolean
The port security status

Sample:
True
 
provider:network_type
string
The type of physical network that maps to this network resource.

Sample:
vlan
 
provider:physical_network
string
The physical network where this network object is implemented.

Sample:
my_vlan_net
 
provider:segmentation_id
string
An isolated segment on the physical network.

Sample:
101
 
router:external
boolean
Indicates whether this network is externally accessible.

Sample:
True
 
shared
boolean
Indicates whether this network is shared across all tenants.
 
status
string
Network status.

Sample:
ACTIVE
 
subnets
list
The associated subnets.
 
tenant_id
string
The tenant ID.

Sample:
06820f94b9f54b119636be2728d216fc


Status

Authors

  • Monty Taylor (@emonty)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.