- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# os_server_action – Perform actions on Compute Instances from OpenStack

- Synopsis

- Requirements

- Parameters

- Notes

- Examples

- Status

## Synopsis

- Perform server actions on an existing compute instance from OpenStack. This module does not return any data other than changed true/false. When action is ‘rebuild’, then image parameter is required.

## Requirements

The below requirements are needed on the host that executes this module.

- openstacksdk

- openstacksdk >= 0.12.0

- python >= 2.7

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
action - | Choices: stop start pause unpause lock unlock suspend resume rebuild Default: "present" | Perform the given action. The lock and unlock actions always return changed as the servers API does not provide lock status.
api_timeout integer |  | 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 |  | 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 (for example, os_user_domain_name or os_project_domain_name) 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 string |  | 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
ca_cert string |  | A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert
client_cert string |  | A path to a client certificate to use as part of the SSL transaction. aliases: cert
client_key string |  | A path to a client key to use as part of the SSL transaction. aliases: key
cloud raw |  | 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.
image - |  | Image the server should be rebuilt with
interface string | Choices: admin internal public ← | Endpoint URL type to fetch from the service catalog. aliases: endpoint_type
region_name string |  | Name of the region.
server - / required |  | Name or ID of the instance
timeout integer | Default: 180 | The amount of time the module should wait for the instance to perform the requested action.
validate_certs boolean | Choices: no ← yes | Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify
wait boolean | Choices: no yes ← | If the module should wait for the instance action to be performed.

## Notes

Note

- The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values.

- Auth information is driven by openstacksdk, 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 https://docs.openstack.org/openstacksdk/

## Examples

    # Pauses a compute instance
    - os_server_action:
          action: pause
          auth:
            auth_url: https://identity.example.com
            username: admin
            password: admin
            project_name: admin
          server: vm1
          timeout: 200

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by the Ansible Community. [community]

### Authors

- Jesse Keating (@omgjlk)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.