cloudscale_ch.cloud.objects_user (2.3.1) — module

Install collection

Install with ansible-galaxy collection install cloudscale_ch.cloud:==2.3.1

Add to requirements.yml

  collections:
    - name: cloudscale_ch.cloud
      version: 2.3.1

Description

Create, update and remove objects users cloudscale.ch IaaS service.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create an objects user
  cloudscale_ch.cloud.objects_user:
    display_name: alan
    tags:
      project: luna
    api_token: xxxxxx
  register: object_user

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: print keys
  debug:
    var: object_user.keys

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Update an objects user
  cloudscale_ch.cloud.objects_user:
    display_name: alan
    tags:
      project: gemini
    api_token: xxxxxx

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove an objects user
  cloudscale_ch.cloud.objects_user:
    display_name: alan
    state: absent
    api_token: xxxxxx

Inputs

    
id:
    description:
    - Name of the objects user.
    - Either I(display_name) or I(id) is required.
    type: str

tags:
    description:
    - Tags associated with the objects user. Set this to C({}) to clear any tags.
    type: dict

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the objects user.
    type: str

api_url:
    default: https://api.cloudscale.ch/v1
    description:
    - cloudscale.ch API URL.
    - This can also be passed in the C(CLOUDSCALE_API_URL) environment variable.
    type: str
    version_added: 1.3.0
    version_added_collection: cloudscale_ch.cloud

api_token:
    description:
    - cloudscale.ch API token.
    - This can also be passed in the C(CLOUDSCALE_API_TOKEN) environment variable.
    required: true
    type: str

api_timeout:
    default: 45
    description:
    - Timeout in seconds for calls to the cloudscale.ch API.
    - This can also be passed in the C(CLOUDSCALE_API_TIMEOUT) environment variable.
    type: int

display_name:
    aliases:
    - name
    description:
    - Display name of the objects user.
    - Either I(display_name) or I(id) is required.
    type: str

Outputs

display_name:
  description: The display name of the objects user.
  returned: success
  sample: alan
  type: str
href:
  description: The API URL to get details about this resource.
  returned: success when state == present
  sample: https://api.cloudscale.ch/v1/objects-users/6fe39134bf4178747eebc429f82cfafdd08891d4279d0d899bc4012db1db6a15
  type: str
id:
  description: The ID of the objects user.
  returned: success
  sample: 6fe39134bf4178747eebc429f82cfafdd08891d4279d0d899bc4012db1db6a15
  type: str
keys:
  contains:
    access_key:
      description: The access key.
      returned: success
      sample: 0ZTAIBKSGYBRHQ09G11W
      type: str
    secret_key:
      description: The secret key.
      returned: success
      sample: bn2ufcwbIa0ARLc5CLRSlVaCfFxPHOpHmjKiH34T
      type: str
  description: List of key objects.
  returned: success
  type: complex
state:
  description: The current status of the objects user.
  returned: success
  sample: present
  type: str
tags:
  description: Tags assosiated with the objects user.
  returned: success
  sample:
    project: my project
  type: dict