Skip to content

Latest commit

 

History

History
77 lines (61 loc) · 3.52 KB

domain_list.md

File metadata and controls

77 lines (61 loc) · 3.52 KB
Raw

domain_list

List and filter on Domains.

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: List all of the domains for the current Linode Account
  linode.cloud.domain_list: {}
- name: Resolve all domains for the current Linode Account
  linode.cloud.domain_list:
    filters:
      - name: domain
        values: example.org

Parameters

Field Type Required Description
order str Optional The order to list domains in. (Choices: desc, asc; Default: asc)
order_by str Optional The attribute to order domains by.
filters (sub-options) list Optional A list of filters to apply to the resulting domains.
count int Optional The number of results to return. If undefined, all results will be returned.

filters

Field Type Required Description
name str Required The name of the field to filter on. Valid filterable attributes can be found here: https://www.linode.com/docs/api/domains/#domains-list__responses#domains-list__responses
values list Required A list of values to allow for this field. Fields will pass this filter if at least one of these values matches.

Return Values

  • domains - The returned domains.

    • 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