@user/proxmox/vm

Model type — v2026.02.11.2

Details

Type
@user/proxmox/vm
Normalized
@user/proxmox/vm
Version
v2026.02.11.2
Methods
8
Resources
1
Files
0
Definitions
1

Global Arguments

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "apiUrl": {
      "type": "string",
      "description": "Proxmox API base URL (e.g., https://10.0.0.4:8006)"
    },
    "ticket": {
      "description": "Auth ticket from keebDev02",
      "type": "string"
    },
    "csrfToken": {
      "description": "CSRF token from keebDev02",
      "type": "string"
    },
    "node": {
      "type": "string",
      "description": "Proxmox node name"
    },
    "skipTlsVerify": {
      "default": true,
      "description": "Skip TLS certificate verification",
      "type": "boolean"
    }
  },
  "required": [
    "apiUrl",
    "node",
    "skipTlsVerify"
  ],
  "additionalProperties": false
}

Methods (8)

lookup

Look up VM by name, return vmid and IP if running

Input Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "vmName": {
      "type": "string",
      "description": "VM name to manage"
    }
  },
  "required": [
    "vmName"
  ],
  "additionalProperties": false
}
start

Start VM if stopped (idempotent), wait for IP. Replaces ensureVmRunning.

Input Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "vmName": {
      "type": "string",
      "description": "VM name to manage"
    },
    "waitSeconds": {
      "default": 120,
      "description": "Max seconds to wait for VM IP",
      "type": "number"
    },
    "pollInterval": {
      "default": 5,
      "description": "Seconds between IP poll attempts",
      "type": "number"
    }
  },
  "required": [
    "vmName",
    "waitSeconds",
    "pollInterval"
  ],
  "additionalProperties": false
}
stop

Stop a VM by name

Input Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "vmName": {
      "type": "string",
      "description": "VM name to manage"
    }
  },
  "required": [
    "vmName"
  ],
  "additionalProperties": false
}
create

Create a new VM with PXE boot enabled, auto-allocating vmid

Input Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "vmName": {
      "type": "string",
      "description": "VM name to manage"
    },
    "memory": {
      "description": "Memory in MB (default 2048)",
      "type": "number"
    },
    "cores": {
      "description": "CPU cores (default 2)",
      "type": "number"
    },
    "sockets": {
      "description": "CPU sockets (default 1)",
      "type": "number"
    },
    "diskSize": {
      "description": "Disk size in GB (default 32, 0 for PXE-only)",
      "type": "number"
    },
    "diskStorage": {
      "description": "Storage pool (default 'local-lvm')",
      "type": "string"
    },
    "networkBridge": {
      "description": "Network bridge (default 'vmbr0')",
      "type": "string"
    },
    "osType": {
      "description": "OS type (default 'l26')",
      "type": "string"
    }
  },
  "required": [
    "vmName"
  ],
  "additionalProperties": false
}
delete

Stop (if running) and delete a VM by name

Input Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "vmName": {
      "type": "string",
      "description": "VM name to manage"
    }
  },
  "required": [
    "vmName"
  ],
  "additionalProperties": false
}
setBootOrder

Set VM boot order via Proxmox API

Input Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "vmName": {
      "type": "string",
      "description": "VM name to manage"
    },
    "boot": {
      "type": "string",
      "description": "Boot order string (e.g. 'order=scsi0;net0')"
    }
  },
  "required": [
    "vmName",
    "boot"
  ],
  "additionalProperties": false
}
setConfig

Set arbitrary VM config options via Proxmox API (e.g. agent, memory, cores)

Input Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "vmName": {
      "type": "string",
      "description": "VM name to manage"
    },
    "config": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      },
      "description": "Arbitrary VM config key/values for setConfig method"
    }
  },
  "required": [
    "vmName",
    "config"
  ],
  "additionalProperties": false
}
sync

Sync all VMs from Proxmox — writes a named resource per VM

Input Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Resources (1)

vm

VM operation result

Lifetime
infinite
Garbage Collection
10

Definitions (1)

NameVersionTagsID
fleetv1a2781eda