New in version 2.0.
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.
Endpoint URL type to fetch from the service catalog.
To which fixed IP of server the floating IP address should be attached to.
A floating IP address to attach or to detach. Required only if state is absent. When state is present can be used to specify a IP address to attach.
A path to a client key to use as part of the SSL transaction.
(added in 2.3)
The name or id of a neutron private network that the fixed IP to attach floating IP is on
aliases: fixed_network, internal_network
The name or ID of a neutron external network or a nova pool name.
(added in 2.1)
When state is absent, indicates whether or not to delete the floating IP completely, or only detach it from the server. Default is to detach only.
Name of the region.
When state is present, and floating_ip_address is not present, this parameter can be used to specify whether we should try to reuse a floating IP address already allocated to the project.
The name or ID of the instance to which the IP address should be assigned.
Should the resource be present or absent.
Time to wait for an IP address to appear as attached. See wait.
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.
When attaching a floating IP address, specify whether we should wait for it to appear as attached.
# Assign a floating IP to the fist interface of `cattle001` from an exiting # external network or nova pool. A new floating IP from the first available # external network is allocated to the project. - os_floating_ip: cloud: dguerri server: cattle001 # Assign a new floating IP to the instance fixed ip `192.0.2.3` of # `cattle001`. If a free floating IP is already allocated to the project, it is # reused; if not, a new one is created. - os_floating_ip: cloud: dguerri state: present reuse: yes server: cattle001 network: ext_net fixed_address: 192.0.2.3 wait: true timeout: 180 # Assign a new floating IP from the network `ext_net` to the instance fixed # ip in network `private_net` of `cattle001`. - os_floating_ip: cloud: dguerri state: present server: cattle001 network: ext_net nat_destination: private_net wait: true timeout: 180 # Detach a floating IP address from a server - os_floating_ip: cloud: dguerri state: absent floating_ip_address: 203.0.113.2 server: cattle001
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