ansible.builtin.cloudscale_server_group (v2.9.13) — module

Install Ansible via pip

Install with pip install ansible==2.9.13

Description

Create, update and remove server groups.

Usage examples

Scanned by Steampunk Spotter

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

---
- name: Ensure server group exists
  cloudscale_server_group:
    name: my-name
    type: anti-affinity
    api_token: xxxxxx

Scanned by Steampunk Spotter

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

- name: Ensure a server group is absent
  cloudscale_server_group:
    name: my-name
    state: absent
    api_token: xxxxxx

Inputs

    
name:
    description:
    - Name of the server group.
    - Either I(name) or I(uuid) is required. These options are mutually exclusive.
    type: str

tags:
    description:
    - Tags assosiated with the server groups. Set this to C({}) to clear any tags.
    type: dict
    version_added: '2.9'
    version_added_collection: ansible.builtin

type:
    default: anti-affinity
    description:
    - Type of the server group.
    type: str

uuid:
    description:
    - UUID of the server group.
    - Either I(name) or I(uuid) is required. These options are mutually exclusive.
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the server group.
    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

Outputs

href:
  description: API URL to get details about this server group
  returned: if available
  sample: https://api.cloudscale.ch/v1/server-group/cfde831a-4e87-4a75-960f-89b0148aa2cc
  type: str
name:
  description: The display name of the server group
  returned: always
  sample: load balancers
  type: str
servers:
  description: A list of servers that are part of the server group.
  returned: if available
  sample: []
  type: list
state:
  description: State of the server group.
  returned: always
  sample: present
  type: str
tags:
  description: Tags assosiated with the server group.
  returned: success
  sample:
    project: my project
  type: dict
  version_added: '2.9'
  version_added_collection: ansible.builtin
type:
  description: The type the server group
  returned: if available
  sample: anti-affinity
  type: str
uuid:
  description: The unique identifier for this server
  returned: always
  sample: cfde831a-4e87-4a75-960f-89b0148aa2cc
  type: str