os_network - Creates/removes networks from OpenStack

New in version 2.0.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
This is a Core Module

Synopsis

Add or remove network from OpenStack.

Requirements (on host that executes module)

python >= 2.7

shade

Options

parameter	required	default	choices	comments
admin_state_up	no	True		Whether the state should be marked as up or down.
api_timeout	no	None		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	no			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 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	no	password		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	no			Name of the availability zone.
cacert	no	None		A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
cert	no	None		A path to a client certificate to use as part of the SSL transaction
cloud	no			Named cloud to operate against. 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.
endpoint_type	no	public	public internal admin	Endpoint URL type to fetch from the service catalog.
external	no			Whether this network is externally accessible.
key	no	None		A path to a client key to use as part of the SSL transaction
name	yes			Name to be assigned to the network.
provider_network_type (added in 2.1)	no	None	flat vlan vxlan gre	The type of physical network that maps to this network resource.
provider_physical_network (added in 2.1)	no	None		The physical network where this network object is implemented.
provider_segmentation_id (added in 2.1)	no	None		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	no			Name of the region.
shared	no			Whether this network is shared or not.
state	no	present	present absent	Indicate desired state of the resource.
timeout	no	180		How long should ansible wait for the requested resource.
validate_certs	no	True		Whether or not SSL API requests should be verified. aliases: verify
wait	no	yes	yes no	Should ansible wait until the requested resource is complete.

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 Common Return Values, the following are the fields unique to this module:

name

description

returned

type

sample

network

Dictionary describing the network.

On success when I(state) is 'present'.

dictionary

contains:

name	description	type	sample
status	Network status.	string	ACTIVE
router:external	Indicates whether this network is externally accessible.	bool	True
name	Network name.	string	ext_network
provider:physical_network	The physical network where this network object is implemented.	string	my_vlan_net
subnets	The associated subnets.	list	[]
tenant_id	The tenant ID.	string	06820f94b9f54b119636be2728d216fc
admin_state_up	The administrative state of the network.	bool	True
mtu	The MTU of a network resource.	integer	0
shared	Indicates whether this network is shared across all tenants.	bool	False
port_security_enabled	The port security status	bool	True
provider:network_type	The type of physical network that maps to this network resource.	string	vlan
id	Network ID.	string	4bb4f9a5-3bd2-4562-bf6a-d17a6341bb56
provider:segmentation_id	An isolated segment on the physical network.	string	101

Notes

Note

The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

Note

Auth information is driven by os-client-config, 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 http://docs.openstack.org/developer/os-client-config

This is a Core Module

For more information on what this means please read Core Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.