New in version 2.0.
| 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. | ||
| description | no | None | Description for the project | |
| domain_id | no | None | Domain id to create the project in if the cloud supports domains. The domain_id parameter requires shade >= 1.8.0 aliases: domain | |
| enabled | no | True | Is the project enabled | |
| 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 | Name for the project | ||
| region_name | no | Name of the region. | ||
| state | no | present |
| Should the resource be present or absent. |
| 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 project
- os_project:
cloud: mycloud
state: present
name: demoproject
description: demodescription
domain_id: demoid
enabled: True
# Delete a project
- os_project:
cloud: mycloud
state: absent
name: demoproject
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| project | Dictionary describing the project. | On success when I(state) is 'present' | complex | ||||||||||||||||||||||||||
| contains: |
| ||||||||||||||||||||||||||||
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_project_module.html