Parameter |
Choices/Defaults |
Comments |
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.
|
direction
|
Choices:
- egress
ingress ←
|
The direction in which the security group rule is applied. Not all providers support egress.
|
ethertype
|
|
Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. Not all providers support IPv6.
|
interface
(added in 2.3) |
Choices:
public ←
- internal
- admin
|
Endpoint URL type to fetch from the service catalog.
aliases: endpoint_type
|
key
|
|
A path to a client key to use as part of the SSL transaction.
|
port_range_max
|
|
Ending port
|
port_range_min
|
|
Starting port
|
project
(added in 2.7) |
|
Unique name or ID of the project.
|
protocol
|
Choices:
- tcp
- udp
- icmp
- 112
- None
|
IP protocols TCP UDP ICMP 112 (VRRP)
|
region_name
|
|
Name of the region.
|
remote_group
|
|
Name or ID of the Security group to link (exclusive with remote_ip_prefix)
|
remote_ip_prefix
|
|
Source IP address(es) in CIDR notation (exclusive with remote_group)
|
security_group
required |
|
Name or ID of the security group
|
state
|
Choices:
present ←
- absent
|
Should the resource be present or absent.
|
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.
|