Shares

This is a simple module that supports listing Shares.

Example Syntax

name: List Shares
ionoscloudsdk.ionoscloud.share_info:
  group: Demo
register: share_list_response

Returned object

{
    "changed": false,
    "shares": [
        {
            "href": "https://api.ionos.com/cloudapi/v6/um/groups/0e191818-5dd6-4248-b226-a0c863c71d03/shares/82ad5ad2-7f10-4c2f-ad22-6ae36575f730",
            "id": "82ad5ad2-7f10-4c2f-ad22-6ae36575f730",
            "properties": {
                "edit_privilege": true,
                "share_privilege": true
            },
            "type": "resource"
        },
        {
            "href": "https://api.ionos.com/cloudapi/v6/um/groups/0e191818-5dd6-4248-b226-a0c863c71d03/shares/b22cf038-aa2a-4806-a2c1-2a4e3507c37a",
            "id": "b22cf038-aa2a-4806-a2c1-2a4e3507c37a",
            "properties": {
                "edit_privilege": true,
                "share_privilege": true
            },
            "type": "resource"
        }
    ],
    "failed": false
}

For more examples please check out the tests here.

Available parameters:

Name	Required	Description
group str	True	The name or ID of the group.
depth int	False	The depth used when retrieving the items. Default: 1
filters dict	False	Filter that can be used to list only objects which have a certain set of propeties. Filters should be a dict with a key containing keys and value pair in the following format: 'properties.name': 'server_name'
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.