Skip to content

Latest commit

 

History

History
110 lines (90 loc) · 3.73 KB

domain_info.md

File metadata and controls

110 lines (90 loc) · 3.73 KB

domain_info

Get info about a Linode Domain.

Minimum Required Fields

Field Type Required Description
api_token str Required The Linode account personal access token. It is necessary to run the module.
It can be exposed by the environment variable LINODE_API_TOKEN instead.
See details in Usage.

Examples

- name: Get info about a domain by domain
  linode.cloud.domain_info:
    domain: my-domain.com
- name: Get info about a domain by id
  linode.cloud.domain_info:
    id: 12345

Parameters

Field Type Required Description
id int Optional The ID of the Domain to resolve. (Conflicts With: domain)
domain str Optional The domain of the Domain to resolve. (Conflicts With: id)

Return Values

  • domain - The returned Domain.

    • Sample Response:
      {
        "axfr_ips": [],
        "description": null,
        "domain": "example.org",
        "expire_sec": 300,
        "group": null,
        "id": 1234,
        "master_ips": [],
        "refresh_sec": 300,
        "retry_sec": 300,
        "soa_email": "[email protected]",
        "status": "active",
        "tags": [
          "example tag",
          "another example"
        ],
        "ttl_sec": 300,
        "type": "master"
      }
    • See the Linode API response documentation for a list of returned fields
  • records - The returned records.

    • Sample Response:
      [
        {
          "created": "2018-01-01T00:01:01",
          "id": 123456,
          "name": "test",
          "port": 80,
          "priority": 50,
          "protocol": null,
          "service": null,
          "tag": null,
          "target": "192.0.2.0",
          "ttl_sec": 604800,
          "type": "A",
          "updated": "2018-01-01T00:01:01",
          "weight": 50
        }
      ]
    • See the Linode API response documentation for a list of returned fields
  • zone_file - The returned zone file.

    • Sample Response:
      {
        "zone_file": [
          "; example.com [123]",
          "$TTL 864000",
          "@  IN  SOA  ns1.linode.com. user.example.com. 2021000066 14400 14400 1209600 86400",
          "@    NS  ns1.linode.com.",
          "@    NS  ns2.linode.com.",
          "@    NS  ns3.linode.com.",
          "@    NS  ns4.linode.com.",
          "@    NS  ns5.linode.com."
        ]
      }
    • See the Linode API response documentation for a list of returned fields