# Backupunits

This is a simple module that supports listing Backupunits.

## Example Syntax

```yaml

name: List backupunits
ionoscloudsdk.ionoscloud.backupunit_info: null
register: backupunit_list_response

```

 

 

## Returned object

```json
{
    "changed": false,
    "backupunits": [
        {
            "href": "https://api.ionos.com/cloudapi/v6/backupunits/5553a540-3952-4b8b-a4c0-7e09d7108f8e",
            "id": "5553a540-3952-4b8b-a4c0-7e09d7108f8e",
            "metadata": {
                "created_by": "<USER_EMAIL>",
                "created_by_user_id": "<USER_ID>",
                "created_date": "2023-07-26T14:53:22+00:00",
                "etag": "83840eb6560db5cec2d10a5bedad7947",
                "last_modified_by": "<USER_EMAIL>",
                "last_modified_by_user_id": "<USER_ID>",
                "last_modified_date": "2023-07-26T14:54:05+00:00",
                "state": "AVAILABLE"
            },
            "properties": {
                "email": "<EMAIL>",
                "name": "test",
                "password": null
            },
            "type": "backupunit"
        },
        {
            "href": "https://api.ionos.com/cloudapi/v6/backupunits/67f31927-0f2f-4be1-b1f0-833e29396c10",
            "id": "67f31927-0f2f-4be1-b1f0-833e29396c10",
            "metadata": {
                "created_by": "<USER_EMAIL>",
                "created_by_user_id": "<USER_ID>",
                "created_date": "2022-10-21T14:33:06+00:00",
                "etag": "7ebf13e8f909d267ed6ca752cbb28a5e",
                "last_modified_by": "<USER_EMAIL>",
                "last_modified_by_user_id": "<USER_ID>",
                "last_modified_date": "2023-08-04T08:47:38+00:00",
                "state": "AVAILABLE"
            },
            "properties": {
                "email": "<EMAIL>",
                "name": "My AnsibleAutoTestBackup",
                "password": null
            },
            "type": "backupunit"
        }
    ],
    "failed": false
}

```

&#x20;

### For more examples please check out the tests [here](https://github.com/ionos-cloud/module-ansible/tree/master/tests/managed-backup).

&#x20;

### Available parameters:

&#x20;

<table data-full-width="true"><thead><tr><th>Name</th><th align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td>depth<br><mark style="color:blue;">int</mark></td><td align="center">False</td><td>The depth used when retrieving the items.<br>Default: 1</td></tr><tr><td>filters<br><mark style="color:blue;">dict</mark></td><td align="center">False</td><td>Filter that can be used to list only objects which have a certain set of properties. Filters should be a dict with a key containing keys and value pair in the following format: 'properties.name': 'server_name'</td></tr><tr><td>api_url<br><mark style="color:blue;">str</mark></td><td align="center">False</td><td>The Ionos API base URL.</td></tr><tr><td>certificate_fingerprint<br><mark style="color:blue;">str</mark></td><td align="center">False</td><td>The Ionos API certificate fingerprint.</td></tr><tr><td>username<br><mark style="color:blue;">str</mark></td><td align="center">False</td><td>The Ionos username. Overrides the IONOS_USERNAME environment variable.</td></tr><tr><td>password<br><mark style="color:blue;">str</mark></td><td align="center">False</td><td>The Ionos password. Overrides the IONOS_PASSWORD environment variable.</td></tr><tr><td>token<br><mark style="color:blue;">str</mark></td><td align="center">False</td><td>The Ionos token. Overrides the IONOS_TOKEN environment variable.</td></tr></tbody></table>