Skip to content

Latest commit

 

History

History
68 lines (53 loc) · 2.49 KB

region_list.md

File metadata and controls

68 lines (53 loc) · 2.49 KB
Raw

region_list

List and filter on Linode Regions.

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 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/regions/#regions-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

  • regions - The returned regions.

    • Sample Response: 
      [
   {
      "capabilities": [
        "Linodes",
        "NodeBalancers",
        "Block Storage",
        "Object Storage"
      ],
      "country": "us",
      "id": "us-east",
      "label": "Newark, NJ, USA",
      "resolvers": {
        "ipv4": "192.0.2.0,192.0.2.1",
        "ipv6": "2001:0db8::,2001:0db8::1"
      },
      "status": "ok"
    }
]
    • See the Linode API response documentation for a list of returned fields