Parameter |
Choices/Defaults |
Comments |
admin_state_up
bool |
|
Desired admin state of the created or existing router.
|
api_timeout
|
|
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 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
|
|
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
|
cacert
|
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
|
cert
|
|
A path to a client certificate to use as part of the SSL transaction.
|
cloud
|
|
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.
|
enable_snat
bool |
|
Enable Source NAT (SNAT) attribute.
|
external_fixed_ips
|
|
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.
|
interface
(added in 2.3) |
Choices:
public ←
- internal
- admin
|
Endpoint URL type to fetch from the service catalog.
aliases: endpoint_type
|
interfaces
|
|
List of subnets to attach to the router internal interface. Default gateway associated with the subnet will be automatically attached with the router's internal interface. In order to provide an ip address different from the default gateway,parameters are passed as dictionary with keys as network name or ID(net), subnet name or ID (subnet) and the IP of port (portip) from the network. User defined portip is often required when a multiple router need to be connected to a single subnet for which the default gateway has been already used.
|
key
|
|
A path to a client key to use as part of the SSL transaction.
|
name
required |
|
Name to be give to the router
|
network
|
|
Unique name or ID of the external gateway network.
required interfaces or enable_snat are provided.
|
project
(added in 2.2) |
|
Unique name or ID of the project.
|
region_name
|
|
Name of the region.
|
state
|
Choices:
present ←
- absent
|
Indicate desired state of the resource
|
timeout
|
Default:
180
|
How long should ansible wait for the requested resource.
|
verify
bool |
|
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.
aliases: validate_certs
|
wait
bool |
|
Should ansible wait until the requested resource is complete.
|