AI Server: Tools
Part of AI Server.
AI Server exposes 29 tools grouped by area, plus 2 additional Enterprise tools for SQL-like queries. Every tool except ListClusters takes the name of the cluster to work on as cluster_name. ListClusters returns the names of the enabled clusters.
A tool that cannot run answers with a JSON object carrying an error field, for example Permission denied, Cluster '<name>' not found or VM <id> not found.
Cluster
Section titled “Cluster”ListClusters
Section titled “ListClusters”List the enabled clusters with name and description
- Parameters: none
GetClusterStatus
Section titled “GetClusterStatus”Cluster health summary: quorum, node count (total and online), VM count (running/stopped/paused)
- Parameters:
cluster_name
GetClusterOptions
Section titled “GetClusterOptions”Cluster options: migration type and network, console type, keyboard layout, MAC prefix, description
- Parameters:
cluster_name
Virtual Machines
Section titled “Virtual Machines”ListVms
Section titled “ListVms”List VMs and containers with status and resource usage. Supports filters by status and type, and the Minimal or Full detail level
- Parameters:
cluster_name,status(optional: running, stopped, paused),type(optional: qemu, lxc),detail_level(Minimal, default, or Full)
ListSnapshots
Section titled “ListSnapshots”List VM snapshots with dates and, optionally, the disk size. The Full detail level adds description and parent. IDs that are not found are skipped
- Parameters:
cluster_name,vmids(array of VM IDs),detail_level(Minimal, default, or Full),include_size(default false, slower)
GetVmConfig
Section titled “GetVmConfig”VM/LXC configuration: CPU, memory, OS type, start on boot and startup order, protection, description, tags. For a VM also BIOS, KVM, ACPI and guest agent. Disks and network interfaces are not included
- Parameters:
cluster_name,vmid
ChangeVmState
Section titled “ChangeVmState”Change VM power state: Start, Stop (force), Shutdown (graceful), Reboot, Reset, Suspend, Resume
- Parameters:
cluster_name,vmid,action(Start, Stop, Shutdown, Reboot, Reset, Suspend, Resume) - Proxmox VE privilege:
VM.PowerMgmt
CreateVmSnapshot
Section titled “CreateVmSnapshot”Create a VM/LXC snapshot, with optional description and RAM state (QEMU only)
- Parameters:
cluster_name,vmid,snapshot_name,description(optional),include_vm_state(default false) - Proxmox VE privilege:
VM.Snapshot
DeleteVmSnapshot
Section titled “DeleteVmSnapshot”Delete a VM/LXC snapshot
- Parameters:
cluster_name,vmid,snapshot_name - Proxmox VE privilege:
VM.Snapshot
RollbackVmSnapshot
Section titled “RollbackVmSnapshot”Rollback a VM/LXC to a snapshot
- Parameters:
cluster_name,vmid,snapshot_name - Proxmox VE privilege:
VM.Snapshot.Rollback
MigrateVm
Section titled “MigrateVm”Migrate VM/LXC to another node, with optional live migration and target storage
- Parameters:
cluster_name,vmid,target_node,online(default false),target_storage(optional) - Proxmox VE privilege:
VM.Migrate
BackupVm
Section titled “BackupVm”Create a VM/LXC backup via vzdump with optional storage, mode, compression, protection flag, bandwidth limit
- Parameters:
cluster_name,vmid, and optionallystorage,mode(snapshot, suspend, stop),compress(0, 1, gzip, lzo, zstd),protected_backup,bwlimit(KiB/s) - Proxmox VE privilege:
VM.Backup,Datastore.AllocateSpace
ListVmRrdData
Section titled “ListVmRrdData”Historical metrics (CPU, Memory, Disk, Network, Pressure PSI) for one or more VMs. An ID that is not found gets an error entry in the result
- Parameters:
cluster_name,vmids(array of VM IDs),time_frame(Hour, Day, Week, Month, Year),consolidation(Average or Maximum),metrics(Cpu, Memory, Disk, Network, Pressure, or All)
ListNodes
Section titled “ListNodes”List cluster nodes with status and CPU, memory and disk usage. The Full detail level adds uptime, totals and the network traffic counters
- Parameters:
cluster_name,detail_level(Minimal, default, or Full)
GetNodeStatus
Section titled “GetNodeStatus”Detailed node status: PVE version, kernel, CPU model, memory, swap, load average, root fs
- Parameters:
cluster_name,node
ListReplications
Section titled “ListReplications”List cluster replications with schedule, sync status and error info
- Parameters:
cluster_name
ListNodeRrdData
Section titled “ListNodeRrdData”Historical metrics (CPU, Load avg, Memory, Swap, Disk, Network, Pressure PSI) for nodes
- Parameters:
cluster_name,nodes(optional array, all nodes if empty),time_frame,consolidation,metrics(same values asListVmRrdData)
ListTasks
Section titled “ListTasks”List cluster tasks (active and recent) with status, type, user and duration
- Parameters:
cluster_name,status(optional: running, stopped),type(optional task type, for example vzdump or qmstart),limit(default 50)
Storage & Backup
Section titled “Storage & Backup”ListStorage
Section titled “ListStorage”List cluster storage with type, status and usage, at the Minimal or Full detail level
- Parameters:
cluster_name,type(optional storage type, for example dir, lvm, lvmthin, zfs, cephfs),detail_level(Minimal, default, or Full)
ListPools
Section titled “ListPools”List cluster resource pools with descriptions
- Parameters:
cluster_name
ListBackups
Section titled “ListBackups”List backups on a specific node and storage, with optional VM ID filter
- Parameters:
cluster_name,node,storage,vmid(optional) - Proxmox VE privilege:
VM.Backup,Datastore.AllocateSpace
ListStorageContent
Section titled “ListStorageContent”List storage content (ISO, templates, images, backups) on a specific node and storage. Optional content type filter
- Parameters:
cluster_name,storage,node,content_type(optional: iso, vztmpl, backup, images)
ListIsos
Section titled “ListIsos”List ISO images available on a node storage
- Parameters:
cluster_name,node,storage
ListTemplates
Section titled “ListTemplates”List CT templates available on a node storage
- Parameters:
cluster_name,node,storage
ListBackupJobs
Section titled “ListBackupJobs”List cluster backup jobs with schedule, storage, compression and VM list
- Parameters:
cluster_name,vmid(optional)
DownloadIso
Section titled “DownloadIso”Download an ISO image to a node storage from a URL
- Parameters:
cluster_name,node,storage,url,filename - Proxmox VE privilege:
Datastore.AllocateTemplate
DeleteBackup
Section titled “DeleteBackup”Delete a backup from storage (use ListBackups to get the volid)
- Parameters:
cluster_name,node,storage,volid - Proxmox VE privilege:
Datastore.Allocate
DeleteIso
Section titled “DeleteIso”Delete an ISO image from storage (use ListIsos to get the volid)
- Parameters:
cluster_name,node,storage,volid - Proxmox VE privilege:
Datastore.Allocate
DeleteStorageContent
Section titled “DeleteStorageContent”Delete content from storage: ISO / template / image / backup (use ListStorageContent to get the volid)
- Parameters:
cluster_name,node,storage,volid - Proxmox VE privilege:
Datastore.Allocate
QueryEE
Section titled “Query”GetQuerySchema
Section titled “GetQuerySchema”Get detailed schema (fields and types) for Proxmox VE query tables
- Parameters:
cluster_name
ExecuteQuery
Section titled “ExecuteQuery”Execute SQL-like queries on cluster data (guests, nodes, storages, snapshots, …) with filters, grouping, aggregates (COUNT/SUM/AVERAGE/MIN/MAX) and ordering
- Parameters:
cluster_name,query_json
What can be asked, with examples of input and output, is in Query.
