os_keystone_domain – Manage OpenStack Identity Domains
New in version 2.1.
Synopsis
- Create, update, or delete OpenStack Identity domains. If a domain with the supplied name already exists, it will be updated with the new description and enabled attributes.
Requirements
The below requirements are needed on the host that executes this module.
- openstacksdk
- python >= 2.7
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
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. | |
description - | Description of the domain | |
enabled boolean |
| Is the domain enabled |
interface string added in 2.3 |
| Endpoint URL type to fetch from the service catalog. aliases: endpoint_type |
name - / required | Name that has to be given to the instance | |
region_name string | Name of the region. | |
state - |
| Should the resource be present or absent. |
timeout integer | Default: 180 | How long should ansible wait for the requested resource. |
validate_certs boolean |
| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes .aliases: verify |
wait boolean |
| Should ansible wait until the requested resource is complete. |
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
# Create a domain - os_keystone_domain: cloud: mycloud state: present name: demo description: Demo Domain # Delete a domain - os_keystone_domain: cloud: mycloud state: absent name: demo
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
domain complex | On success when state is 'present' | Dictionary describing the domain. | |
description string | Domain description. Sample: Demo Domain | ||
enabled boolean | Domain description. Sample: True | ||
id string | Domain ID. Sample: 474acfe5-be34-494c-b339-50f06aa143e4 | ||
name string | Domain name. Sample: demo | ||
id string | On success when state is 'present' | The domain ID. Sample: 474acfe5-be34-494c-b339-50f06aa143e4 |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Monty Taylor (@emonty)
- Haneef Ali (@haneefs)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/os_keystone_domain_module.html