New in version 2.0.
Perform server actions on an existing compute instance from OpenStack. This module does not return any data other than changed true/false.
- python >= 2.6
- python >= 2.7
Perform the given action. The lock and unlock actions always return changed as the servers API does not provide lock status.
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.
Name of the availability zone.
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.
A path to a client key to use as part of the SSL transaction
Name of the region.
Name or ID of the instance
How long should ansible wait for the requested resource.
Whether or not SSL API requests should be verified.
Should ansible wait until the requested resource is complete.
# Pauses a compute instance - os_server_actions: action: pause auth: auth_url: https://mycloud.openstack.blueboxgrid.com:5001/v2.0 username: admin password: admin project_name: admin server: vm1 timeout: 200
The standard OpenStack environment variables, such as
OS_USERNAME may be used instead of providing explicit values.
Auth information is driven by os-client-config, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at http://docs.openstack.org/developer/os-client-config