Group

group

This module allows you to create, update or remove a group.

Example Syntax

name: Create group
ionoscloudsdk.ionoscloud.group:
  name: 'AnsibleAutoTestUM'
  create_datacenter: true
  create_snapshot: true
  reserve_ip: true
  access_activity_log: true
  create_pcc: true
  s3_privilege: true
  create_backup_unit: true
  create_internet_access: true
  create_k8s_cluster: true
  create_flow_log: true
  access_and_manage_monitoring: true
  access_and_manage_certificates: true
  manage_dbaas: true
register: group_response


name: Add user1 to group
ionoscloudsdk.ionoscloud.group:
  group: 'AnsibleAutoTestUM'
  users:
  - ''
  state: update


name: Delete group
ionoscloudsdk.ionoscloud.group:
  group: 'AnsibleAutoTestUM'
  state: absent

Returned object

{
    "changed": true,
    "failed": false,
    "action": "create",
    "group": {
        "entities": null,
        "href": "https://api.ionos.com/cloudapi/v6/um/groups/247c2dbf-e0d4-484f-934b-03d4bc09b772",
        "id": "247c2dbf-e0d4-484f-934b-03d4bc09b772",
        "properties": {
            "access_activity_log": true,
            "access_and_manage_certificates": true,
            "access_and_manage_dns": false,
            "access_and_manage_monitoring": true,
            "create_backup_unit": true,
            "create_data_center": true,
            "create_flow_log": true,
            "create_internet_access": true,
            "create_k8s_cluster": true,
            "create_pcc": true,
            "create_snapshot": true,
            "manage_dbaas": true,
            "manage_dataplatform": false,
            "manage_registry": false,
            "name": "AnsibleAutoTestUM",
            "reserve_ip": true,
            "s3_privilege": true
        },
        "type": "group"
    }
}

For more examples please check out the tests here.

state: present

  
name: Create group
ionoscloudsdk.ionoscloud.group:
  name: 'AnsibleAutoTestUM'
  create_datacenter: true
  create_snapshot: true
  reserve_ip: true
  access_activity_log: true
  create_pcc: true
  s3_privilege: true
  create_backup_unit: true
  create_internet_access: true
  create_k8s_cluster: true
  create_flow_log: true
  access_and_manage_monitoring: true
  access_and_manage_certificates: true
  manage_dbaas: true
register: group_response

Available parameters for state present:

Name	Required	Description
name str	True	The name of the resource.
create_datacenter bool	False	Create data center privilege.
create_snapshot bool	False	Create snapshot privilege.
reserve_ip bool	False	Reserve IP block privilege.
access_activity_log bool	False	Activity log access privilege.
create_pcc bool	False	User privilege to create a cross connect.
s3_privilege bool	False	S3 privilege.
create_backup_unit bool	False	Create backup unit privilege.
create_internet_access bool	False	Create internet access privilege.
create_k8s_cluster bool	False	Create Kubernetes cluster privilege.
create_flow_log bool	False	Create Flow Logs privilege.
access_and_manage_monitoring bool	False	Privilege for a group to access and manage monitoring related functionality (access metrics, CRUD on alarms, alarm-actions etc) using Monotoring-as-a-Service (MaaS).
access_and_manage_certificates bool	False	Privilege for a group to access and manage certificates.
manage_dbaas bool	False	Privilege for a group to manage DBaaS related functionality.
users list	False	A list of (non-administrator) user IDs or emails to associate with the group. Set to empty list ([]) to remove all users from the group.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']

state: absent

  
name: Delete group
ionoscloudsdk.ionoscloud.group:
  group: 'AnsibleAutoTestUM'
  state: absent

Available parameters for state absent:

Name	Required	Description
name str	False	The name of the resource.
group str	True	The ID or name of the group.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']

state: update

  
name: Add user1 to group
ionoscloudsdk.ionoscloud.group:
  group: 'AnsibleAutoTestUM'
  users:
  - ''
  state: update

Available parameters for state update:

Name	Required	Description
name str	False	The name of the resource.
group str	True	The ID or name of the group.
create_datacenter bool	False	Create data center privilege.
create_snapshot bool	False	Create snapshot privilege.
reserve_ip bool	False	Reserve IP block privilege.
access_activity_log bool	False	Activity log access privilege.
create_pcc bool	False	User privilege to create a cross connect.
s3_privilege bool	False	S3 privilege.
create_backup_unit bool	False	Create backup unit privilege.
create_internet_access bool	False	Create internet access privilege.
create_k8s_cluster bool	False	Create Kubernetes cluster privilege.
create_flow_log bool	False	Create Flow Logs privilege.
access_and_manage_monitoring bool	False	Privilege for a group to access and manage monitoring related functionality (access metrics, CRUD on alarms, alarm-actions etc) using Monotoring-as-a-Service (MaaS).
access_and_manage_certificates bool	False	Privilege for a group to access and manage certificates.
manage_dbaas bool	False	Privilege for a group to manage DBaaS related functionality.
users list	False	A list of (non-administrator) user IDs or emails to associate with the group. Set to empty list ([]) to remove all users from the group.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']