placement_group_list.md

placement_group_list

List and filter on Placement Groups.

WARNING! This module makes use of beta endpoints and requires the C(api_version) field be explicitly set to C(v4beta).

• Minimum Required Fields
• Examples
• Parameters
• Return Values

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 Linode placement group for the current account
  linode.cloud.placement_group_list:
    api_version: v4beta

Parameters

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

• placement_groups - The returned Placement Groups.

  • Sample Response:

    [
        {
          "id": 123,
          "label": "test",
          "region": "eu-west",
          "placement_group_type": "anti_affinity:local",
          "placement_group_policy": "strict",
          "is_compliant": true,
          "members": [
            {
              "linode_id": 123,
              "is_compliant": true
            }
          ]
        }
    ]

  • See the Linode API response documentation for a list of returned fields