New in version 2.2.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| api_timeout | no | None | 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 | no | 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 | no | password | 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 | no | Ignored. Present for backwards compatibility | ||
| cacert | no | None | A path to a CA Cert bundle that can be used as part of verifying SSL API requests. | |
| cert | no | None | A path to a client certificate to use as part of the SSL transaction. | |
| cloud | no | 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_type | no | public |
| Endpoint URL type to fetch from the service catalog. |
| key | no | None | A path to a client key to use as part of the SSL transaction. | |
| name | yes | Server group name. | ||
| policies | no | A list of one or more policy names to associate with the server group. The list must contain at least one policy name. The current valid policy names are anti-affinity, affinity, soft-anti-affinity and soft-affinity. | ||
| region_name | no | Name of the region. | ||
| state | no | present |
| Indicate desired state of the resource. When state is 'present', then policies is required. |
| timeout | no | 180 | How long should ansible wait for the requested resource. | |
| validate_certs | no | Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True. aliases: verify | ||
| wait | no | yes |
| Should ansible wait until the requested resource is complete. |
# Create a server group with 'affinity' policy.
- os_server_group:
state: present
auth:
auth_url: https://api.cloud.catalyst.net.nz:5000/v2.0
username: admin
password: admin
project_name: admin
name: my_server_group
policies:
- affinity
# Delete 'my_server_group' server group.
- os_server_group:
state: absent
auth:
auth_url: https://api.cloud.catalyst.net.nz:5000/v2.0
username: admin
password: admin
project_name: admin
name: my_server_group
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| members | A list of members in the server group. | success | list | |
| user_id | The user ID who owns the server group. | success | string | |
| name | The name of the server group. | success | string | |
| policies | A list of one or more policy names of the server group. | success | list | |
| project_id | The project ID who owns the server group. | success | string | |
| id | Unique UUID. | success | string | |
| metadata | Metadata key and value pairs. | success | dict |
Note
OS_USERNAME may 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.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/os_server_group_module.html