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.
|
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.
|
name
required |
|
Name that has to be given to the load balancer
|
region_name
|
|
Name of the region.
|
state
|
Choices:
present ←
- absent
|
Should the resource be present or absent.
|
timeout
|
Default:
180
|
The amount of time the module should wait for the load balancer to get into ACTIVE state.
|
verify
bool |
|
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.
aliases: validate_certs
|
vip_address
|
|
IP address of the load balancer virtual IP.
|
vip_network
|
|
The name or id of the network for the virtual IP of the load balancer. One of vip_network, vip_subnet, or vip_port must be specified.
|
vip_port
|
|
The name or id of the load balancer virtual IP port. One of vip_network, vip_subnet, or vip_port must be specified.
|
vip_subnet
|
|
The name or id of the subnet for the virtual IP of the load balancer. One of vip_network, vip_subnet, or vip_port must be specified.
|
wait
bool |
|
If the module should wait for the load balancer to be created.
|