@nightsquawktech/proxmox-mcp-server 0.1.0

package/dist/catalog-pve/endpoints/post_cluster_ha_resources_sid_migrate.json

@@ -0,0 +1,88 @@
+{
+  "operationId": "post_cluster_ha_resources_sid_migrate",
+  "surface": "pve",
+  "resource": "cluster",
+  "category": "Cluster",
+  "name": "migrate",
+  "method": "POST",
+  "path": "/cluster/ha/resources/{sid}/migrate",
+  "description": "Request resource migration (online) to another node.",
+  "writeOperation": true,
+  "destructive": true,
+  "protected": true,
+  "allowtoken": true,
+  "paramLocation": "body",
+  "pathParams": [
+    {
+      "name": "sid",
+      "type": "string",
+      "required": true,
+      "description": "HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).",
+      "format": "pve-ha-resource-or-vm-id",
+      "typetext": "<type>:<name>"
+    }
+  ],
+  "params": [
+    {
+      "name": "node",
+      "type": "string",
+      "required": true,
+      "description": "Target node.",
+      "format": "pve-node",
+      "typetext": "<string>"
+    }
+  ],
+  "returns": {
+    "properties": {
+      "blocking-resources": {
+        "description": "HA resources, which are blocking the given HA resource from being migrated to the requested target node.",
+        "items": {
+          "description": "A blocking HA resource",
+          "properties": {
+            "cause": {
+              "description": "The reason why the HA resource is blocking the migration.",
+              "enum": [
+                "node-affinity",
+                "resource-affinity"
+              ],
+              "type": "string"
+            },
+            "sid": {
+              "description": "The blocking HA resource id",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "optional": 1,
+        "type": "array"
+      },
+      "comigrated-resources": {
+        "description": "HA resources, which are migrated to the same requested target node as the given HA resource, because these are in positive affinity with the HA resource.",
+        "optional": 1,
+        "type": "array"
+      },
+      "requested-node": {
+        "description": "Node, which was requested to be migrated to.",
+        "optional": 0,
+        "type": "string"
+      },
+      "sid": {
+        "description": "HA resource, which is requested to be migrated.",
+        "optional": 0,
+        "type": "string"
+      }
+    },
+    "type": "object"
+  },
+  "permissions": {
+    "check": [
+      "perm",
+      "/",
+      [
+        "Sys.Console"
+      ]
+    ]
+  },
+  "requestSample": "curl -k -X POST -H 'Authorization: PVEAPIToken=USER@REALM!TOKENID=SECRET' -H 'Content-Type: application/json' \\\n  -d '{\"node\":\"<node>\"}' 'https://PVE_HOST:8006/api2/json/cluster/ha/resources/<sid>/migrate'"
+}

package/dist/catalog-pve/endpoints/post_cluster_ha_resources_sid_relocate.json

@@ -0,0 +1,92 @@
+{
+  "operationId": "post_cluster_ha_resources_sid_relocate",
+  "surface": "pve",
+  "resource": "cluster",
+  "category": "Cluster",
+  "name": "relocate",
+  "method": "POST",
+  "path": "/cluster/ha/resources/{sid}/relocate",
+  "description": "Request resource relocation to another node. This stops the service on the old node, and restarts it on the target node.",
+  "writeOperation": true,
+  "destructive": false,
+  "protected": true,
+  "allowtoken": true,
+  "paramLocation": "body",
+  "pathParams": [
+    {
+      "name": "sid",
+      "type": "string",
+      "required": true,
+      "description": "HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).",
+      "format": "pve-ha-resource-or-vm-id",
+      "typetext": "<type>:<name>"
+    }
+  ],
+  "params": [
+    {
+      "name": "node",
+      "type": "string",
+      "required": true,
+      "description": "Target node.",
+      "format": "pve-node",
+      "typetext": "<string>"
+    }
+  ],
+  "returns": {
+    "properties": {
+      "blocking-resources": {
+        "description": "HA resources, which are blocking the given HA resource from being relocated to the requested target node.",
+        "items": {
+          "description": "A blocking HA resource",
+          "properties": {
+            "cause": {
+              "description": "The reason why the HA resource is blocking the relocation.",
+              "enum": [
+                "node-affinity",
+                "resource-affinity"
+              ],
+              "type": "string"
+            },
+            "sid": {
+              "description": "The blocking HA resource id",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "optional": 1,
+        "type": "array"
+      },
+      "comigrated-resources": {
+        "description": "HA resources, which are relocated to the same requested target node as the given HA resource, because these are in positive affinity with the HA resource.",
+        "items": {
+          "description": "A comigrated HA resource",
+          "type": "string"
+        },
+        "optional": 1,
+        "type": "array"
+      },
+      "requested-node": {
+        "description": "Node, which was requested to be relocated to.",
+        "optional": 0,
+        "type": "string"
+      },
+      "sid": {
+        "description": "HA resource, which is requested to be relocated.",
+        "optional": 0,
+        "type": "string"
+      }
+    },
+    "type": "object"
+  },
+  "permissions": {
+    "check": [
+      "perm",
+      "/",
+      [
+        "Sys.Console"
+      ]
+    ]
+  },
+  "requestSample": "curl -k -X POST -H 'Authorization: PVEAPIToken=USER@REALM!TOKENID=SECRET' -H 'Content-Type: application/json' \\\n  -d '{\"node\":\"<node>\"}' 'https://PVE_HOST:8006/api2/json/cluster/ha/resources/<sid>/relocate'"
+}

package/dist/catalog-pve/endpoints/post_cluster_ha_rules.json

@@ -0,0 +1,98 @@
+{
+  "operationId": "post_cluster_ha_rules",
+  "surface": "pve",
+  "resource": "cluster",
+  "category": "Cluster",
+  "name": "create_rule",
+  "method": "POST",
+  "path": "/cluster/ha/rules",
+  "description": "Create HA rule.",
+  "writeOperation": true,
+  "destructive": false,
+  "protected": true,
+  "allowtoken": true,
+  "paramLocation": "body",
+  "pathParams": [],
+  "params": [
+    {
+      "name": "affinity",
+      "type": "string",
+      "required": false,
+      "description": "Describes whether the HA resources are supposed to be kept on the same node ('positive'), or are supposed to be kept on separate nodes ('negative').",
+      "enum": [
+        "positive",
+        "negative"
+      ]
+    },
+    {
+      "name": "comment",
+      "type": "string",
+      "required": false,
+      "description": "HA rule description.",
+      "maxLength": 4096,
+      "typetext": "<string>"
+    },
+    {
+      "name": "disable",
+      "type": "boolean",
+      "required": false,
+      "description": "Whether the HA rule is disabled.",
+      "typetext": "<boolean>"
+    },
+    {
+      "name": "nodes",
+      "type": "string",
+      "required": false,
+      "description": "List of cluster node names with optional priority.",
+      "format": "pve-ha-node-list",
+      "typetext": "<node>[:<pri>]{,<node>[:<pri>]}*"
+    },
+    {
+      "name": "resources",
+      "type": "string",
+      "required": true,
+      "description": "List of HA resource IDs. This consists of a list of resource types followed by a resource specific name separated with a colon (example: vm:100,ct:101).",
+      "format": "pve-ha-resource-id-list",
+      "typetext": "<type>:<name>{,<type>:<name>}*"
+    },
+    {
+      "name": "rule",
+      "type": "string",
+      "required": true,
+      "description": "HA rule identifier.",
+      "format": "pve-configid",
+      "typetext": "<string>"
+    },
+    {
+      "name": "strict",
+      "type": "boolean",
+      "required": false,
+      "description": "Describes whether the node affinity rule is strict or non-strict.",
+      "default": 0,
+      "typetext": "<boolean>"
+    },
+    {
+      "name": "type",
+      "type": "string",
+      "required": true,
+      "description": "HA rule type.",
+      "enum": [
+        "node-affinity",
+        "resource-affinity"
+      ]
+    }
+  ],
+  "returns": {
+    "type": "null"
+  },
+  "permissions": {
+    "check": [
+      "perm",
+      "/",
+      [
+        "Sys.Console"
+      ]
+    ]
+  },
+  "requestSample": "curl -k -X POST -H 'Authorization: PVEAPIToken=USER@REALM!TOKENID=SECRET' -H 'Content-Type: application/json' \\\n  -d '{\"resources\":\"<resources>\",\"rule\":\"<rule>\",\"type\":\"node-affinity\"}' 'https://PVE_HOST:8006/api2/json/cluster/ha/rules'"
+}

package/dist/catalog-pve/endpoints/post_cluster_ha_status_arm_ha.json

@@ -0,0 +1,30 @@
+{
+  "operationId": "post_cluster_ha_status_arm_ha",
+  "surface": "pve",
+  "resource": "cluster",
+  "category": "Cluster",
+  "name": "arm-ha",
+  "method": "POST",
+  "path": "/cluster/ha/status/arm-ha",
+  "description": "Request re-arming the HA stack after it was disarmed.",
+  "writeOperation": true,
+  "destructive": false,
+  "protected": true,
+  "allowtoken": true,
+  "paramLocation": "body",
+  "pathParams": [],
+  "params": [],
+  "returns": {
+    "type": "null"
+  },
+  "permissions": {
+    "check": [
+      "perm",
+      "/",
+      [
+        "Sys.Console"
+      ]
+    ]
+  },
+  "requestSample": "curl -k -X POST -H 'Authorization: PVEAPIToken=USER@REALM!TOKENID=SECRET' -H 'Content-Type: application/json' \\\n  -d '{}' 'https://PVE_HOST:8006/api2/json/cluster/ha/status/arm-ha'"
+}

package/dist/catalog-pve/endpoints/post_cluster_ha_status_disarm_ha.json

@@ -0,0 +1,41 @@
+{
+  "operationId": "post_cluster_ha_status_disarm_ha",
+  "surface": "pve",
+  "resource": "cluster",
+  "category": "Cluster",
+  "name": "disarm-ha",
+  "method": "POST",
+  "path": "/cluster/ha/status/disarm-ha",
+  "description": "Request disarming the HA stack, releasing all watchdogs cluster-wide.",
+  "writeOperation": true,
+  "destructive": false,
+  "protected": true,
+  "allowtoken": true,
+  "paramLocation": "body",
+  "pathParams": [],
+  "params": [
+    {
+      "name": "resource-mode",
+      "type": "string",
+      "required": true,
+      "description": "Controls how HA managed resources are handled while disarmed. The current state of resources is not affected. 'freeze': new commands and state changes are not applied. 'ignore': resources are removed from HA tracking and can be managed as if they were not HA managed.",
+      "enum": [
+        "freeze",
+        "ignore"
+      ]
+    }
+  ],
+  "returns": {
+    "type": "null"
+  },
+  "permissions": {
+    "check": [
+      "perm",
+      "/",
+      [
+        "Sys.Console"
+      ]
+    ]
+  },
+  "requestSample": "curl -k -X POST -H 'Authorization: PVEAPIToken=USER@REALM!TOKENID=SECRET' -H 'Content-Type: application/json' \\\n  -d '{\"resource-mode\":\"freeze\"}' 'https://PVE_HOST:8006/api2/json/cluster/ha/status/disarm-ha'"
+}

package/dist/catalog-pve/endpoints/post_cluster_jobs_realm_sync_id.json

@@ -0,0 +1,114 @@
+{
+  "operationId": "post_cluster_jobs_realm_sync_id",
+  "surface": "pve",
+  "resource": "cluster",
+  "category": "Cluster",
+  "name": "create_job",
+  "method": "POST",
+  "path": "/cluster/jobs/realm-sync/{id}",
+  "description": "Create new realm-sync job.",
+  "writeOperation": true,
+  "destructive": false,
+  "protected": true,
+  "allowtoken": true,
+  "paramLocation": "body",
+  "pathParams": [
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The ID of the job.",
+      "format": "pve-configid",
+      "maxLength": 64,
+      "typetext": "<string>"
+    }
+  ],
+  "params": [
+    {
+      "name": "comment",
+      "type": "string",
+      "required": false,
+      "description": "Description for the Job.",
+      "maxLength": 512,
+      "typetext": "<string>"
+    },
+    {
+      "name": "enable-new",
+      "type": "boolean",
+      "required": false,
+      "description": "Enable newly synced users immediately.",
+      "default": "1",
+      "typetext": "<boolean>"
+    },
+    {
+      "name": "enabled",
+      "type": "boolean",
+      "required": false,
+      "description": "Determines if the job is enabled.",
+      "default": 1,
+      "typetext": "<boolean>"
+    },
+    {
+      "name": "realm",
+      "type": "string",
+      "required": false,
+      "description": "Authentication domain ID",
+      "format": "pve-realm",
+      "maxLength": 32,
+      "typetext": "<string>"
+    },
+    {
+      "name": "remove-vanished",
+      "type": "string",
+      "required": false,
+      "description": "A semicolon-separated list of things to remove when they or the user vanishes during a sync. The following values are possible: 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default).",
+      "default": "none",
+      "typetext": "([acl];[properties];[entry])|none",
+      "pattern": "(?:(?:(?:acl|properties|entry);)*(?:acl|properties|entry))|none"
+    },
+    {
+      "name": "schedule",
+      "type": "string",
+      "required": true,
+      "description": "Backup schedule. The format is a subset of `systemd` calendar events.",
+      "format": "pve-calendar-event",
+      "maxLength": 128,
+      "typetext": "<string>"
+    },
+    {
+      "name": "scope",
+      "type": "string",
+      "required": false,
+      "description": "Select what to sync.",
+      "enum": [
+        "users",
+        "groups",
+        "both"
+      ]
+    }
+  ],
+  "returns": {
+    "type": "null"
+  },
+  "permissions": {
+    "check": [
+      "and",
+      [
+        "perm",
+        "/access/realm/{realm}",
+        [
+          "Realm.AllocateUser"
+        ]
+      ],
+      [
+        "perm",
+        "/access/groups",
+        [
+          "User.Modify"
+        ]
+      ]
+    ],
+    "description": "'Realm.AllocateUser' on '/access/realm/<realm>' and 'User.Modify' permissions to '/access/groups/'."
+  },
+  "requestSample": "curl -k -X POST -H 'Authorization: PVEAPIToken=USER@REALM!TOKENID=SECRET' -H 'Content-Type: application/json' \\\n  -d '{\"schedule\":\"<schedule>\"}' 'https://PVE_HOST:8006/api2/json/cluster/jobs/realm-sync/<id>'"
+}

package/dist/catalog-pve/endpoints/post_cluster_mapping_dir.json

@@ -0,0 +1,54 @@
+{
+  "operationId": "post_cluster_mapping_dir",
+  "surface": "pve",
+  "resource": "cluster",
+  "category": "Cluster",
+  "name": "create",
+  "method": "POST",
+  "path": "/cluster/mapping/dir",
+  "description": "Create a new directory mapping.",
+  "writeOperation": true,
+  "destructive": false,
+  "protected": true,
+  "allowtoken": true,
+  "paramLocation": "body",
+  "pathParams": [],
+  "params": [
+    {
+      "name": "description",
+      "type": "string",
+      "required": false,
+      "description": "Description of the directory mapping",
+      "maxLength": 4096,
+      "typetext": "<string>"
+    },
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The ID of the directory mapping",
+      "format": "pve-configid",
+      "typetext": "<string>"
+    },
+    {
+      "name": "map",
+      "type": "array",
+      "required": true,
+      "description": "A list of maps for the cluster nodes.",
+      "typetext": "<array>"
+    }
+  ],
+  "returns": {
+    "type": "null"
+  },
+  "permissions": {
+    "check": [
+      "perm",
+      "/mapping/dir",
+      [
+        "Mapping.Modify"
+      ]
+    ]
+  },
+  "requestSample": "curl -k -X POST -H 'Authorization: PVEAPIToken=USER@REALM!TOKENID=SECRET' -H 'Content-Type: application/json' \\\n  -d '{\"id\":\"<id>\",\"map\":\"<map>\"}' 'https://PVE_HOST:8006/api2/json/cluster/mapping/dir'"
+}

package/dist/catalog-pve/endpoints/post_cluster_mapping_pci.json

@@ -0,0 +1,70 @@
+{
+  "operationId": "post_cluster_mapping_pci",
+  "surface": "pve",
+  "resource": "cluster",
+  "category": "Cluster",
+  "name": "create",
+  "method": "POST",
+  "path": "/cluster/mapping/pci",
+  "description": "Create a new hardware mapping.",
+  "writeOperation": true,
+  "destructive": false,
+  "protected": true,
+  "allowtoken": true,
+  "paramLocation": "body",
+  "pathParams": [],
+  "params": [
+    {
+      "name": "description",
+      "type": "string",
+      "required": false,
+      "description": "Description of the logical PCI device.",
+      "maxLength": 4096,
+      "typetext": "<string>"
+    },
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The ID of the logical PCI mapping.",
+      "format": "pve-configid",
+      "typetext": "<string>"
+    },
+    {
+      "name": "live-migration-capable",
+      "type": "boolean",
+      "required": false,
+      "description": "Marks the device(s) as being able to be live-migrated (Experimental). This needs hardware and driver support to work.",
+      "default": 0,
+      "typetext": "<boolean>"
+    },
+    {
+      "name": "map",
+      "type": "array",
+      "required": true,
+      "description": "A list of maps for the cluster nodes.",
+      "typetext": "<array>"
+    },
+    {
+      "name": "mdev",
+      "type": "boolean",
+      "required": false,
+      "description": "Marks the device(s) as being capable of providing mediated devices.",
+      "default": 0,
+      "typetext": "<boolean>"
+    }
+  ],
+  "returns": {
+    "type": "null"
+  },
+  "permissions": {
+    "check": [
+      "perm",
+      "/mapping/pci",
+      [
+        "Mapping.Modify"
+      ]
+    ]
+  },
+  "requestSample": "curl -k -X POST -H 'Authorization: PVEAPIToken=USER@REALM!TOKENID=SECRET' -H 'Content-Type: application/json' \\\n  -d '{\"id\":\"<id>\",\"map\":\"<map>\"}' 'https://PVE_HOST:8006/api2/json/cluster/mapping/pci'"
+}

package/dist/catalog-pve/endpoints/post_cluster_mapping_usb.json

@@ -0,0 +1,54 @@
+{
+  "operationId": "post_cluster_mapping_usb",
+  "surface": "pve",
+  "resource": "cluster",
+  "category": "Cluster",
+  "name": "create",
+  "method": "POST",
+  "path": "/cluster/mapping/usb",
+  "description": "Create a new hardware mapping.",
+  "writeOperation": true,
+  "destructive": false,
+  "protected": true,
+  "allowtoken": true,
+  "paramLocation": "body",
+  "pathParams": [],
+  "params": [
+    {
+      "name": "description",
+      "type": "string",
+      "required": false,
+      "description": "Description of the logical USB device.",
+      "maxLength": 4096,
+      "typetext": "<string>"
+    },
+    {
+      "name": "id",
+      "type": "string",
+      "required": true,
+      "description": "The ID of the logical USB mapping.",
+      "format": "pve-configid",
+      "typetext": "<string>"
+    },
+    {
+      "name": "map",
+      "type": "array",
+      "required": true,
+      "description": "A list of maps for the cluster nodes.",
+      "typetext": "<array>"
+    }
+  ],
+  "returns": {
+    "type": "null"
+  },
+  "permissions": {
+    "check": [
+      "perm",
+      "/mapping/usb",
+      [
+        "Mapping.Modify"
+      ]
+    ]
+  },
+  "requestSample": "curl -k -X POST -H 'Authorization: PVEAPIToken=USER@REALM!TOKENID=SECRET' -H 'Content-Type: application/json' \\\n  -d '{\"id\":\"<id>\",\"map\":\"<map>\"}' 'https://PVE_HOST:8006/api2/json/cluster/mapping/usb'"
+}