cloudscale_ch.cloud.objects_user – Manages objects users on the cloudscale.ch IaaS service
Note
This plugin is part of the cloudscale_ch.cloud collection (version 2.2.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cloudscale_ch.cloud
.
To use it in a playbook, specify: cloudscale_ch.cloud.objects_user
.
New in version 1.1.0: of cloudscale_ch.cloud
Parameters
Parameter |
Comments |
---|---|
Timeout in seconds for calls to the cloudscale.ch API. This can also be passed in the Default: 45 |
|
cloudscale.ch API token. This can also be passed in the |
|
cloudscale.ch API URL. This can also be passed in the Default: “https://api.cloudscale.ch/v1” |
|
Display name of the objects user. Either display_name or id is required. |
|
Name of the objects user. Either display_name or id is required. |
|
State of the objects user. Choices:
|
|
Tags associated with the objects user. Set this to |
Notes
Note
All operations are performed using the cloudscale.ch public API v1.
For details consult the full API documentation: https://www.cloudscale.ch/en/api/v1.
A valid API token is required for all operations. You can create as many tokens as you like using the cloudscale.ch control panel at https://control.cloudscale.ch.
Examples
- name: Create an objects user
cloudscale_ch.cloud.objects_user:
display_name: alan
tags:
project: luna
api_token: xxxxxx
register: object_user
- name: print keys
debug:
var: object_user.keys
- name: Update an objects user
cloudscale_ch.cloud.objects_user:
display_name: alan
tags:
project: gemini
api_token: xxxxxx
- name: Remove an objects user
cloudscale_ch.cloud.objects_user:
display_name: alan
state: absent
api_token: xxxxxx
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The display name of the objects user. Returned: success Sample: “alan” |
|
The API URL to get details about this resource. Returned: success when state == present |
|
The ID of the objects user. Returned: success Sample: “6fe39134bf4178747eebc429f82cfafdd08891d4279d0d899bc4012db1db6a15” |
|
List of key objects. Returned: success |
|
The access key. Returned: success Sample: “0ZTAIBKSGYBRHQ09G11W” |
|
The secret key. Returned: success Sample: “bn2ufcwbIa0ARLc5CLRSlVaCfFxPHOpHmjKiH34T” |
|
The current status of the objects user. Returned: success Sample: “present” |
|
Tags assosiated with the objects user. Returned: success Sample: {“project”: “my project”} |
Authors
Rene Moser (@resmo)