Skip to content

Latest commit

 

History

History
82 lines (66 loc) · 3.61 KB

region_list.md

File metadata and controls

82 lines (66 loc) · 3.61 KB
Raw

region_list

List and filter on Regions.

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 Linode regions
  linode.cloud.region_list: {}
- name: Resolve all Linode regions
  linode.cloud.region_list:
    filters:
      - name: id
        values: us-east

Parameters

Field Type Required Description
order str Optional The order to list Regions in. (Choices: desc, asc; Default: asc)
order_by str Optional The attribute to order Regions by.
filters (sub-options) list Optional A list of filters to apply to the resulting Regions.
count int Optional The number of Regions 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 fields can be found here.
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

  • regions - The returned Regions.

    • Sample Response: 
      [
    {
      "capabilities": [
        "Linodes",
        "Backups",
        "NodeBalancers",
        "Block Storage",
        "Object Storage",
        "Kubernetes",
        "Cloud Firewall",
        "Vlans",
        "VPCs",
        "Metadata",
        "Premium Plans"
      ],
      "country": "us",
      "id": "us-mia",
      "label": "Miami, FL",
      "resolvers": {
        "ipv4": "172.233.160.34, 172.233.160.27",
        "ipv6": "2a01:7e04::f03c:93ff:fead:d31f, 2a01:7e04::f03c:93ff:fead:d37f"
      },
      "site_type": "core",
      "status": "ok"
    }
]
    • See the Linode API response documentation for a list of returned fields