os_router - Create or delete routers 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

Create or Delete routers from OpenStack. Although Neutron allows routers to share the same name, this module enforces name uniqueness to be more user friendly.

Requirements (on host that executes module)

python >= 2.7

shade

Options

parameter	required	default	choices	comments
admin_state_up	no	True		Desired admin state of the created or existing router.
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.
enable_snat	no	True		Enable Source NAT (SNAT) attribute.
endpoint_type	no	public	public internal admin	Endpoint URL type to fetch from the service catalog.
external_fixed_ips	no	None		The IP address parameters for the external gateway network. Each is a dictionary with the subnet name or ID (subnet) and the IP address to assign on the subnet (ip). If no IP is specified, one is automatically assigned from that subnet.
interfaces	no	None		List of subnets to attach to the router internal interface.
key	no	None		A path to a client key to use as part of the SSL transaction
name	yes			Name to be give to the router
network	no	None		Unique name or ID of the external gateway network. required interfaces or enable_snat are provided.
region_name	no			Name of the region.
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 a simple router, not attached to a gateway or subnets.
- os_router:
    cloud: mycloud
    state: present
    name: simple_router

# Creates a router attached to ext_network1 on an IPv4 subnet and one
# internal subnet interface.
- os_router:
    cloud: mycloud
    state: present
    name: router1
    network: ext_network1
    external_fixed_ips:
      - subnet: public-subnet
        ip: 172.24.4.2
    interfaces:
      - private-subnet

# Update existing router1 external gateway to include the IPv6 subnet.
# Note that since 'interfaces' is not provided, any existing internal
# interfaces on an existing router will be left intact.
- os_router:
    cloud: mycloud
    state: present
    name: router1
    network: ext_network1
    external_fixed_ips:
      - subnet: public-subnet
        ip: 172.24.4.2
      - subnet: ipv6-public-subnet
        ip: 2001:db8::3

# Delete router1
- os_router:
    cloud: mycloud
    state: absent
    name: router1

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

router

Dictionary describing the router.

On success when I(state) is 'present'

dictionary

contains:

name	description	type	sample
status	The router status.	string	ACTIVE
external_gateway_info	The external gateway parameters.	dictionary	{'enable_snat': True, 'external_fixed_ips': [{'subnet_id': '4272cb52-a456-4c20-8f3c-c26024ecfa81', 'ip_address': '10.6.6.99'}]}
name	Router name.	string	router1
admin_state_up	Administrative state of the router.	boolean	True
routes	The extra routes configuration for L3 router.	list
tenant_id	The tenant ID.	string	861174b82b43463c9edc5202aadc60ef
id	Router ID.	string	474acfe5-be34-494c-b339-50f06aa143e4

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.