Updated maintenance_policy_id to maintenance_polic

Author: ezilber-akamai

linode_api4/groups/linode.py

@@ -153,7 +153,7 @@ def instance_create(
                 int,
             ]
         ] = None,
-        maintenance_policy_id: Optional[int] = None,
+        maintenance_policy: Optional[str] = None,
         **kwargs,
     ):
         """
@@ -297,9 +297,9 @@ def instance_create(
         :type interfaces: list[ConfigInterface] or list[dict[str, Any]]
         :param placement_group: A Placement Group to create this Linode under.
         :type placement_group: Union[InstancePlacementGroupAssignment, PlacementGroup, Dict[str, Any], int]
-        :param maintenance_policy_id: The ID of the maintenance policy to apply during maintenance.
-                                      If not provided, the default policy (migrate) will be applied.
-        :type maintenance_policy_id: int
+        :param maintenance_policy: The slug of the maintenance policy to apply during maintenance.
+                                      If not provided, the default policy (linode/migrate) will be applied.
+        :type maintenance_policy: str
 
         :returns: A new Instance object, or a tuple containing the new Instance and
                   the generated password.
@@ -331,7 +331,7 @@ def instance_create(
             "firewall_id": firewall,
             "backup_id": backup,
             "stackscript_id": stackscript,
-            "maintenance_policy_id": maintenance_policy_id,
+            "maintenance_policy": maintenance_policy,
             # Special cases
             "disk_encryption": (
                 str(disk_encryption) if disk_encryption else None

linode_api4/objects/account.py

@@ -197,7 +197,7 @@ class AccountSettings(Base):
         ),
         "object_storage": Property(),
         "backups_enabled": Property(mutable=True),
-        "maintenance_policy_id": Property(mutable=True),
+        "maintenance_policy": Property(mutable=True),
     }
 
 

linode_api4/objects/linode.py

@@ -686,7 +686,7 @@ class Instance(Base):
         "disk_encryption": Property(),
         "lke_cluster_id": Property(),
         "capabilities": Property(unordered=True),
-        "maintenance_policy_id": Property(mutable=True),
+        "maintenance_policy": Property(mutable=True),
     }
 
     @property

test/fixtures/account_maintenance.json

@@ -1,30 +1,41 @@
 {
   "pages": 1,
   "page": 1,
-  "results": 1,
+  "results": 2,
   "data": [
     {
-      "body": "Scheduled upgrade to faster NVMe hardware. This will affect Linode #1234.",
       "entity": {
         "id": 1234,
         "label": "Linode #1234",
         "type": "linode",
         "url": "/linodes/1234"
       },
-      "label": "Scheduled Maintenance for Linode #1234",
-      "message": "Scheduled upgrade to faster NVMe hardware.",
-      "severity": "major",
-      "type": "maintenance_scheduled",
-      "event_type": "linode_migrate",
-      "maintenance_policy_set": "Power on/off",
+      "reason": "Scheduled upgrade to faster NVMe hardware.",
+      "type": "linode_migrate",
+      "maintenance_policy_set": "linode/power_off_on",
       "description": "Scheduled Maintenance",
       "source": "platform",
-      "not_before": "2025-03-25T10:00:00",
-      "start_time": "2025-03-25T12:00:00",
-      "complete_time": "2025-03-25T14:00:00",
-      "status": "scheduled",
-      "when": "2025-03-25T12:00:00",
-      "until": "2025-03-25T14:00:00"
+      "not_before": "2025-03-25T10:00:00Z",
+      "start_time": "2025-03-25T12:00:00Z",
+      "complete_time": "2025-03-25T14:00:00Z",
+      "status": "scheduled"
+    },
+    {
+      "entity": {
+        "id": 1234,
+        "label": "Linode #1234",
+        "type": "linode",
+        "url": "/linodes/1234"
+      },
+      "reason": "Pending migration of Linode #1234 to a new host.",
+      "type": "linode_migrate",
+      "maintenance_policy_set": "linode/migrate",
+      "description": "Emergency Maintenance",
+      "source": "user",
+      "not_before": "2025-03-26T15:00:00Z",
+      "start_time": "2025-03-26T15:00:00Z",
+      "complete_time": "2025-03-26T17:00:00Z",
+      "status": "in-progress"
     }
   ]
-}
+}

test/fixtures/account_settings.json

@@ -4,5 +4,5 @@
   "network_helper": false,
   "object_storage": "active",
   "backups_enabled": true,
-  "maintenance_policy_id": 1
+  "maintenance_policy": "linode/migrate"
 }

test/fixtures/linode_instances.json

@@ -49,7 +49,7 @@
         "placement_group_type": "anti_affinity:local",
         "placement_group_policy": "strict"
       },
-      "maintenance_policy_id" : 1
+      "maintenance_policy" : "linode/migrate"
     },
     {
       "group": "test",
@@ -92,7 +92,7 @@
       "disk_encryption": "enabled",
       "lke_cluster_id": 18881,
       "placement_group": null,
-      "maintenance_policy_id" : 2
+      "maintenance_policy" : "linode/power_off_on"
     }
   ]
 }

test/fixtures/maintenance_policies.json

@@ -1,18 +1,26 @@
 [
   {
-    "id": "1",
-    "name": "Default Migrate",
-    "description": "predefined maintenance policy default for all linodes",
+    "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": 3600,
     "is_default": true
   },
   {
-    "id": "2",
-    "name": "Default Power On/Off",
-    "description": "predefined maintenance policy for general use cases",
-    "type": "power on/off",
+    "slug": "linode/power_off_on",
+    "label": "Power Off/Power 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
+  },
+  {
+    "slug": "private/12345",
+    "label": "Critical Workload - Avoid Migration",
+    "description": "Custom policy designed to power off and perform maintenance during user-defined windows only.",
+    "type": "power_off_on",
+    "notification_period_sec": 7200,
+    "is_default": false
   }
 ]

test/unit/groups/linode_test.py

@@ -96,7 +96,7 @@ def test_create_with_placement_group(self):
             m.call_data["placement_group"], {"id": 123, "compliant_only": True}
         )
 
-    def test_create_with_mainteance_policy_id(self):
+    def test_create_with_maintenance_policy(self):
         """
         Tests that you can create a Linode with a maintenance policy
         """
@@ -105,10 +105,10 @@ def test_create_with_mainteance_policy_id(self):
             self.client.linode.instance_create(
                 "g6-nanode-1",
                 "eu-west",
-                maintenance_policy_id=1,
+                maintenance_policy="linode/migrate",
             )
 
-        self.assertEqual(m.call_data["maintenance_policy_id"], 1)
+        self.assertEqual(m.call_data["maintenance_policy"], "linode/migrate")
 
 
 class TypeTest(ClientBaseCase):

test/unit/linode_client_test.py

@@ -315,41 +315,49 @@ class MaintenanceGroupTest(ClientBaseCase):
     def test_maintenance(self):
         """
         Tests that maintenance can be retrieved
+        Tests that maintenance can be retrieved
         """
         with self.mock_get("/maintenance/policies") as m:
             result = self.client.maintenance.maintenance_policies()
 
             self.assertEqual(m.call_url, "/maintenance/policies")
-            self.assertEqual(len(result), 2)
+            self.assertEqual(len(result), 3)
 
-            policy_default_migrate = result[0]
-            policy_default_power_on_off = result[1]
+            policy_migrate = result[0]
+            policy_power_off_on = result[1]
+            policy_custom = result[2]
 
-            self.assertEqual(policy_default_migrate.id, "1")
-            self.assertEqual(policy_default_migrate.name, "Default Migrate")
-            self.assertEqual(
-                policy_default_migrate.description,
-                "predefined maintenance policy default for all linodes",
-            )
-            self.assertEqual(policy_default_migrate.type, "migrate")
+            self.assertEqual(policy_migrate.slug, "linode/migrate")
+            self.assertEqual(policy_migrate.label, "Migrate")
             self.assertEqual(
-                policy_default_migrate.notification_period_sec, 3600
+                policy_migrate.description,
+                "Migrates the Linode to a new host while it remains fully operational. Recommended for maximizing availability.",
             )
-            self.assertEqual(policy_default_migrate.is_default, True)
+            self.assertEqual(policy_migrate.type, "migrate")
+            self.assertEqual(policy_migrate.notification_period_sec, 3600)
+            self.assertTrue(policy_migrate.is_default)
 
-            self.assertEqual(policy_default_power_on_off.id, "2")
+            self.assertEqual(policy_power_off_on.slug, "linode/power_off_on")
+            self.assertEqual(policy_power_off_on.label, "Power Off/Power On")
             self.assertEqual(
-                policy_default_power_on_off.name, "Default Power On/Off"
+                policy_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.",
             )
+            self.assertEqual(policy_power_off_on.type, "power_off_on")
+            self.assertEqual(policy_power_off_on.notification_period_sec, 1800)
+            self.assertFalse(policy_power_off_on.is_default)
+
+            self.assertEqual(policy_custom.slug, "private/12345")
             self.assertEqual(
-                policy_default_power_on_off.description,
-                "predefined maintenance policy for general use cases",
+                policy_custom.label, "Critical Workload - Avoid Migration"
             )
-            self.assertEqual(policy_default_power_on_off.type, "power on/off")
             self.assertEqual(
-                policy_default_power_on_off.notification_period_sec, 1800
+                policy_custom.description,
+                "Custom policy designed to power off and perform maintenance during user-defined windows only.",
             )
-            self.assertEqual(policy_default_power_on_off.is_default, False)
+            self.assertEqual(policy_custom.type, "power_off_on")
+            self.assertEqual(policy_custom.notification_period_sec, 7200)
+            self.assertFalse(policy_custom.is_default)
 
 
 class AccountGroupTest(ClientBaseCase):
@@ -400,37 +408,54 @@ def test_maintenance(self):
             result = self.client.account.maintenance()
 
             self.assertEqual(m.call_url, "/account/maintenance")
-            self.assertEqual(len(result), 1)
+            self.assertEqual(len(result), 2)
+
+            maintenance_1 = result[0]
+            maintenance_2 = result[1]
 
-            maintenance = result[0]
+            # First maintenance
+            self.assertEqual(
+                maintenance_1.reason,
+                "Scheduled upgrade to faster NVMe hardware.",
+            )
+            self.assertEqual(maintenance_1.entity.id, 1234)
+            self.assertEqual(maintenance_1.entity.label, "Linode #1234")
+            self.assertEqual(maintenance_1.entity.type, "linode")
+            self.assertEqual(maintenance_1.entity.url, "/linodes/1234")
+            self.assertEqual(
+                maintenance_1.maintenance_policy_set, "linode/power_off_on"
+            )
+            self.assertEqual(maintenance_1.description, "Scheduled Maintenance")
+            self.assertEqual(maintenance_1.source, "platform")
+            self.assertEqual(maintenance_1.not_before, "2025-03-25T10:00:00Z")
+            self.assertEqual(maintenance_1.start_time, "2025-03-25T12:00:00Z")
+            self.assertEqual(
+                maintenance_1.complete_time, "2025-03-25T14:00:00Z"
+            )
+            self.assertEqual(maintenance_1.status, "scheduled")
+            self.assertEqual(maintenance_1.type, "linode_migrate")
 
+            # Second maintenance
             self.assertEqual(
-                maintenance.body,
-                "Scheduled upgrade to faster NVMe hardware. This will affect Linode #1234.",
+                maintenance_2.reason,
+                "Pending migration of Linode #1234 to a new host.",
             )
-            self.assertEqual(maintenance.entity.id, 1234)
-            self.assertEqual(maintenance.entity.label, "Linode #1234")
-            self.assertEqual(maintenance.entity.type, "linode")
-            self.assertEqual(maintenance.entity.url, "/linodes/1234")
+            self.assertEqual(maintenance_2.entity.id, 1234)
+            self.assertEqual(maintenance_2.entity.label, "Linode #1234")
+            self.assertEqual(maintenance_2.entity.type, "linode")
+            self.assertEqual(maintenance_2.entity.url, "/linodes/1234")
             self.assertEqual(
-                maintenance.label, "Scheduled Maintenance for Linode #1234"
+                maintenance_2.maintenance_policy_set, "linode/migrate"
             )
+            self.assertEqual(maintenance_2.description, "Emergency Maintenance")
+            self.assertEqual(maintenance_2.source, "user")
+            self.assertEqual(maintenance_2.not_before, "2025-03-26T15:00:00Z")
+            self.assertEqual(maintenance_2.start_time, "2025-03-26T15:00:00Z")
             self.assertEqual(
-                maintenance.message,
-                "Scheduled upgrade to faster NVMe hardware.",
+                maintenance_2.complete_time, "2025-03-26T17:00:00Z"
             )
-            self.assertEqual(maintenance.severity, "major")
-            self.assertEqual(maintenance.type, "maintenance_scheduled")
-            self.assertEqual(maintenance.event_type, "linode_migrate")
-            self.assertEqual(maintenance.maintenance_policy_set, "Power on/off")
-            self.assertEqual(maintenance.description, "Scheduled Maintenance")
-            self.assertEqual(maintenance.source, "platform")
-            self.assertEqual(maintenance.not_before, "2025-03-25T10:00:00")
-            self.assertEqual(maintenance.start_time, "2025-03-25T12:00:00")
-            self.assertEqual(maintenance.complete_time, "2025-03-25T14:00:00")
-            self.assertEqual(maintenance.status, "scheduled")
-            self.assertEqual(maintenance.when, "2025-03-25T12:00:00")
-            self.assertEqual(maintenance.until, "2025-03-25T14:00:00")
+            self.assertEqual(maintenance_2.status, "in-progress")
+            self.assertEqual(maintenance_2.type, "linode_migrate")
 
     def test_notifications(self):
         """

test/unit/objects/account_test.py

@@ -121,7 +121,7 @@ def test_get_account_settings(self):
         self.assertEqual(settings.network_helper, False)
         self.assertEqual(settings.object_storage, "active")
         self.assertEqual(settings.backups_enabled, True)
-        self.assertEqual(settings.maintenance_policy_id, 1)
+        self.assertEqual(settings.maintenance_policy, "linode/migrate")
 
     def test_update_account_settings(self):
         """
@@ -130,14 +130,14 @@ def test_update_account_settings(self):
         with self.mock_put("account/settings") as m:
             settings = AccountSettings(self.client, False, {})
 
-            settings.maintenance_policy_id = 1
+            settings.maintenance_policy = "linode/migrate"
             settings.save()
 
             self.assertEqual(m.call_url, "/account/settings")
             self.assertEqual(
                 m.call_data,
                 {
-                    "maintenance_policy_id": 1,
+                    "maintenance_policy": "linode/migrate",
                 },
             )