v0.41.0

.github/workflows/codeql.yml

@@ -24,7 +24,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
 
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v3

.github/workflows/dependency-review.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout repository'
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: 'Dependency Review'
         uses: actions/dependency-review-action@v4
         with:

.github/workflows/docs.yml

@@ -13,7 +13,7 @@ jobs:
         working-directory: .ansible/collections/ansible_collections/linode/cloud
     steps:
       - name: checkout repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           path: .ansible/collections/ansible_collections/linode/cloud
 
@@ -50,7 +50,7 @@ jobs:
         working-directory: .ansible/collections/ansible_collections/linode/cloud
     steps:
       - name: checkout repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           path: .ansible/collections/ansible_collections/linode/cloud
 

.github/workflows/integration-tests-pr.yml

@@ -32,7 +32,7 @@ jobs:
 
       # Check out merge commit
       - name: Checkout PR
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           ref: ${{ inputs.sha }}
           path: .ansible/collections/ansible_collections/linode/cloud
@@ -118,7 +118,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           fetch-depth: 0
           submodules: 'recursive'

.github/workflows/integration-tests.yml

@@ -34,7 +34,7 @@ jobs:
         working-directory: .ansible/collections/ansible_collections/linode/cloud
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           path: .ansible/collections/ansible_collections/linode/cloud
           fetch-depth: 0
@@ -83,7 +83,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           fetch-depth: 0
           submodules: 'recursive'
@@ -101,7 +101,7 @@ jobs:
         run: mkdir -p tests/output/junit
 
       - name: Download test report
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v5
         with:
           name: xml-test-reports  # Specify the artifact name from the 'run-tests' job
           path: tests/output/junit
@@ -148,7 +148,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           fetch-depth: 0
           submodules: 'recursive'

.github/workflows/labeler.yml

@@ -18,7 +18,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       -
         name: Run Labeler
         uses: crazy-max/ghaction-github-labeler@24d110aa46a59976b8a7f35518cb7f14f434c916

.github/workflows/lint.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: checkout repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: setup python 3
         uses: actions/setup-python@v5

.github/workflows/nightly-smoke-tests.yml

@@ -22,7 +22,7 @@ jobs:
         working-directory: .ansible/collections/ansible_collections/linode/cloud
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           path: .ansible/collections/ansible_collections/linode/cloud
           fetch-depth: 0

.github/workflows/release.yml

@@ -14,7 +14,7 @@ jobs:
         working-directory: .ansible/collections/ansible_collections/linode/cloud
     steps:
       - name: checkout repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           path: .ansible/collections/ansible_collections/linode/cloud
 

.github/workflows/unit-tests.yml

@@ -16,7 +16,7 @@ jobs:
         working-directory: .ansible/collections/ansible_collections/linode/cloud
     steps:
       - name: checkout repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           path: .ansible/collections/ansible_collections/linode/cloud
 

README.md

@@ -110,6 +110,7 @@ Name | Description |
 [linode.cloud.instance_type_list](./docs/modules/instance_type_list.md)|**NOTE: This module has been deprecated in favor of `type_list`.**|
 [linode.cloud.lke_type_list](./docs/modules/lke_type_list.md)|List and filter on LKE Types.|
 [linode.cloud.lke_version_list](./docs/modules/lke_version_list.md)|List and filter on LKE Versions.|
+[linode.cloud.maintenance_policy_list](./docs/modules/maintenance_policy_list.md)|List and filter on Maintenance Policies.|
 [linode.cloud.network_transfer_prices_list](./docs/modules/network_transfer_prices_list.md)|List and filter on Network Transfer Prices.|
 [linode.cloud.nodebalancer_list](./docs/modules/nodebalancer_list.md)|List and filter on Node Balancers.|
 [linode.cloud.nodebalancer_type_list](./docs/modules/nodebalancer_type_list.md)|List and filter on Node Balancer Types.|

docs/modules/account_settings.md

@@ -29,6 +29,7 @@ Returns information related to your Account settings.
 | `backups_enabled` | <center>`bool`</center> | <center>Optional</center> | Account-wide backups default. If true, all Linodes created will automatically be enrolled in the Backups service. If false, Linodes will not be enrolled by default, but may still be enrolled on creation or later.   |
 | `longview_subscription` | <center>`str`</center> | <center>Optional</center> | The Longview Pro tier you are currently subscribed to. The value must be a Longview subscription ID or null for Longview Free.   |
 | `network_helper` | <center>`bool`</center> | <center>Optional</center> | Enables network helper across all users by default for new Linodes and Linode Configs.   |
+| `maintenance_policy` | <center>`str`</center> | <center>Optional</center> | The Slug of the maintenance policy associated with the account. NOTE: This field is under v4beta.  **(Choices: `linode/migrate`, `linode/power_off_on`)** |
 
 ## Return Values
 
@@ -42,7 +43,8 @@ Returns information related to your Account settings.
           "longview_subscription": "longview-3",
           "managed": true,
           "network_helper": false,
-          "object_storage": "active"
+          "object_storage": "active",
+          "maintenance_policy": "linode/migrate"
         }
         ```
     - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-account-settings) for a list of returned fields

docs/modules/instance.md

@@ -126,6 +126,7 @@ Manage Linode Instances, Configs, and Disks.
 | `image` | <center>`str`</center> | <center>Optional</center> | The image ID to deploy the instance disk from.  **(Conflicts With: `disks`,`configs`)** |
 | `authorized_keys` | <center>`list`</center> | <center>Optional</center> | A list of SSH public key parts to deploy for the root user.   |
 | `authorized_users` | <center>`list`</center> | <center>Optional</center> | A list of usernames.   |
+| `maintenance_policy` | <center>`str`</center> | <center>Optional</center> | The slug of the maintenance policy to apply during maintenance. NOTE: This field is under v4beta.  **(Choices: `linode/migrate`, `linode/power_off_on`)** |
 | `root_pass` | <center>`str`</center> | <center>Optional</center> | The password for the root user. If not specified, one will be generated. This generated password will be available in the task success JSON.   |
 | `stackscript_id` | <center>`int`</center> | <center>Optional</center> | The ID of the StackScript to use when creating the instance. See the [Linode API documentation](https://techdocs.akamai.com/linode-api/reference/get-stack-scripts).   |
 | `stackscript_data` | <center>`dict`</center> | <center>Optional</center> | An object containing arguments to any User Defined Fields present in the StackScript used when creating the instance. Only valid when a stackscript_id is provided. See the [Linode API documentation](https://techdocs.akamai.com/linode-api/reference/get-stack-scripts).   |
@@ -352,6 +353,7 @@ Manage Linode Instances, Configs, and Disks.
           "watchdog_enabled": true,
           "disk_encryption": "enabled",
           "lke_cluster_id": null,
+          "maintenance_policy": "linode/migrate",
           "placement_group": {
             "id": 123,
             "label": "test",

docs/modules/instance_info.md

@@ -85,6 +85,7 @@ Get info about a Linode Instance.
           "watchdog_enabled": true,
           "disk_encryption": "enabled",
           "lke_cluster_id": null,
+          "maintenance_policy": "linode/migrate",
           "placement_group": {
             "id": 123,
             "label": "test",

docs/modules/instance_list.md

@@ -96,7 +96,8 @@ List and filter on Instances.
               "updated": "2018-01-01T00:01:01",
               "watchdog_enabled": true,
               "disk_encryption": "enabled",
-              "lke_cluster_id": null
+              "lke_cluster_id": null,
+              "maintenance_policy": "linode/migrate"
             }
         ]
         ```

docs/modules/maintenance_policy_list.md

@@ -0,0 +1,72 @@
+# maintenance_policy_list
+
+List and filter on Maintenance Policies.
+
+WARNING! This module makes use of beta endpoints and requires the C(api_version) field be explicitly set to C(v4beta).
+
+- [Minimum Required Fields](#minimum-required-fields)
+- [Examples](#examples)
+- [Parameters](#parameters)
+- [Return Values](#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. <br/>It can be exposed by the environment variable `LINODE_API_TOKEN` instead. <br/>See details in [Usage](https://github.com/linode/ansible_linode?tab=readme-ov-file#usage). |
+
+## Examples
+
+```yaml
+- name: List all of the Linode Maintenance Policies
+  linode.cloud.maintenance_policy_list: {}
+```
+
+```yaml
+
+```
+
+
+## Parameters
+
+| Field     | Type | Required | Description                                                                  |
+|-----------|------|----------|------------------------------------------------------------------------------|
+| `order` | <center>`str`</center> | <center>Optional</center> | The order to list Maintenance Policies in.  **(Choices: `desc`, `asc`; Default: `asc`)** |
+| `order_by` | <center>`str`</center> | <center>Optional</center> | The attribute to order Maintenance Policies by.   |
+| [`filters` (sub-options)](#filters) | <center>`list`</center> | <center>Optional</center> | A list of filters to apply to the resulting Maintenance Policies.   |
+| `count` | <center>`int`</center> | <center>Optional</center> | The number of Maintenance Policies to return. If undefined, all results will be returned.   |
+
+### filters
+
+| Field     | Type | Required | Description                                                                  |
+|-----------|------|----------|------------------------------------------------------------------------------|
+| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable fields can be found [here](https://techdocs.akamai.com/linode-api/reference/get-policies).   |
+| `values` | <center>`list`</center> | <center>**Required**</center> | 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:
+        ```json
+        [
+            {
+              "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](https://techdocs.akamai.com/linode-api/reference/get-policies) for a list of returned fields
+
+

plugins/module_utils/doc_fragments/account_settings.py

@@ -11,5 +11,6 @@
   "longview_subscription": "longview-3",
   "managed": true,
   "network_helper": false,
-  "object_storage": "active"
+  "object_storage": "active",
+  "maintenance_policy": "linode/migrate"
 }''']

plugins/module_utils/doc_fragments/instance.py

@@ -129,6 +129,7 @@
   "watchdog_enabled": true,
   "disk_encryption": "enabled",
   "lke_cluster_id": null,
+  "maintenance_policy": "linode/migrate",
   "placement_group": {
     "id": 123,
     "label": "test",

plugins/module_utils/doc_fragments/instance_list.py

@@ -9,7 +9,7 @@
       - name: label
         values: myInstanceLabel''']
 
-result_images_samples = ['''[
+result_instances_samples = ['''[
    {
       "alerts": {
         "cpu": 180,
@@ -55,6 +55,7 @@
       "updated": "2018-01-01T00:01:01",
       "watchdog_enabled": true,
       "disk_encryption": "enabled",
-      "lke_cluster_id": null
+      "lke_cluster_id": null,
+      "maintenance_policy": "linode/migrate"
     }
 ]''']

plugins/module_utils/doc_fragments/maintenance_policy_list.py

@@ -0,0 +1,25 @@
+"""Documentation fragments for the maintenance_policy_list module"""
+
+specdoc_examples = ['''
+- name: List all of the Linode Maintenance Policies
+  linode.cloud.maintenance_policy_list: {}''', '''
+''']
+
+result_maintenance_policy_samples = ['''[
+    {
+      "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
+    }
+]''']

plugins/modules/account_settings.py

@@ -57,6 +57,14 @@
             "for new Linodes and Linode Configs."
         ],
     ),
+    "maintenance_policy": SpecField(
+        type=FieldType.string,
+        description=[
+            "The Slug of the maintenance policy associated with the account.",
+            "NOTE: This field is under v4beta.",
+        ],
+        choices=["linode/migrate", "linode/power_off_on"],
+    ),
 }
 
 SPECDOC_META = SpecDocMeta(
@@ -75,7 +83,7 @@
     },
 )
 
-MUTABLE_FIELDS = {"backups_enabled", "network_helper"}
+MUTABLE_FIELDS = {"backups_enabled", "network_helper", "maintenance_policy"}
 
 DOCUMENTATION = r"""
 """

plugins/modules/instance.py

@@ -357,6 +357,14 @@
         element_type=FieldType.string,
         description=["A list of usernames."],
     ),
+    "maintenance_policy": SpecField(
+        type=FieldType.string,
+        description=[
+            "The slug of the maintenance policy to apply during maintenance.",
+            "NOTE: This field is under v4beta.",
+        ],
+        choices=["linode/migrate", "linode/power_off_on"],
+    ),
     "root_pass": SpecField(
         type=FieldType.string,
         no_log=True,
@@ -592,7 +600,7 @@
 )
 
 # Fields that can be updated on an existing instance
-MUTABLE_FIELDS = {"group", "tags"}
+MUTABLE_FIELDS = {"group", "tags", "maintenance_policy"}
 
 linode_instance_config_mutable = {
     "comments",

plugins/modules/instance_list.py

@@ -15,7 +15,7 @@
     endpoint_template="/linode/instances",
     result_docs_url="https://techdocs.akamai.com/linode-api/reference/get-linode-instances",
     examples=docs.specdoc_examples,
-    result_samples=docs.result_images_samples,
+    result_samples=docs.result_instances_samples,
 )
 
 SPECDOC_META = module.spec