New in version 2.0.
Desired admin state of the created or existing router.
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 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.
Ignored. Present for backwards compatability
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.
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 Source NAT (SNAT) attribute.
Endpoint URL type to fetch from the service catalog.
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.
List of subnets to attach to the router internal interface.
A path to a client key to use as part of the SSL transaction.
Name to be give to the router
Unique name or ID of the external gateway network.
required interfaces or enable_snat are provided.
(added in 2.2)
Unique name or ID of the project.
Name of the region.
Indicate desired state of the resource
How long should ansible wait for the requested resource.
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.
Should ansible wait until the requested resource is complete.
# Create a simple router, not attached to a gateway or subnets. - os_router: cloud: mycloud state: present name: simple_router # Create a simple router, not attached to a gateway or subnets for a given project. - os_router: cloud: mycloud state: present name: simple_router project: myproj # 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
Common return values are documented here Return Values, the following are the fields unique to this module:
|router||Dictionary describing the router.||On success when I(state) is 'present'||dictionary|
OS_USERNAMEmay be used instead of providing explicit values.
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support