maintenance_policy_list.md

maintenance_policy_list

List and filter on Maintenance Policies.

• 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 the Linode Maintenance Policies
  linode.cloud.maintenance_policy_list: {}

Parameters

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

• maintenance_policies - The returned Maintenance Policies.

  • Sample Response:

    [
        {
          "slug": "linode/migrate",
          "label": "Migrate",
          "description": "Migrates the Linode to a new host while it remains fully operational. Recommended for maximizing availability.",
          "type": "migrate",
          "notification_period_sec": 300,
          "is_default": true
        },
        {
          "slug": "linode/power_off_on",
          "label": "Power-off/on",
          "description": "Powers off the Linode at the start of the maintenance event and reboots it once the maintenance finishes. Recommended for maximizing performance.",
          "type": "power_off_on",
          "notification_period_sec": 1800,
          "is_default": false
        }
    ]

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