New in version 2.0.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| api_timeout |
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 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 |
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
|
|
| cacert |
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
|
|
| cert |
A path to a client certificate to use as part of the SSL transaction.
|
|
| cloud |
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 for the project
|
|
| domain_id |
Domain id to create the project in if the cloud supports domains. The domain_id parameter requires shade >= 1.8.0
aliases: domain |
|
| enabled |
|
Is the project enabled
|
|
interface
(added in 2.3) |
|
Endpoint URL type to fetch from the service catalog.
aliases: endpoint_type |
| key |
A path to a client key to use as part of the SSL transaction.
|
|
|
name
required |
Name for the project
|
|
| region_name |
Name of the region.
|
|
| state |
|
Should the resource be present or absent.
|
| timeout |
Default: 180
|
How long should ansible wait for the requested resource.
|
| verify |
|
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.
aliases: validate_certs |
| wait |
|
Should ansible wait until the requested resource is complete.
|
Note
OS_USERNAME may be used instead of providing explicit values.# 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, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
|
project
complex
|
On success when state is 'present' |
Dictionary describing the project.
|
|
|
enabled
bool
|
Boolean to indicate if project is enabled
Sample:
True
|
||
|
description
string
|
Project description
Sample:
demodescription
|
||
|
name
string
|
Project name
Sample:
demoproject
|
||
|
id
string
|
Project ID
Sample:
f59382db809c43139982ca4189404650
|
||
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.