ngine_io.cloudstack.cs_role – Manages user roles on Apache CloudStack based clouds.
ngine_io.cloudstack.cs_role – Manages user roles on Apache CloudStack based clouds.
Note
This plugin is part of the ngine_io.cloudstack collection (version 1.1.0).
To install it use: ansible-galaxy collection install ngine_io.cloudstack
.
To use it in a playbook, specify: ngine_io.cloudstack.cs_role
.
New in version 0.1.0: of ngine_io.cloudstack
Synopsis
- Create, update, delete user roles.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- cs >= 0.9.0
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
api_http_method string |
|
HTTP method used to query the API endpoint. If not given, the As the last option, the value is taken from the ini config file, also see the notes. Fallback value is |
api_key string |
API key of the CloudStack API. If not given, the As the last option, the value is taken from the ini config file, also see the notes. | |
api_region string |
Default: "cloudstack" |
Name of the ini section in the If not given, the |
api_secret string |
Secret key of the CloudStack API. If not set, the As the last option, the value is taken from the ini config file, also see the notes. | |
api_timeout integer |
HTTP timeout in seconds. If not given, the As the last option, the value is taken from the ini config file, also see the notes. Fallback value is 10 seconds if not specified. | |
api_url string |
URL of the CloudStack API e.g. https://cloud.example.com/client/api. If not given, the As the last option, the value is taken from the ini config file, also see the notes. | |
api_verify_ssl_cert string |
CA authority cert file. If not given, the As the last option, the value is taken from the ini config file, also see the notes. Fallback value is | |
description string |
Description of the role. | |
name string / required |
Name of the role. | |
role_type string |
|
Type of the role. Only considered for creation. |
state string |
|
State of the role. |
uuid string |
ID of the role. If provided, uuid is used as key.
|
Notes
Note
- Ansible uses the
cs
library’s configuration method if credentials are not provided by the argumentsapi_url
,api_key
,api_secret
. Configuration is read from several locations, in the following order. TheCLOUDSTACK_ENDPOINT
,CLOUDSTACK_KEY
,CLOUDSTACK_SECRET
andCLOUDSTACK_METHOD
.CLOUDSTACK_TIMEOUT
environment variables. ACLOUDSTACK_CONFIG
environment variable pointing to an.ini
file. Acloudstack.ini
file in the current working directory. A.cloudstack.ini
file in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections incloudstack.ini
. Use the argumentapi_region
to select the section name, default section iscloudstack
. See https://github.com/exoscale/cs for more information. - A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
- This module supports check mode.
Examples
- name: Ensure an user role is present
ngine_io.cloudstack.cs_role:
name: myrole_user
- name: Ensure a role having particular ID is named as myrole_user
ngine_io.cloudstack.cs_role:
name: myrole_user
id: 04589590-ac63-4ffc-93f5-b698b8ac38b6
- name: Ensure a role is absent
ngine_io.cloudstack.cs_role:
name: myrole_user
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
description string |
success |
Description of the role.
Sample: This is my role description |
id string |
success |
UUID of the role.
Sample: 04589590-ac63-4ffc-93f5-b698b8ac38b6 |
name string |
success |
Name of the role.
Sample: myrole |
role_type string |
success |
Type of the role.
Sample: User |
Authors
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ngine_io/cloudstack/cs_role_module.html