Skip to content

Latest commit

 

History

History
59 lines (42 loc) · 2.18 KB

placement_group_info.md

File metadata and controls

59 lines (42 loc) · 2.18 KB

placement_group_info

Get info about a Linode Placement Group.

⚠️ This module makes use of beta endpoints and requires the api_version field be explicitly set to v4beta.

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 Linode placement group
  linode.cloud.placement_group_info: 
    api_version: v4beta
    id: 123

Parameters

Field Type Required Description
id int Required The ID of the Placement Group to resolve.

Return Values

  • placement_group - The returned Placement Group.

    • Sample Response:
      {
        "id": 123,
        "label": "test",
        "region": "eu-west",
        "affinity_type": "anti_affinity:local",
        "is_strict": true,
        "is_compliant": true,
        "members": [
          {
            "linode_id": 123,
            "is_compliant": true
          }
        ]
      }
      
    • See the Linode API response documentation for a list of returned fields