Lans

This is a simple module that supports listing LANs.

Example Syntax


name: List LANs
ionoscloudsdk.ionoscloud.lan_info:
  datacenter: 'AnsibleAutoTestCompute'
register: lan_list_response

Returned object

{
    "changed": false,
    "lans": [
        {
            "entities": {
                "nics": {
                    "links": null,
                    "href": "https://api.ionos.com/cloudapi/v6/datacenters/0487f06f-b02d-4b78-b4e4-f48d86daf293/lans/1/nics",
                    "id": "1/nics",
                    "items": null,
                    "limit": null,
                    "offset": null,
                    "type": "collection"
                }
            },
            "href": "https://api.ionos.com/cloudapi/v6/datacenters/0487f06f-b02d-4b78-b4e4-f48d86daf293/lans/1",
            "id": "1",
            "metadata": {
                "created_by": "<USER_EMAIL>",
                "created_by_user_id": "<USER_ID>",
                "created_date": "2023-08-03T10:38:01+00:00",
                "etag": "933196ec0a8386cc137cd4b5ec1165d1",
                "last_modified_by": "<USER_EMAIL>",
                "last_modified_by_user_id": "<USER_ID>",
                "last_modified_date": "2023-08-03T10:38:01+00:00",
                "state": "AVAILABLE"
            },
            "properties": {
                "ip_failover": [],
                "name": "AnsibleAutoTestCompute",
                "pcc": null,
                "public": true
            },
            "type": "lan"
        }
    ],
    "failed": false
}

For more examples please check out the tests here.

Available parameters:

Name
Required
Description

datacenter str

True

The datacenter name or UUID in which to operate.

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.

Last updated