Proxmox VE

Proxmox VE

Manage Proxmox VE infrastructure including virtual machines, containers, storage, networking, firewall rules, high availability, and more.

10K+

286 Tools

Packaged by
Requires Configuration
Requires Secrets
Add to Docker Desktop

Version 4.43 or later needs to be installed to add the server automatically

About

Proxmox VE MCP Server

Manage Proxmox VE infrastructure including virtual machines, containers, storage, networking, firewall rules, high availability, and more.

What is an MCP Server?⁠

MCP Info

Image Building Info

AttributeDetails
Dockerfilehttps://github.com/GethosTheWalrus/proxmox-mcp/blob/060b7f5bbbf14bb69f1dac928f1566125e0b03b5/Dockerfile⁠
Commit060b7f5bbbf14bb69f1dac928f1566125e0b03b5
Docker Image built byDocker Inc.
Docker Scout Health ScoreDocker Scout Health Score
Verify SignatureCOSIGN_REPOSITORY=mcp/signatures cosign verify mcp/proxmox --key https://raw.githubusercontent.com/docker/keyring/refs/heads/main/public/mcp/latest.pub
LicenceOther

Available Tools (286)

Tools provided by this ServerShort Description
add_firewall_ipset_entryAdd an IP/CIDR to an IP set.
allocate_storage_volumeAllocate a new disk volume in storage.
apply_sdn_changesApply pending SDN configuration changes to all nodes.
bulk_migrate_guestsBulk migrate guests to a target node.
bulk_shutdown_guestsBulk shutdown guests across the cluster.
bulk_start_guestsBulk start guests across the cluster.
change_passwordChange a user's password.
clone_containerClone a container.
clone_vmClone a VM to create a new one.
convert_container_to_templateConvert a container into a template (irreversible).
convert_vm_to_templateConvert a VM into a template (irreversible).
create_backup_jobCreate a scheduled backup job.
create_ceph_osdCreate a new Ceph OSD on a device.
create_ceph_poolCreate a new Ceph pool.
create_cluster_firewall_ruleCreate a cluster-level firewall rule.
create_containerCreate a new LXC container.
create_container_firewall_ruleCreate a firewall rule for an LXC container.
create_container_snapshotCreate a snapshot of a container.
create_directory_storageCreate a directory-based storage mount from a device.
create_firewall_aliasCreate a firewall alias (named IP address or CIDR).
create_firewall_groupCreate a new firewall security group.
create_firewall_group_ruleAdd a rule to a firewall security group.
create_firewall_ipsetCreate a new firewall IP set.
create_groupCreate a new group.
create_ha_groupCreate an HA group.
create_ha_resourceAdd a resource to HA management.
create_lvmCreate a new LVM volume group on a device.
create_lvmthinCreate a new LVM thin pool.
create_node_network_interfaceCreate a network interface on a node.
create_poolCreate a resource pool.
create_replication_jobCreate a storage replication job.
create_roleCreate a new role with specific privileges.
create_sdn_subnetCreate a subnet for an SDN VNet.
create_sdn_vnetCreate an SDN VNet.
create_sdn_zoneCreate an SDN zone.
create_storageCreate a new storage pool configuration.
create_userCreate a new user.
create_user_tokenCreate a new API token for a user.
create_vmCreate a new QEMU virtual machine.
create_vm_firewall_ruleCreate a firewall rule for a QEMU VM.
create_vm_snapshotCreate a snapshot of a VM.
create_vzdumpStart an immediate backup (vzdump) on a node.
create_zfs_poolCreate a new ZFS pool.
delete_backup_jobDelete a scheduled backup job.
delete_cluster_firewall_ruleDelete a cluster-level firewall rule.
delete_containerDelete a container.
delete_container_snapshotDelete a container snapshot.
delete_firewall_aliasDelete a firewall alias.
delete_firewall_ipset_entryRemove an IP/CIDR from an IP set.
delete_groupDelete a group.
delete_ha_groupDelete an HA group.
delete_ha_resourceRemove a resource from HA management.
delete_poolDelete a resource pool.
delete_replication_jobDelete a replication job.
delete_roleDelete a role.
delete_sdn_vnetDelete an SDN VNet.
delete_sdn_zoneDelete an SDN zone.
delete_storageDelete a storage pool configuration (does not delete data on the backend).
delete_storage_volumeDelete a volume from storage.
delete_userDelete a user.
delete_user_tokenDelete an API token.
delete_vmDelete a VM.
delete_vm_snapshotDelete a VM snapshot.
download_appliance_templateDownload an appliance template to local storage.
download_file_restoreDownload a file from a vzdump backup.
download_url_to_storageDownload a file from a URL directly to storage (ISO, template, etc.).
dump_vm_cloudinitDump the Cloud-Init generated config file (user-data, network-data, or meta-data).
get_aclGet the full ACL (access control list) — shows all permission assignments.
get_acme_accountGet ACME account details.
get_acme_directoriesList known ACME directory URLs.
get_acme_pluginGet ACME plugin configuration.
get_acme_tosGet the ACME Terms of Service URL.
get_auth_domainGet authentication domain configuration.
get_backup_jobGet details of a specific backup job.
get_backup_job_included_volumesGet volumes included in a backup job.
get_ceph_configGet the raw Ceph configuration.
get_ceph_crush_rulesGet Ceph CRUSH rules.
get_ceph_flagsGet Ceph global flags (noout, noscrub, etc.).
get_ceph_metadataGet Ceph metadata (versions, services across nodes).
get_ceph_status_clusterGet Ceph cluster status (health, monitors, OSDs, PGs).
get_ceph_status_nodeGet Ceph status from a specific node's perspective.
get_cluster_configGet the current cluster configuration (corosync, nodes, join info).
get_cluster_config_nodesList nodes configured in the cluster.
get_cluster_firewall_optionsGet cluster-wide firewall options (enable, policy_in, policy_out, etc.).
get_cluster_firewall_ruleGet a specific cluster firewall rule.
get_cluster_join_infoGet info needed to join a node to this cluster.
get_cluster_logGet the cluster log (recent events).
get_cluster_optionsGet datacenter/cluster-wide options (keyboard layout, console, language, etc.).
get_cluster_resourcesList all resources across the cluster (VMs, containers, storage, nodes).
get_cluster_statusGet cluster status (nodes online, quorum, HA state).
get_cluster_tasksList recent tasks across all nodes in the cluster.
get_cluster_totemGet the corosync totem configuration.
get_container_configGet the configuration of a container.
get_container_featureCheck if a feature is available for a container (snapshot, clone, copy).
get_container_firewall_optionsGet firewall options for an LXC container.
get_container_interfacesGet network interfaces and IPs of a running container.
get_container_pendingGet pending configuration changes for a container.
get_container_rrddataGet RRD statistics data for a container (CPU, memory, disk, network over time).
get_container_statusGet the current runtime status of a container.
get_disk_smartGet S.M.A.R.T.
get_firewall_group_rulesList rules in a firewall security group.
get_firewall_refsGet available firewall references (aliases, ipsets, names usable in rules).
get_groupGet group details.
get_ha_groupGet HA group configuration.
get_ha_manager_statusGet detailed HA manager status.
get_ha_resourceGet HA resource configuration.
get_ha_statusGet HA manager status (active, quorum, manager status).
get_metric_serverGet metric server configuration.
get_next_vmidGet the next available VMID in the cluster.
get_node_aplinfoList available appliance templates (LXC templates) that can be downloaded.
get_node_apt_updateList available package updates on a node.
get_node_capabilities_qemuGet QEMU capabilities for a node: supported CPU models, machine types, etc.
get_node_certificatesGet certificate info for a node.
get_node_configGet the configuration of a node (description, wakeonlan, etc.).
get_node_disksList physical disks on a node.
get_node_dnsGet DNS settings for a node.
get_node_firewall_logGet firewall log for a node.
get_node_firewall_optionsGet firewall options for a specific node.
get_node_hardware_pciList PCI hardware devices on a node (for passthrough).
get_node_hardware_usbList USB hardware devices on a node.
get_node_hostsGet the /etc/hosts file content for a node.
get_node_journalRead systemd journal entries from a node.
get_node_netstatGet network statistics for a node (per-interface traffic).
get_node_networkGet network interface configuration for a node.
get_node_network_interfaceGet details for a specific network interface.
get_node_reportGenerate a system report for a node (useful for diagnostics).
get_node_statusGet detailed status of a specific node including CPU, memory, disk, uptime, and kernel info.
get_node_storage_scanScan for available storage targets (NFS, CIFS, iSCSI, LVM, ZFS, PBS).
get_node_storage_statusGet usage status of a storage pool on a node (total, used, available).
get_node_subscriptionGet subscription status for a node.
get_node_syslogRead system log (syslog) entries from a node.
get_node_timeGet the current time and timezone of a node.
get_node_versionGet Proxmox VE version information for a specific node.
get_permissionsCheck effective permissions for a user on a given path.
get_poolGet pool configuration and members.
get_replication_jobGet a specific replication job configuration.
get_roleGet role details and its privileges.
get_sdn_controllerGet SDN controller configuration.
get_sdn_ipamGet IPAM plugin configuration.
get_sdn_vnetGet SDN VNet configuration.
get_sdn_zoneGet SDN zone configuration.
get_storage_configGet configuration of a specific storage pool.
get_storage_rrddataGet RRD statistics for a storage pool (usage over time).
get_storage_volume_infoGet details about a specific volume in storage.
get_task_logGet log output of a specific task.
get_task_statusGet the status of a specific task by its UPID.
get_userGet details for a specific user.
get_user_tokenGet details for a specific API token.
get_versionGet the Proxmox VE API version information.
get_vm_cloudinitGet Cloud-Init configuration for a VM.
get_vm_configGet the configuration of a VM.
get_vm_featureCheck if a specific feature is available/supported for a VM (e.g.
get_vm_firewall_optionsGet firewall options for a QEMU VM.
get_vm_pendingGet pending configuration changes for a VM (not yet applied).
get_vm_rrddataGet RRD statistics data for a VM (CPU, memory, disk, network over time).
get_vm_snapshot_configGet the configuration stored in a VM snapshot.
get_vm_spiceproxyCreate a SPICE proxy connection for a VM console.
get_vm_statusGet the current runtime status of a VM (state, CPU, memory, disk, network, uptime).
get_vm_vncproxyCreate a VNC proxy connection ticket for a VM (for console access).
get_vzdump_defaultsGet the default vzdump configuration for a node.
get_vzdump_extractconfigExtract the guest configuration from a vzdump backup archive.
get_zfs_poolGet details of a ZFS pool.
initialize_gptInitialize a disk with GPT partition table (WARNING: destroys all data).
join_clusterJoin a node to an existing cluster.
list_acme_accountsList ACME (Let's Encrypt) accounts.
list_acme_pluginsList ACME DNS challenge plugins.
list_auth_domainsList configured authentication realms/domains (PAM, PVE, LDAP, AD, OpenID).
list_backup_file_restoreList files in a vzdump backup for single-file restore.
list_backup_jobsList all scheduled backup jobs (vzdump) in the cluster.
list_ceph_fsList CephFS filesystems.
list_ceph_managersList Ceph managers.
list_ceph_mdsList Ceph metadata servers (MDS, for CephFS).
list_ceph_monitorsList Ceph monitors.
list_ceph_osdsList Ceph OSDs on a node.
list_ceph_poolsList Ceph pools.
list_cluster_firewall_rulesList cluster-level firewall rules.
list_container_firewall_rulesList firewall rules for an LXC container.
list_container_snapshotsList all snapshots of a container.
list_containersList all LXC containers on a node with status, memory, CPU, and disk info.
list_dir_mappingsList directory mappings.
list_directory_storageList directory-based storage mounts on a node.
list_file_restoreList files in a backup volume for file-level restore (PBS backups).
list_firewall_aliasesList cluster firewall aliases (named IP addresses/ranges).
list_firewall_groupsList firewall security groups (reusable sets of rules).
list_firewall_ipset_entriesList entries in a firewall IP set.
list_firewall_ipsetsList cluster firewall IP sets (named groups of IPs).
list_firewall_macrosList available firewall macros (predefined rule sets like SSH, HTTP, etc.).
list_groupsList all user groups.
list_ha_groupsList HA groups (define which nodes can run HA resources).
list_ha_resourcesList all HA-managed resources.
list_lvm_volumesList LVM volume groups on a node.
list_lvmthin_poolsList LVM thin pools on a node.
list_metric_serversList configured metric servers (InfluxDB, Graphite).
list_node_firewall_rulesList firewall rules for a node.
list_node_servicesList all system services on a node (pve, ssh, cron, etc.).
list_node_storageList storage pools available on a specific node with usage info.
list_node_tasksList recent tasks on a node.
list_nodesList all nodes in the Proxmox cluster with their status, CPU, memory, and uptime.
list_notification_endpointsList all configured notification endpoints (sendmail, gotify, smtp, webhook).
list_notification_matchersList all notification matchers (rules that route notifications).
list_notification_targetsList all notification targets.
list_pci_mappingsList PCI device mappings for passthrough.
list_poolsList all resource pools.
list_realm_sync_jobsList realm synchronization jobs.
list_replication_jobsList all replication jobs in the cluster.
list_rolesList all available roles.
list_scheduled_jobsList all scheduled cluster jobs (realm-sync, etc.).
list_sdn_controllersList SDN controllers (e.g.
list_sdn_dnsList SDN DNS plugins.
list_sdn_ipamsList IPAM (IP Address Management) plugins.
list_sdn_subnetsList subnets for an SDN VNet.
list_sdn_vnetsList SDN virtual networks (VNets).
list_sdn_zonesList SDN zones.
list_storageList all configured storage pools at the datacenter level.
list_storage_contentList content of a storage pool (disk images, ISOs, templates, backups).
list_tfaList TFA (two-factor auth) entries.
list_usb_mappingsList USB device mappings for passthrough.
list_user_tokensList API tokens for a user.
list_usersList all users in Proxmox.
list_vm_firewall_rulesList firewall rules for a QEMU VM.
list_vm_snapshotsList all snapshots of a VM.
list_vmsList all QEMU virtual machines on a node with status, memory, CPU, and disk info.
list_zfs_poolsList ZFS pools on a node.
manage_node_serviceStart, stop, restart, or reload a system service on a node.
migrate_containerMigrate a container to another node.
migrate_ha_resourceRequest migration of an HA resource to a different node.
migrate_vmMigrate a VM to another node in the cluster.
move_container_volumeMove a container volume to different storage or to another container.
move_vm_diskMove a VM disk to different storage or attach to another VM.
order_node_certificateOrder/renew ACME certificate for a node.
proxmox_api_rawMake an arbitrary Proxmox API call for any endpoint not covered by specific tools.
prune_storage_backupsPrune (delete) old backups from storage according to retention policy.
reboot_containerReboot a container.
reboot_vmReboot a VM via ACPI.
register_acme_accountRegister a new ACME account.
relocate_ha_resourceRequest relocation of an HA resource to a different node.
reset_vmHard reset a VM (like pressing the reset button).
resize_container_diskResize a container disk/volume.
resize_vm_diskResize a VM disk.
resume_containerResume a suspended container.
resume_vmResume a suspended/paused VM.
rollback_container_snapshotRollback a container to a previous snapshot.
rollback_vm_snapshotRollback a VM to a previous snapshot (current state will be lost).
run_apt_updateRefresh the package index on a node (apt update).
send_vm_keySend a key event to a VM (e.g.
send_vm_monitor_commandSend a QEMU monitor command to a VM (advanced/low-level).
set_ceph_flagsSet a Ceph global flag.
set_cluster_firewall_optionsSet cluster-wide firewall options.
set_node_firewall_optionsSet firewall options for a node.
set_vm_firewall_optionsSet firewall options for a QEMU VM.
shutdown_containerGracefully shut down a container.
shutdown_vmGracefully shut down a VM via ACPI.
start_containerStart a container.
start_vmStart a VM.
startall_nodeStart all VMs and containers on a node (respecting boot order).
stop_containerHard-stop a container (immediate, like power off).
stop_taskStop (abort) a running task.
stop_vmHard-stop a VM (like pulling the power plug).
stopall_nodeStop all VMs and containers on a node.
suspend_containerSuspend (freeze) a container.
suspend_vmSuspend a VM (pause execution or hibernate to disk).
sync_auth_domainSync users/groups from an external auth domain (LDAP/AD).
test_notification_targetSend a test notification to a target.
update_aclAdd or remove ACL entries (permission assignments).
update_backup_jobUpdate a scheduled backup job.
update_cluster_firewall_ruleUpdate a cluster-level firewall rule.
update_cluster_optionsUpdate datacenter/cluster-wide options.
update_container_configUpdate the configuration of an existing container.
update_groupUpdate a group.
update_ha_groupUpdate an HA group.
update_ha_resourceUpdate an HA resource configuration.
update_poolUpdate a resource pool (add/remove members).
update_roleUpdate role privileges.
update_sdn_vnetUpdate an SDN VNet.
update_storageUpdate an existing storage pool configuration.
update_userUpdate an existing user.
update_vm_cloudinitSet Cloud-Init parameters for a VM (user, password, SSH keys, network).
update_vm_configUpdate the configuration of an existing VM.
upload_to_storageUpload a file (ISO, template, etc.) to storage.
vm_agent_execExecute a command inside a VM via the QEMU Guest Agent.
vm_agent_exec_statusGet the status/result of a command previously executed via the guest agent.
vm_agent_file_readRead a file from inside a VM via the guest agent.
vm_agent_file_writeWrite content to a file inside a VM via the guest agent.
vm_agent_get_infoGet various system information from a VM via the guest agent.
vm_agent_set_passwordSet a user password inside a VM via the guest agent.
wakeonlan_nodeSend a Wake-on-LAN magic packet to a node.

Tools Details

Tool: add_firewall_ipset_entry

Add an IP/CIDR to an IP set.

ParametersTypeDescription
cidrstringIP address or CIDR.
namestringIP set name.
commentstringoptionalDescription.
nomatchbooleanoptionalExclude this entry (nomatch).

Tool: allocate_storage_volume

Allocate a new disk volume in storage.

ParametersTypeDescription
filenamestringVolume name.
nodestringThe node name.
sizestringVolume size (e.g. '10G').
storagestringThe storage ID.
vmidintegerVM ID to associate with.
formatstringoptionalDisk format (raw, qcow2, vmdk). Auto-detected if empty.

Tool: apply_sdn_changes

Apply pending SDN configuration changes to all nodes.

Tool: bulk_migrate_guests

Bulk migrate guests to a target node.

ParametersTypeDescription
targetstringTarget node name.
vmsstringoptionalComma-separated VMIDs.

Tool: bulk_shutdown_guests

Bulk shutdown guests across the cluster.

ParametersTypeDescription
vmsstringoptionalComma-separated list of VMIDs (empty = all).

Tool: bulk_start_guests

Bulk start guests across the cluster.

ParametersTypeDescription
vmsstringoptionalComma-separated list of VMIDs (empty = all).

Tool: change_password

Change a user's password.

ParametersTypeDescription
passwordstringNew password.
useridstringUser ID (format: 'user@realm').

Tool: clone_container

Clone a container.

ParametersTypeDescription
newidintegerID for the new container.
nodestringThe source node name.
vmidintegerThe source container ID.
descriptionstringoptionalDescription.
fullbooleanoptionalFull clone (True) or linked clone (False).
hostnamestringoptionalHostname for the clone.
poolstringoptionalResource pool.
snapnamestringoptionalSnapshot to clone from.
storagestringoptionalTarget storage for full clone.
targetstringoptionalTarget node (default: same node).

Tool: clone_vm

Clone a VM to create a new one. Can be a full copy or linked clone.

ParametersTypeDescription
newidintegerThe VMID for the new clone.
nodestringThe source node name.
vmidintegerThe source VM ID.
descriptionstringoptionalDescription for the clone.
fullbooleanoptionalFull clone (True) or linked clone (False).
namestringoptionalName for the clone.
poolstringoptionalResource pool.
snapnamestringoptionalSnapshot name to clone from.
storagestringoptionalTarget storage for full clone.
targetstringoptionalTarget node for the clone (default: same node).

Tool: convert_container_to_template

Convert a container into a template (irreversible).

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID.

Tool: convert_vm_to_template

Convert a VM into a template (irreversible).

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.

Tool: create_backup_job

Create a scheduled backup job.

ParametersTypeDescription
storagestringTarget storage ID for backups.
all_guestsbooleanoptionalBackup all guests.
commentstringoptionalDescription.
compressstringoptionalCompression: 'none', 'lzo', 'gzip', 'zstd'.
enabledbooleanoptionalEnable the job.
mailnotificationstringoptional'always' or 'failure'.
mailtostringoptionalComma-separated email addresses.
maxfilesintegeroptionalMax backup files to keep (0 = unlimited, deprecated - use prune_backups).
modestringoptionalBackup mode: 'snapshot', 'suspend', 'stop'.
nodestringoptionalOnly back up guests on this node.
notes_templatestringoptionalTemplate for backup notes.
prune_backupsstringoptionalRetention schedule (e.g. 'keep-daily=7,keep-weekly=4').
schedulestringoptionalSchedule in systemd calendar format (e.g. 'daily', 'weekly', '02:00').
vmidstringoptionalComma-separated VMIDs to back up (if not all_guests).

Tool: create_ceph_osd

Create a new Ceph OSD on a device.

ParametersTypeDescription
devstringBlock device for the OSD (e.g. '/dev/sdb').
nodestringThe node name.
db_devstringoptionalSeparate block device for DB.
encryptedbooleanoptionalEncrypt the OSD.
wal_devstringoptionalSeparate block device for WAL.

Tool: create_ceph_pool

Create a new Ceph pool.

ParametersTypeDescription
namestringPool name.
nodestringThe node name.
applicationstringoptionalPool application (rbd, cephfs, rgw).
min_sizeintegeroptionalMinimum replicas for I/O (default 2).
pg_numintegeroptionalNumber of placement groups (default 128).
sizeintegeroptionalNumber of replicas (default 3).

Tool: create_cluster_firewall_rule

Create a cluster-level firewall rule.

ParametersTypeDescription
actionstring'ACCEPT', 'DROP', 'REJECT'.
typestring'in', 'out', 'group'.
commentstringoptionalDescription.
deststringoptionalDestination address/range.
dportstringoptionalDestination port(s).
enableintegeroptional1 = enabled, 0 = disabled.
ifacestringoptionalNetwork interface.
logstringoptionalLog level: 'emerg', 'alert', 'crit', 'err', 'warning', 'notice', 'info', 'debug', 'nolog'.
macrostringoptionalUse predefined macro (e.g. 'SSH', 'HTTP', 'HTTPS', 'Ping').
posintegeroptionalRule position (-1 = append).
protostringoptionalProtocol (tcp, udp, icmp, etc.).
sourcestringoptionalSource address/range (CIDR or alias).
sportstringoptionalSource port(s).

Tool: create_container

Create a new LXC container.

ParametersTypeDescription
nodestringThe node name.
ostemplatestringTemplate volume (e.g. 'local:vztmpl/debian-12-standard_12.2-1_amd64.tar.zst').
vmidintegerThe container ID.
coresintegeroptionalCPU cores (default 1).
cpulimitnumberoptionalCPU limit (0 = unlimited).
descriptionstringoptionalContainer description.
featuresstringoptionalComma-separated features (e.g. 'nesting=1,keyctl=1').
hostnamestringoptionalContainer hostname.
memoryintegeroptionalMemory in MB (default 512).
mp0stringoptionalMount point (e.g. 'local-lvm:4,mp=/mnt/data').
nameserverstringoptionalDNS nameserver.
net0stringoptionalNetwork config (e.g. 'name=eth0,bridge=vmbr0,ip=dhcp').
onbootbooleanoptionalStart on host boot.
passwordstringoptionalRoot password.
poolstringoptionalResource pool.
rootfsstringoptionalRoot filesystem spec (e.g. 'local-lvm:8' for 8GB).
searchdomainstringoptionalDNS search domain.
ssh_public_keysstringoptionalSSH public keys (newline delimited).
startbooleanoptionalStart after creation.
storagestringoptionalStorage for rootfs (default 'local').
swapintegeroptionalSwap in MB (default 512).
tagsstringoptionalSemicolon-separated tags.
unprivilegedbooleanoptionalCreate an unprivileged container (default True, recommended).

Tool: create_container_firewall_rule

Create a firewall rule for an LXC container.

ParametersTypeDescription
actionstring'ACCEPT', 'DROP', 'REJECT'.
nodestringThe node name.
typestring'in', 'out', 'group'.
vmidintegerThe container ID.
commentstringoptionalDescription.
deststringoptionalDestination CIDR or alias.
dportstringoptionalDestination port(s).
enableintegeroptional1 = enabled, 0 = disabled.
macrostringoptionalPredefined macro.
protostringoptionalProtocol.
sourcestringoptionalSource CIDR or alias.

Tool: create_container_snapshot

Create a snapshot of a container.

ParametersTypeDescription
nodestringThe node name.
snapnamestringSnapshot name.
vmidintegerThe container ID.
descriptionstringoptionalSnapshot description.

Tool: create_directory_storage

Create a directory-based storage mount from a device.

ParametersTypeDescription
devicestringBlock device path.
namestringStorage name.
nodestringThe node name.
add_to_storagebooleanoptionalAuto-add as Proxmox storage.
filesystemstringoptionalFilesystem type (ext4, xfs).

Tool: create_firewall_alias

Create a firewall alias (named IP address or CIDR).

ParametersTypeDescription
cidrstringIP address or CIDR (e.g. '10.0.0.0/24' or '192.168.1.1').
namestringAlias name.
commentstringoptionalDescription.

Tool: create_firewall_group

Create a new firewall security group.

ParametersTypeDescription
groupstringGroup name.
commentstringoptionalDescription.

Tool: create_firewall_group_rule

Add a rule to a firewall security group.

ParametersTypeDescription
actionstring'ACCEPT', 'DROP', 'REJECT'.
groupstringSecurity group name.
typestring'in', 'out'.
commentstringoptionalDescription.
deststringoptionalDestination address/range.
dportstringoptionalDestination port(s).
enableintegeroptional1 = enabled, 0 = disabled.
macrostringoptionalPredefined macro.
protostringoptionalProtocol.
sourcestringoptionalSource address/range.
sportstringoptionalSource port(s).

Tool: create_firewall_ipset

Create a new firewall IP set.

ParametersTypeDescription
namestringIP set name.
commentstringoptionalDescription.

Tool: create_group

Create a new group.

ParametersTypeDescription
groupidstringGroup ID.
commentstringoptionalDescription.

Tool: create_ha_group

Create an HA group.

ParametersTypeDescription
groupstringGroup ID.
nodesstringNode list with optional priority (e.g. 'node1:2,node2:1' — higher = preferred).
commentstringoptionalDescription.
nofailbackbooleanoptionalIf true, don't fail back to higher-priority nodes once recovered.
restrictedbooleanoptionalOnly run on nodes in this group (otherwise runs anywhere but prefers group nodes).

Tool: create_ha_resource

Add a resource to HA management.

ParametersTypeDescription
sidstringResource ID (format: 'type:vmid', e.g. 'vm:100' or 'ct:101').
commentstringoptionalDescription.
groupstringoptionalHA group name.
max_relocateintegeroptionalMax relocations on failure.
max_restartintegeroptionalMax restarts on failure.
statestringoptionalDesired state: 'started', 'stopped', 'enabled', 'disabled', 'ignored'.

Tool: create_lvm

Create a new LVM volume group on a device.

ParametersTypeDescription
devicestringBlock device path (e.g. '/dev/sdb').
namestringVG name.
nodestringThe node name.
add_to_storagebooleanoptionalAuto-add as Proxmox storage.

Tool: create_lvmthin

Create a new LVM thin pool.

ParametersTypeDescription
devicestringBlock device path.
namestringThin pool name.
nodestringThe node name.
add_to_storagebooleanoptionalAuto-add as Proxmox storage.

Tool: create_node_network_interface

Create a network interface on a node.

ParametersTypeDescription
ifacestringInterface name (e.g. 'vmbr1').
nodestringThe node name.
typestringInterface type (bridge, bond, eth, alias, vlan, OVSBridge, OVSPort, OVSIntPort, OVSBond).
addressstringoptionalIP address (CIDR notation or IP).
autostartbooleanoptionalWhether to start on boot.
bridge_portsstringoptionalBridge ports (for bridge type).
commentsstringoptionalComments for the interface.
gatewaystringoptionalDefault gateway.
netmaskstringoptionalSubnet mask.

Tool: create_pool

Create a resource pool.

ParametersTypeDescription
poolidstringPool ID.
commentstringoptionalDescription.

Tool: create_replication_job

Create a storage replication job.

ParametersTypeDescription
idstringJob ID (format: GUEST-JOBNUM, e.g. '100-0').
targetstringTarget node.
commentstringoptionalDescription.
disablebooleanoptionalCreate disabled.
ratenumberoptionalRate limit in mbps.
schedulestringoptionalSchedule in systemd calendar format (default '*/15' = every 15 min).
typestringoptionalReplication type (currently only 'local').

Tool: create_role

Create a new role with specific privileges.

ParametersTypeDescription
privsstringComma-separated list of privileges (e.g. 'VM.Allocate,VM.Config.Disk,VM.PowerMgmt').
roleidstringRole ID.

Tool: create_sdn_subnet

Create a subnet for an SDN VNet.

ParametersTypeDescription
subnetstringSubnet CIDR (e.g. '10.0.0.0/24').
vnetstringVNet ID.
dnszoneprefixstringoptionalDNS zone prefix.
gatewaystringoptionalGateway IP.
snatbooleanoptionalEnable SNAT.

Tool: create_sdn_vnet

Create an SDN VNet.

ParametersTypeDescription
vnetstringVNet ID.
zonestringZone ID.
aliasstringoptionalDisplay alias.
tagintegeroptionalVLAN tag.
vlanawarebooleanoptionalEnable VLAN-aware bridge.

Tool: create_sdn_zone

Create an SDN zone.

ParametersTypeDescription
typestringZone type: 'simple', 'vlan', 'qinq', 'vxlan', 'evpn'.
zonestringZone ID.
bridgestringoptionalBridge name.
dnsstringoptionalDNS plugin name.
ipamstringoptionalIPAM plugin name.
mtuintegeroptionalMTU.
nodesstringoptionalComma-separated node list.

Tool: create_storage

Create a new storage pool configuration.

ParametersTypeDescription
storagestringStorage ID.
typestringStorage type: dir, lvm, lvmthin, zfspool, nfs, cifs, iscsi, rbd, cephfs, pbs, glusterfs, btrfs.
contentstringoptionalComma-separated content types (images, rootdir, vztmpl, iso, backup, snippets, import).
datastorestringoptionalPBS datastore name.
disablebooleanoptionalCreate disabled.
exportstringoptionalNFS export path.
maxfilesintegeroptionalMax backup files (0 = unlimited).
nodesstringoptionalRestrict storage to these nodes (comma-separated).
pathstringoptionalFile system path (for dir, nfs mounts).
poolstringoptionalPool name (for Ceph RBD/CephFS, ZFS).
portalstringoptionaliSCSI portal.
prune_backupsstringoptionalBackup retention policy.
serverstringoptionalServer IP/hostname (for nfs, cifs, iscsi, pbs, glusterfs, rbd, cephfs).
sharedbooleanoptionalMark as shared storage.
targetstringoptionaliSCSI target.
thinpoolstringoptionalLVM thin pool name (for lvmthin).
vgnamestringoptionalLVM volume group name.

Tool: create_user

Create a new user.

ParametersTypeDescription
useridstringUser ID (format: 'user@realm', e.g. 'myuser@pve').
commentstringoptionalDescription.
emailstringoptionalEmail address.
enablebooleanoptionalEnable user.
expireintegeroptionalAccount expiration (Unix epoch, 0 = never).
firstnamestringoptionalFirst name.
groupsstringoptionalComma-separated group list.
lastnamestringoptionalLast name.
passwordstringoptionalPassword (only for pve/pam realms).

Tool: create_user_token

Create a new API token for a user. Returns the token value (shown only once).

ParametersTypeDescription
tokenidstringToken ID (alphanumeric).
useridstringUser ID (format: 'user@realm').
commentstringoptionalToken description.
expireintegeroptionalExpiration (Unix epoch, 0 = never).
privsepbooleanoptionalEnable privilege separation (token has own permissions, not user's full permissions).

Tool: create_vm

Create a new QEMU virtual machine.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID number.
agentstringoptionalQEMU guest agent: '1' to enable, 'enabled=1,fstrim_cloned_disks=1'.
biosstringoptionalBIOS type: seabios, ovmf (UEFI).
bootstringoptionalBoot order (e.g. 'order=scsi0;ide2;net0').
cdromstringoptionalCD-ROM ISO image path.
coresintegeroptionalNumber of CPU cores per socket (default 1).
cpustringoptionalCPU type (default 'host').
descriptionstringoptionalVM description.
ide2stringoptionalIDE device, often used for CD-ROM (e.g. 'local:iso/ubuntu.iso,media=cdrom').
machinestringoptionalMachine type (e.g. 'q35', 'i440fx').
memoryintegeroptionalMemory in MB (default 2048).
namestringoptionalVM name.
net0stringoptionalNetwork device (e.g. 'virtio,bridge=vmbr0').
onbootbooleanoptionalStart on host boot.
ostypestringoptionalOS type: l26 (Linux 2.6+), win10, win11, wxp, other, etc.
poolstringoptionalResource pool to add the VM to.
scsi0stringoptionalFirst SCSI disk (e.g. 'local-lvm:32' for 32GB on local-lvm).
scsihwstringoptionalSCSI controller: virtio-scsi-single, virtio-scsi-pci, lsi, megasas, pvscsi.
socketsintegeroptionalNumber of CPU sockets (default 1).
startbooleanoptionalStart the VM after creation.
tagsstringoptionalSemicolon-separated tags.

Tool: create_vm_firewall_rule

Create a firewall rule for a QEMU VM.

ParametersTypeDescription
actionstring'ACCEPT', 'DROP', 'REJECT'.
nodestringThe node name.
typestring'in', 'out', 'group'.
vmidintegerThe VM ID.
commentstringoptionalDescription.
deststringoptionalDestination CIDR or alias.
dportstringoptionalDestination port(s).
enableintegeroptional1 = enabled, 0 = disabled.
macrostringoptionalPredefined macro.
protostringoptionalProtocol.
sourcestringoptionalSource CIDR or alias.

Tool: create_vm_snapshot

Create a snapshot of a VM.

ParametersTypeDescription
nodestringThe node name.
snapnamestringSnapshot name.
vmidintegerThe VM ID.
descriptionstringoptionalSnapshot description.
vmstatebooleanoptionalInclude RAM state (for running VMs).

Tool: create_vzdump

Start an immediate backup (vzdump) on a node.

ParametersTypeDescription
nodestringThe node to run the backup on.
all_guestsbooleanoptionalBack up all guests on the node.
compressstringoptionalCompression: 'none', 'lzo', 'gzip', 'zstd'.
modestringoptionalBackup mode: 'snapshot', 'suspend', 'stop'.
stdoutbooleanoptionalWrite to stdout instead of storage.
storagestringoptionalTarget storage (empty = default).
vmidstringoptionalComma-separated VMIDs (required if not all_guests).

Tool: create_zfs_pool

Create a new ZFS pool.

ParametersTypeDescription
devicesstringSpace-separated device paths (e.g. '/dev/sdb /dev/sdc').
namestringPool name.
nodestringThe node name.
raidlevelstringRAID level: single, mirror, raid10, raidz, raidz2, raidz3, draid, draid2, draid3.
add_to_storagebooleanoptionalAuto-add as Proxmox storage.
ashiftintegeroptionalashift value (default 12).
compressionstringoptionalCompression (on, off, lz4, zstd, etc.).

Tool: delete_backup_job

Delete a scheduled backup job.

ParametersTypeDescription
idstringBackup job ID.

Tool: delete_cluster_firewall_rule

Delete a cluster-level firewall rule.

ParametersTypeDescription
posintegerRule position to delete.

Tool: delete_container

Delete a container. Must be stopped first unless force=True.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID.
destroy_unreferenced_disksbooleanoptionalDestroy unreferenced disks.
forcebooleanoptionalForce destroy even if running.
purgebooleanoptionalRemove from replication, HA, backup and ACLs too.

Tool: delete_container_snapshot

Delete a container snapshot.

ParametersTypeDescription
nodestringThe node name.
snapnamestringSnapshot name.
vmidintegerThe container ID.
forcebooleanoptionalForce delete.

Tool: delete_firewall_alias

Delete a firewall alias.

ParametersTypeDescription
namestringAlias name.

Tool: delete_firewall_ipset_entry

Remove an IP/CIDR from an IP set.

ParametersTypeDescription
cidrstringIP address or CIDR to remove.
namestringIP set name.

Tool: delete_group

Delete a group.

ParametersTypeDescription
groupidstringGroup ID.

Tool: delete_ha_group

Delete an HA group.

ParametersTypeDescription
groupstringGroup ID.

Tool: delete_ha_resource

Remove a resource from HA management.

ParametersTypeDescription
sidstringResource ID (format: 'type:vmid').

Tool: delete_pool

Delete a resource pool.

ParametersTypeDescription
poolidstringPool ID.

Tool: delete_replication_job

Delete a replication job.

ParametersTypeDescription
idstringReplication job ID.
forcebooleanoptionalForce removal (skip cleanup).
keepbooleanoptionalKeep replicated data on target.

Tool: delete_role

Delete a role.

ParametersTypeDescription
roleidstringRole ID.

Tool: delete_sdn_vnet

Delete an SDN VNet.

ParametersTypeDescription
vnetstringVNet ID.

Tool: delete_sdn_zone

Delete an SDN zone.

ParametersTypeDescription
zonestringZone ID.

Tool: delete_storage

Delete a storage pool configuration (does not delete data on the backend).

ParametersTypeDescription
storagestringThe storage ID.

Tool: delete_storage_volume

Delete a volume from storage.

ParametersTypeDescription
nodestringThe node name.
storagestringThe storage ID.
volumestringThe volume ID.

Tool: delete_user

Delete a user.

ParametersTypeDescription
useridstringUser ID to delete (format: 'user@realm').

Tool: delete_user_token

Delete an API token.

ParametersTypeDescription
tokenidstringToken ID.
useridstringUser ID (format: 'user@realm').

Tool: delete_vm

Delete a VM. The VM must be stopped first.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.
destroy_unreferenced_disksbooleanoptionalAlso destroy unreferenced disks owned by the VM.
purgebooleanoptionalRemove from replication, HA, backup jobs and ACLs too.

Tool: delete_vm_snapshot

Delete a VM snapshot.

ParametersTypeDescription
nodestringThe node name.
snapnamestringSnapshot name to delete.
vmidintegerThe VM ID.
forcebooleanoptionalForce delete even if snapshot is in use.

Tool: download_appliance_template

Download an appliance template to local storage.

ParametersTypeDescription
nodestringThe node name.
storagestringTarget storage ID.
templatestringTemplate name to download.

Tool: download_file_restore

Download a file from a vzdump backup.

ParametersTypeDescription
filepathstringPath of the file to download from the backup.
nodestringThe node name.
storagestringStorage ID.
volumestringBackup volume ID.

Tool: download_url_to_storage

Download a file from a URL directly to storage (ISO, template, etc.).

ParametersTypeDescription
contentstringContent type: 'iso', 'vztmpl'.
filenamestringTarget filename.
nodestringThe node name.
storagestringThe storage ID.
urlstringURL to download from.
checksumstringoptionalExpected checksum.
checksum_algorithmstringoptionalChecksum algorithm (sha256, sha512, md5).

Tool: dump_vm_cloudinit

Dump the Cloud-Init generated config file (user-data, network-data, or meta-data).

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.
typestringoptionalConfig type: 'user', 'network', or 'meta'.

Tool: get_acl

Get the full ACL (access control list) — shows all permission assignments.

Tool: get_acme_account

Get ACME account details.

ParametersTypeDescription
namestringoptionalAccount name (default: 'default').

Tool: get_acme_directories

List known ACME directory URLs.

Tool: get_acme_plugin

Get ACME plugin configuration.

ParametersTypeDescription
idstringPlugin ID.

Tool: get_acme_tos

Get the ACME Terms of Service URL.

Tool: get_auth_domain

Get authentication domain configuration.

ParametersTypeDescription
realmstringRealm ID (e.g. 'pam', 'pve', 'my-ldap').

Tool: get_backup_job

Get details of a specific backup job.

ParametersTypeDescription
idstringBackup job ID.

Tool: get_backup_job_included_volumes

Get volumes included in a backup job.

ParametersTypeDescription
idstringBackup job ID.

Tool: get_ceph_config

Get the raw Ceph configuration.

ParametersTypeDescription
nodestringThe node name.

Tool: get_ceph_crush_rules

Get Ceph CRUSH rules.

ParametersTypeDescription
nodestringThe node name.

Tool: get_ceph_flags

Get Ceph global flags (noout, noscrub, etc.).

Tool: get_ceph_metadata

Get Ceph metadata (versions, services across nodes).

Tool: get_ceph_status_cluster

Get Ceph cluster status (health, monitors, OSDs, PGs).

Tool: get_ceph_status_node

Get Ceph status from a specific node's perspective.

ParametersTypeDescription
nodestringThe node name.

Tool: get_cluster_config

Get the current cluster configuration (corosync, nodes, join info).

Tool: get_cluster_config_nodes

List nodes configured in the cluster.

Tool: get_cluster_firewall_options

Get cluster-wide firewall options (enable, policy_in, policy_out, etc.).

Tool: get_cluster_firewall_rule

Get a specific cluster firewall rule.

ParametersTypeDescription
posintegerRule position number.

Tool: get_cluster_join_info

Get info needed to join a node to this cluster.

Tool: get_cluster_log

Get the cluster log (recent events).

ParametersTypeDescription
max_entriesintegeroptionalMax log entries.

Tool: get_cluster_options

Get datacenter/cluster-wide options (keyboard layout, console, language, etc.).

Tool: get_cluster_resources

List all resources across the cluster (VMs, containers, storage, nodes).

ParametersTypeDescription
typestringoptionalFilter by type: 'vm', 'storage', 'node', 'sdn', 'pool' (empty = all).

Tool: get_cluster_status

Get cluster status (nodes online, quorum, HA state).

Tool: get_cluster_tasks

List recent tasks across all nodes in the cluster.

ParametersTypeDescription
limitintegeroptionalMaximum number of tasks to return.

Tool: get_cluster_totem

Get the corosync totem configuration.

Tool: get_container_config

Get the configuration of a container.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID.

Tool: get_container_feature

Check if a feature is available for a container (snapshot, clone, copy).

ParametersTypeDescription
featurestringFeature to check ('snapshot', 'clone', 'copy').
nodestringThe node name.
vmidintegerThe container ID.

Tool: get_container_firewall_options

Get firewall options for an LXC container.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID.

Tool: get_container_interfaces

Get network interfaces and IPs of a running container.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID.

Tool: get_container_pending

Get pending configuration changes for a container.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID.

Tool: get_container_rrddata

Get RRD statistics data for a container (CPU, memory, disk, network over time).

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID.
timeframestringoptionalTime range: 'hour', 'day', 'week', 'month', 'year'.

Tool: get_container_status

Get the current runtime status of a container.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID (CTID).

Tool: get_disk_smart

Get S.M.A.R.T. health data for a disk.

ParametersTypeDescription
diskstringDisk device path (e.g. '/dev/sda').
nodestringThe node name.

Tool: get_firewall_group_rules

List rules in a firewall security group.

ParametersTypeDescription
groupstringSecurity group name.

Tool: get_firewall_refs

Get available firewall references (aliases, ipsets, names usable in rules).

Tool: get_group

Get group details.

ParametersTypeDescription
groupidstringGroup ID.

Tool: get_ha_group

Get HA group configuration.

ParametersTypeDescription
groupstringGroup ID.

Tool: get_ha_manager_status

Get detailed HA manager status.

Tool: get_ha_resource

Get HA resource configuration.

ParametersTypeDescription
sidstringHA resource ID (format: 'type:vmid', e.g. 'vm:100' or 'ct:101').

Tool: get_ha_status

Get HA manager status (active, quorum, manager status).

Tool: get_metric_server

Get metric server configuration.

ParametersTypeDescription
idstringMetric server ID.

Tool: get_next_vmid

Get the next available VMID in the cluster.

ParametersTypeDescription
vmidintegeroptionalSpecific VMID to check availability for (0 = auto-assign).

Tool: get_node_aplinfo

List available appliance templates (LXC templates) that can be downloaded.

ParametersTypeDescription
nodestringThe node name.

Tool: get_node_apt_update

List available package updates on a node.

ParametersTypeDescription
nodestringThe node name.

Tool: get_node_capabilities_qemu

Get QEMU capabilities for a node: supported CPU models, machine types, etc.

ParametersTypeDescription
nodestringThe node name.

Tool: get_node_certificates

Get certificate info for a node.

ParametersTypeDescription
nodestringThe node name.

Tool: get_node_config

Get the configuration of a node (description, wakeonlan, etc.).

ParametersTypeDescription
nodestringThe node name.

Tool: get_node_disks

List physical disks on a node.

ParametersTypeDescription
nodestringThe node name.

Tool: get_node_dns

Get DNS settings for a node.

ParametersTypeDescription
nodestringThe node name.

Tool: get_node_firewall_log

Get firewall log for a node.

ParametersTypeDescription
nodestringThe node name.
limitintegeroptionalMax entries.

Tool: get_node_firewall_options

Get firewall options for a specific node.

ParametersTypeDescription
nodestringThe node name.

Tool: get_node_hardware_pci

List PCI hardware devices on a node (for passthrough).

ParametersTypeDescription
nodestringThe node name.

Tool: get_node_hardware_usb

List USB hardware devices on a node.

ParametersTypeDescription
nodestringThe node name.

Tool: get_node_hosts

Get the /etc/hosts file content for a node.

ParametersTypeDescription
nodestringThe node name.

Tool: get_node_journal

Read systemd journal entries from a node.

ParametersTypeDescription
nodestringThe node name.
lastentriesintegeroptionalMax number of entries (default 50).
sincestringoptionalShow entries since date/time.
startcursorstringoptionalStart cursor for paging.
untilstringoptionalShow entries until date/time.

Tool: get_node_netstat

Get network statistics for a node (per-interface traffic).

ParametersTypeDescription
nodestringThe node name.

Tool: get_node_network

Get network interface configuration for a node.

ParametersTypeDescription
nodestringThe node name.

Tool: get_node_network_interface

Get details for a specific network interface.

ParametersTypeDescription
ifacestringInterface name (e.g. 'vmbr0', 'eth0').
nodestringThe node name.

Tool: get_node_report

Generate a system report for a node (useful for diagnostics).

ParametersTypeDescription
nodestringThe node name.

Tool: get_node_status

Get detailed status of a specific node including CPU, memory, disk, uptime, and kernel info.

ParametersTypeDescription
nodestringThe node name (e.g. 'pve1').

Tool: get_node_storage_scan

Scan for available storage targets (NFS, CIFS, iSCSI, LVM, ZFS, PBS).

ParametersTypeDescription
nodestringThe node name.
scan_typestringType to scan: 'nfs', 'cifs', 'iscsi', 'lvm', 'lvmthin', 'zfs', 'pbs'.
serverstringoptionalServer address (required for nfs, cifs, iscsi, pbs).

Tool: get_node_storage_status

Get usage status of a storage pool on a node (total, used, available).

ParametersTypeDescription
nodestringThe node name.
storagestringThe storage ID.

Tool: get_node_subscription

Get subscription status for a node.

ParametersTypeDescription
nodestringThe node name.

Tool: get_node_syslog

Read system log (syslog) entries from a node.

ParametersTypeDescription
nodestringThe node name.
limitintegeroptionalMax number of log lines to return (default 50).
sincestringoptionalOnly show entries since this date (YYYY-MM-DD).
startintegeroptionalStart line number.
untilstringoptionalOnly show entries until this date (YYYY-MM-DD).

Tool: get_node_time

Get the current time and timezone of a node.

ParametersTypeDescription
nodestringThe node name.

Tool: get_node_version

Get Proxmox VE version information for a specific node.

ParametersTypeDescription
nodestringThe node name.

Tool: get_permissions

Check effective permissions for a user on a given path.

ParametersTypeDescription
pathstringoptionalObject path to check (empty = root).
useridstringoptionalUser to check (empty = current user).

Tool: get_pool

Get pool configuration and members.

ParametersTypeDescription
poolidstringPool ID.

Tool: get_replication_job

Get a specific replication job configuration.

ParametersTypeDescription
idstringReplication job ID (format: GUEST-JOBNUM, e.g. '100-0').

Tool: get_role

Get role details and its privileges.

ParametersTypeDescription
roleidstringRole ID.

Tool: get_sdn_controller

Get SDN controller configuration.

ParametersTypeDescription
controllerstringController ID.

Tool: get_sdn_ipam

Get IPAM plugin configuration.

ParametersTypeDescription
ipamstringIPAM ID.

Tool: get_sdn_vnet

Get SDN VNet configuration.

ParametersTypeDescription
vnetstringVNet ID.

Tool: get_sdn_zone

Get SDN zone configuration.

ParametersTypeDescription
zonestringZone ID.

Tool: get_storage_config

Get configuration of a specific storage pool.

ParametersTypeDescription
storagestringThe storage ID.

Tool: get_storage_rrddata

Get RRD statistics for a storage pool (usage over time).

ParametersTypeDescription
nodestringThe node name.
storagestringThe storage ID.
timeframestringoptionalTime range: 'hour', 'day', 'week', 'month', 'year'.

Tool: get_storage_volume_info

Get details about a specific volume in storage.

ParametersTypeDescription
nodestringThe node name.
storagestringThe storage ID.
volumestringThe volume ID.

Tool: get_task_log

Get log output of a specific task.

ParametersTypeDescription
nodestringThe node name.
upidstringThe task UPID string.
limitintegeroptionalMax lines to return.
startintegeroptionalStart line number.

Tool: get_task_status

Get the status of a specific task by its UPID.

ParametersTypeDescription
nodestringThe node name.
upidstringThe task UPID string.

Tool: get_user

Get details for a specific user.

ParametersTypeDescription
useridstringUser ID (format: 'user@realm', e.g. 'admin@pam').

Tool: get_user_token

Get details for a specific API token.

ParametersTypeDescription
tokenidstringToken ID.
useridstringUser ID (format: 'user@realm').

Tool: get_version

Get the Proxmox VE API version information.

Tool: get_vm_cloudinit

Get Cloud-Init configuration for a VM.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.

Tool: get_vm_config

Get the configuration of a VM.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.
currentbooleanoptionalIf True, return current (runtime) config. If False, return pending config.

Tool: get_vm_feature

Check if a specific feature is available/supported for a VM (e.g. snapshot, clone, copy).

ParametersTypeDescription
featurestringFeature to check ('snapshot', 'clone', 'copy').
nodestringThe node name.
vmidintegerThe VM ID.

Tool: get_vm_firewall_options

Get firewall options for a QEMU VM.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.

Tool: get_vm_pending

Get pending configuration changes for a VM (not yet applied).

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.

Tool: get_vm_rrddata

Get RRD statistics data for a VM (CPU, memory, disk, network over time).

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.
timeframestringoptionalTime range: 'hour', 'day', 'week', 'month', 'year'.

Tool: get_vm_snapshot_config

Get the configuration stored in a VM snapshot.

ParametersTypeDescription
nodestringThe node name.
snapnamestringThe snapshot name.
vmidintegerThe VM ID.

Tool: get_vm_spiceproxy

Create a SPICE proxy connection for a VM console.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.

Tool: get_vm_status

Get the current runtime status of a VM (state, CPU, memory, disk, network, uptime).

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.

Tool: get_vm_vncproxy

Create a VNC proxy connection ticket for a VM (for console access).

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.
websocketbooleanoptionalUse WebSocket connection.

Tool: get_vzdump_defaults

Get the default vzdump configuration for a node.

ParametersTypeDescription
nodestringThe node name.

Tool: get_vzdump_extractconfig

Extract the guest configuration from a vzdump backup archive.

ParametersTypeDescription
nodestringThe node name.
volumestringBackup volume ID (e.g. 'local:backup/vzdump-qemu-100-2024_01_01-00_00_00.vma.zst').

Tool: get_zfs_pool

Get details of a ZFS pool.

ParametersTypeDescription
namestringZFS pool name.
nodestringThe node name.

Tool: initialize_gpt

Initialize a disk with GPT partition table (WARNING: destroys all data).

ParametersTypeDescription
diskstringDisk device path (e.g. '/dev/sdb').
nodestringThe node name.

Tool: join_cluster

Join a node to an existing cluster.

ParametersTypeDescription
fingerprintstringSSL fingerprint of the cluster node.
hostnamestringHostname/IP of existing cluster node.
passwordstringRoot password of the cluster node.
forcebooleanoptionalForce join even with warnings.
nodeidintegeroptionalForce specific node ID.

Tool: list_acme_accounts

List ACME (Let's Encrypt) accounts.

Tool: list_acme_plugins

List ACME DNS challenge plugins.

Tool: list_auth_domains

List configured authentication realms/domains (PAM, PVE, LDAP, AD, OpenID).

Tool: list_backup_file_restore

List files in a vzdump backup for single-file restore.

ParametersTypeDescription
nodestringThe node name.
storagestringStorage ID.
volumestringBackup volume ID.
filepathstringoptionalPath within the backup (default '/').

Tool: list_backup_jobs

List all scheduled backup jobs (vzdump) in the cluster.

Tool: list_ceph_fs

List CephFS filesystems.

ParametersTypeDescription
nodestringThe node name.

Tool: list_ceph_managers

List Ceph managers.

ParametersTypeDescription
nodestringThe node name.

Tool: list_ceph_mds

List Ceph metadata servers (MDS, for CephFS).

ParametersTypeDescription
nodestringThe node name.

Tool: list_ceph_monitors

List Ceph monitors.

ParametersTypeDescription
nodestringThe node name.

Tool: list_ceph_osds

List Ceph OSDs on a node.

ParametersTypeDescription
nodestringThe node name.

Tool: list_ceph_pools

List Ceph pools.

ParametersTypeDescription
nodestringThe node name.

Tool: list_cluster_firewall_rules

List cluster-level firewall rules.

Tool: list_container_firewall_rules

List firewall rules for an LXC container.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID.

Tool: list_container_snapshots

List all snapshots of a container.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID.

Tool: list_containers

List all LXC containers on a node with status, memory, CPU, and disk info.

ParametersTypeDescription
nodestringThe node name.

Tool: list_dir_mappings

List directory mappings.

Tool: list_directory_storage

List directory-based storage mounts on a node.

ParametersTypeDescription
nodestringThe node name.

Tool: list_file_restore

List files in a backup volume for file-level restore (PBS backups).

ParametersTypeDescription
nodestringThe node name.
storagestringThe storage ID.
volumestringThe backup volume ID.
filepathstringoptionalPath inside the backup to list (default '/').

Tool: list_firewall_aliases

List cluster firewall aliases (named IP addresses/ranges).

Tool: list_firewall_groups

List firewall security groups (reusable sets of rules).

Tool: list_firewall_ipset_entries

List entries in a firewall IP set.

ParametersTypeDescription
namestringIP set name.

Tool: list_firewall_ipsets

List cluster firewall IP sets (named groups of IPs).

Tool: list_firewall_macros

List available firewall macros (predefined rule sets like SSH, HTTP, etc.).

Tool: list_groups

List all user groups.

Tool: list_ha_groups

List HA groups (define which nodes can run HA resources).

Tool: list_ha_resources

List all HA-managed resources.

Tool: list_lvm_volumes

List LVM volume groups on a node.

ParametersTypeDescription
nodestringThe node name.

Tool: list_lvmthin_pools

List LVM thin pools on a node.

ParametersTypeDescription
nodestringThe node name.

Tool: list_metric_servers

List configured metric servers (InfluxDB, Graphite).

Tool: list_node_firewall_rules

List firewall rules for a node.

ParametersTypeDescription
nodestringThe node name.

Tool: list_node_services

List all system services on a node (pve, ssh, cron, etc.).

ParametersTypeDescription
nodestringThe node name.

Tool: list_node_storage

List storage pools available on a specific node with usage info.

ParametersTypeDescription
nodestringThe node name.
contentstringoptionalFilter by content type (images, rootdir, vztmpl, iso, backup).
enabledbooleanoptionalOnly show enabled storage.

Tool: list_node_tasks

List recent tasks on a node.

ParametersTypeDescription
nodestringThe node name.
limitintegeroptionalMax tasks to return (default 50).
startintegeroptionalOffset for paging.
statusfilterstringoptionalFilter by status ('running', 'ok', 'error', etc.).
typefilterstringoptionalFilter by task type (e.g. 'qmstart', 'vzstart', 'vzcreate').
vmidintegeroptionalFilter by VM ID (0 = all).

Tool: list_nodes

List all nodes in the Proxmox cluster with their status, CPU, memory, and uptime.

Tool: list_notification_endpoints

List all configured notification endpoints (sendmail, gotify, smtp, webhook).

Tool: list_notification_matchers

List all notification matchers (rules that route notifications).

Tool: list_notification_targets

List all notification targets.

Tool: list_pci_mappings

List PCI device mappings for passthrough.

Tool: list_pools

List all resource pools.

Tool: list_realm_sync_jobs

List realm synchronization jobs.

Tool: list_replication_jobs

List all replication jobs in the cluster.

Tool: list_roles

List all available roles.

Tool: list_scheduled_jobs

List all scheduled cluster jobs (realm-sync, etc.).

Tool: list_sdn_controllers

List SDN controllers (e.g. EVPN controller).

Tool: list_sdn_dns

List SDN DNS plugins.

Tool: list_sdn_ipams

List IPAM (IP Address Management) plugins.

Tool: list_sdn_subnets

List subnets for an SDN VNet.

ParametersTypeDescription
vnetstringVNet ID.

Tool: list_sdn_vnets

List SDN virtual networks (VNets).

Tool: list_sdn_zones

List SDN zones.

Tool: list_storage

List all configured storage pools at the datacenter level.

ParametersTypeDescription
enabledbooleanoptionalOnly show enabled storage (default True).
typestringoptionalFilter by type (dir, lvm, lvmthin, zfspool, nfs, cifs, iscsi, rbd, cephfs, pbs, glusterfs, btrfs).

Tool: list_storage_content

List content of a storage pool (disk images, ISOs, templates, backups).

ParametersTypeDescription
nodestringThe node name.
storagestringThe storage ID.
contentstringoptionalFilter by type: 'images', 'rootdir', 'vztmpl', 'iso', 'backup', 'snippets'.
vmidintegeroptionalFilter by VM ID.

Tool: list_tfa

List TFA (two-factor auth) entries.

ParametersTypeDescription
useridstringoptionalFilter by user ID (empty = all users).

Tool: list_usb_mappings

List USB device mappings for passthrough.

Tool: list_user_tokens

List API tokens for a user.

ParametersTypeDescription
useridstringUser ID (format: 'user@realm').

Tool: list_users

List all users in Proxmox.

ParametersTypeDescription
enabledbooleanoptionalOnly show enabled users.
fullbooleanoptionalInclude detailed info (groups, tokens, etc.).

Tool: list_vm_firewall_rules

List firewall rules for a QEMU VM.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.

Tool: list_vm_snapshots

List all snapshots of a VM.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.

Tool: list_vms

List all QEMU virtual machines on a node with status, memory, CPU, and disk info.

ParametersTypeDescription
nodestringThe node name.

Tool: list_zfs_pools

List ZFS pools on a node.

ParametersTypeDescription
nodestringThe node name.

Tool: manage_node_service

Start, stop, restart, or reload a system service on a node.

ParametersTypeDescription
actionstringOne of 'start', 'stop', 'restart', 'reload'.
nodestringThe node name.
servicestringService name (e.g. 'pvedaemon', 'pveproxy', 'ssh', 'cron', 'postfix').

Tool: migrate_container

Migrate a container to another node.

ParametersTypeDescription
nodestringThe source node.
targetstringTarget node name.
vmidintegerThe container ID.
onlinebooleanoptionalLive migration.
restartbooleanoptionalRestart container after migration (for non-live).
target_storagestringoptionalTarget storage mapping.

Tool: migrate_ha_resource

Request migration of an HA resource to a different node.

ParametersTypeDescription
nodestringTarget node.
sidstringResource ID.

Tool: migrate_vm

Migrate a VM to another node in the cluster.

ParametersTypeDescription
nodestringThe source node.
targetstringTarget node name.
vmidintegerThe VM ID.
onlinebooleanoptionalLive migration (True) or offline (False).
targetstoragestringoptionalTarget storage mapping for migration (e.g. 'local-lvm').
with_local_disksbooleanoptionalMigrate local disks as well.

Tool: move_container_volume

Move a container volume to different storage or to another container.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID.
volumestringVolume name (e.g. 'rootfs', 'mp0').
delete_originalbooleanoptionalDelete original after move.
storagestringoptionalTarget storage.
target_vmidintegeroptionalTarget container ID.
target_volumestringoptionalTarget volume slot.

Tool: move_vm_disk

Move a VM disk to different storage or attach to another VM.

ParametersTypeDescription
diskstringSource disk name (e.g. 'scsi0').
nodestringThe node name.
vmidintegerThe VM ID.
delete_originalbooleanoptionalDelete the original disk after moving.
storagestringoptionalTarget storage ID (for moving to different storage).
target_diskstringoptionalTarget disk slot on the target VM.
target_vmidintegeroptionalTarget VM ID (for moving disk to another VM).

Tool: order_node_certificate

Order/renew ACME certificate for a node.

ParametersTypeDescription
nodestringThe node name.
forcebooleanoptionalForce renewal even if not due.

Tool: proxmox_api_raw

Make an arbitrary Proxmox API call for any endpoint not covered by specific tools.

ParametersTypeDescription
methodstringHTTP method: 'get', 'post', 'put', 'delete'.
pathstringAPI path (e.g. '/nodes/pve1/qemu/100/status/current').
paramsstringoptionalJSON string of parameters (e.g. '{"memory": 4096}').

Tool: prune_storage_backups

Prune (delete) old backups from storage according to retention policy.

ParametersTypeDescription
nodestringThe node name.
storagestringThe storage ID.
dry_runbooleanoptionalIf True, only simulate (default True for safety).
prune_backupsstringoptionalRetention spec (e.g. 'keep-last=3,keep-daily=7,keep-weekly=4').
typestringoptionalGuest type filter ('qemu' or 'lxc').
vmidintegeroptionalFilter by VM ID.

Tool: reboot_container

Reboot a container.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID.
timeoutintegeroptionalTimeout in seconds.

Tool: reboot_vm

Reboot a VM via ACPI.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.
timeoutintegeroptionalWait timeout in seconds.

Tool: register_acme_account

Register a new ACME account.

ParametersTypeDescription
contactstringContact email address.
directorystringoptionalACME directory URL (empty = Let's Encrypt production).
namestringoptionalAccount name.
tos_urlstringoptionalTerms of service URL to accept.

Tool: relocate_ha_resource

Request relocation of an HA resource to a different node.

ParametersTypeDescription
nodestringTarget node.
sidstringResource ID.

Tool: reset_vm

Hard reset a VM (like pressing the reset button).

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.

Tool: resize_container_disk

Resize a container disk/volume.

ParametersTypeDescription
diskstringDisk name (e.g. 'rootfs', 'mp0').
nodestringThe node name.
sizestringNew size or increment (e.g. '10G', '+2G').
vmidintegerThe container ID.

Tool: resize_vm_disk

Resize a VM disk. Can only grow, not shrink.

ParametersTypeDescription
diskstringDisk name (e.g. 'scsi0', 'virtio0', 'ide0').
nodestringThe node name.
sizestringNew size or size increment (e.g. '50G', '+10G').
vmidintegerThe VM ID.

Tool: resume_container

Resume a suspended container.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID.

Tool: resume_vm

Resume a suspended/paused VM.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.

Tool: rollback_container_snapshot

Rollback a container to a previous snapshot.

ParametersTypeDescription
nodestringThe node name.
snapnamestringSnapshot name.
vmidintegerThe container ID.

Tool: rollback_vm_snapshot

Rollback a VM to a previous snapshot (current state will be lost).

ParametersTypeDescription
nodestringThe node name.
snapnamestringThe snapshot name to rollback to.
vmidintegerThe VM ID.

Tool: run_apt_update

Refresh the package index on a node (apt update).

ParametersTypeDescription
nodestringThe node name.

Tool: send_vm_key

Send a key event to a VM (e.g. ctrl-alt-del).

ParametersTypeDescription
keystringKey combination (e.g. 'ctrl-alt-delete').
nodestringThe node name.
vmidintegerThe VM ID.

Tool: send_vm_monitor_command

Send a QEMU monitor command to a VM (advanced/low-level).

ParametersTypeDescription
commandstringThe QEMU monitor command.
nodestringThe node name.
vmidintegerThe VM ID.

Tool: set_ceph_flags

Set a Ceph global flag.

ParametersTypeDescription
flagstringFlag name (noout, noscrub, nobackfill, norebalance, nodown, noup, etc.).
valuebooleanTrue to set, False to unset.

Tool: set_cluster_firewall_options

Set cluster-wide firewall options.

ParametersTypeDescription
deletestringoptionalComma-separated options to delete.
ebtablesintegeroptional1 to enable ebtables rules, 0 to disable, -1 to not change.
enableintegeroptional1 to enable, 0 to disable, -1 to not change.
log_ratelimitstringoptionalLog rate limit (e.g. 'enable=1,rate=1/second,burst=5').
policy_instringoptionalDefault input policy: 'ACCEPT', 'REJECT', 'DROP'.
policy_outstringoptionalDefault output policy: 'ACCEPT', 'REJECT', 'DROP'.

Tool: set_node_firewall_options

Set firewall options for a node.

ParametersTypeDescription
nodestringThe node name.
deletestringoptionalComma-separated options to delete.
enableintegeroptional1 = enable, 0 = disable, -1 = don't change.
log_level_instringoptionalInput log level.
log_level_outstringoptionalOutput log level.
ndpintegeroptional1 = enable NDP, 0 = disable, -1 = don't change.
nf_conntrack_maxintegeroptionalMax conntrack entries (0 = don't change).

Tool: set_vm_firewall_options

Set firewall options for a QEMU VM.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.
deletestringoptionalComma-separated options to delete.
dhcpintegeroptional1 = enable DHCP.
enableintegeroptional1 = enable, 0 = disable.
ipfilterintegeroptional1 = enable IP filter.
macfilterintegeroptional1 = enable MAC filter.
policy_instringoptionalInput policy.
policy_outstringoptionalOutput policy.

Tool: shutdown_container

Gracefully shut down a container.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID.
force_stopbooleanoptionalForce stop after timeout.
timeoutintegeroptionalTimeout in seconds before force stop.

Tool: shutdown_vm

Gracefully shut down a VM via ACPI. Falls back to hard stop after timeout if force_stop is true.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.
force_stopbooleanoptionalForce stop after timeout (default True).
timeoutintegeroptionalTimeout in seconds before force stop.

Tool: start_container

Start a container.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID.

Tool: start_vm

Start a VM.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.
timeoutintegeroptionalTimeout in seconds (0 = default).

Tool: startall_node

Start all VMs and containers on a node (respecting boot order).

ParametersTypeDescription
nodestringThe node name.
forcebooleanoptionalForce start even if already running.
vmsstringoptionalComma-separated list of VMIDs to start (empty = all).

Tool: stop_container

Hard-stop a container (immediate, like power off).

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID.

Tool: stop_task

Stop (abort) a running task.

ParametersTypeDescription
nodestringThe node name.
upidstringThe task UPID string.

Tool: stop_vm

Hard-stop a VM (like pulling the power plug). Prefer shutdown_vm for graceful stop.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.
skiplockbooleanoptionalIgnore locks (requires root).
timeoutintegeroptionalWait timeout in seconds.

Tool: stopall_node

Stop all VMs and containers on a node.

ParametersTypeDescription
nodestringThe node name.
vmsstringoptionalComma-separated list of VMIDs to stop (empty = all).

Tool: suspend_container

Suspend (freeze) a container.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID.

Tool: suspend_vm

Suspend a VM (pause execution or hibernate to disk).

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.
todiskbooleanoptionalIf True, hibernate to disk. If False, pause in RAM.

Tool: sync_auth_domain

Sync users/groups from an external auth domain (LDAP/AD).

ParametersTypeDescription
realmstringRealm ID to sync.
dry_runbooleanoptionalOnly show what would change.
enable_newbooleanoptionalEnable newly synced users.
fullbooleanoptionalFull sync (not just incremental).
remove_vanishedstringoptionalComma-separated: 'entry' (remove users), 'properties' (clear), 'acl' (remove ACLs).

Tool: test_notification_target

Send a test notification to a target.

ParametersTypeDescription
namestringTarget name.

Tool: update_acl

Add or remove ACL entries (permission assignments).

ParametersTypeDescription
pathstringObject path (e.g. '/', '/vms/100', '/storage/local', '/pool/mypool').
rolesstringComma-separated role list.
deletebooleanoptionalRemove the ACL entry instead of adding.
groupsstringoptionalComma-separated group list.
propagatebooleanoptionalPropagate permissions to child objects.
tokensstringoptionalComma-separated token list (format: 'user@realm!tokenid').
usersstringoptionalComma-separated user list (format: 'user@realm').

Tool: update_backup_job

Update a scheduled backup job.

ParametersTypeDescription
idstringBackup job ID.
all_guestsbooleanoptionalBackup all guests.
compressstringoptionalCompression.
deletestringoptionalComma-separated properties to delete.
enabledbooleanoptionalEnable/disable.
modestringoptionalBackup mode.
nodestringoptionalNode filter.
schedulestringoptionalSchedule in systemd calendar format.
storagestringoptionalTarget storage ID.
vmidstringoptionalComma-separated VMIDs.

Tool: update_cluster_firewall_rule

Update a cluster-level firewall rule.

ParametersTypeDescription
posintegerRule position to update.
actionstringoptional'ACCEPT', 'DROP', 'REJECT'.
commentstringoptionalDescription.
deletestringoptionalComma-separated properties to delete.
deststringoptionalDestination address/range.
dportstringoptionalDestination port(s).
enableintegeroptional1 = enabled, 0 = disabled, -1 = don't change.
macrostringoptionalPredefined macro.
movetointegeroptionalMove rule to this position.
protostringoptionalProtocol.
sourcestringoptionalSource address/range.
sportstringoptionalSource port(s).

Tool: update_cluster_options

Update datacenter/cluster-wide options.

ParametersTypeDescription
consolestringoptionalDefault console viewer: 'applet', 'vv', 'html5', 'xtermjs'.
deletestringoptionalComma-separated settings to delete.
descriptionstringoptionalDatacenter description.
email_fromstringoptionalDefault email sender address.
http_proxystringoptionalHTTP proxy URL.
keyboardstringoptionalKeyboard layout (e.g. 'en-us', 'de').
languagestringoptionalDefault language.
max_workersintegeroptionalMax parallel workers.

Tool: update_container_config

Update the configuration of an existing container.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe container ID.
coresintegeroptionalCPU cores.
cpulimitnumberoptionalCPU limit (0 = unlimited).
deletestringoptionalComma-separated list of settings to delete.
descriptionstringoptionalDescription.
featuresstringoptionalComma-separated features.
hostnamestringoptionalContainer hostname.
memoryintegeroptionalMemory in MB.
nameserverstringoptionalDNS nameserver.
net0stringoptionalNetwork config.
onbootstringoptionalStart on boot.
searchdomainstringoptionalDNS search domain.
swapintegeroptionalSwap in MB.
tagsstringoptionalSemicolon-separated tags.

Tool: update_group

Update a group.

ParametersTypeDescription
groupidstringGroup ID.
commentstringoptionalDescription.

Tool: update_ha_group

Update an HA group.

ParametersTypeDescription
groupstringGroup ID.
commentstringoptionalDescription.
deletestringoptionalComma-separated properties to delete.
nodesstringoptionalNode list with optional priority.
nofailbackbooleanoptionalDon't fail back.
restrictedbooleanoptionalOnly run on group nodes.

Tool: update_ha_resource

Update an HA resource configuration.

ParametersTypeDescription
sidstringResource ID.
commentstringoptionalDescription.
deletestringoptionalComma-separated properties to delete.
groupstringoptionalHA group name.
max_relocateintegeroptionalMax relocations (-1 = don't change).
max_restartintegeroptionalMax restarts (-1 = don't change).
statestringoptionalDesired state.

Tool: update_pool

Update a resource pool (add/remove members).

ParametersTypeDescription
poolidstringPool ID.
commentstringoptionalDescription.
deletebooleanoptionalIf true, remove the specified vms/storage from the pool instead of adding.
storagestringoptionalComma-separated storage IDs to add/remove.
vmsstringoptionalComma-separated VMIDs to add/remove.

Tool: update_role

Update role privileges.

ParametersTypeDescription
privsstringComma-separated list of privileges.
roleidstringRole ID.
appendbooleanoptionalAppend privileges instead of replacing.

Tool: update_sdn_vnet

Update an SDN VNet.

ParametersTypeDescription
vnetstringVNet ID.
aliasstringoptionalDisplay alias.
deletestringoptionalComma-separated properties to delete.
tagintegeroptionalVLAN tag (-1 = don't change).
zonestringoptionalZone ID.

Tool: update_storage

Update an existing storage pool configuration.

ParametersTypeDescription
storagestringThe storage ID to update.
contentstringoptionalContent types (images, rootdir, vztmpl, iso, backup, snippets, import).
deletestringoptionalComma-separated list of settings to delete.
disablestringoptionalDisable this storage.
nodesstringoptionalAllowed nodes (comma-separated).
prune_backupsstringoptionalBackup retention policy.
sharedstringoptionalMark as shared.

Tool: update_user

Update an existing user.

ParametersTypeDescription
useridstringUser ID (format: 'user@realm').
appendbooleanoptionalAppend groups instead of replacing.
commentstringoptionalDescription.
emailstringoptionalEmail address.
enablebooleanoptionalEnable/disable user.
expireintegeroptionalAccount expiration (Unix epoch, 0 = never, -1 = don't change).
firstnamestringoptionalFirst name.
groupsstringoptionalComma-separated group list.
lastnamestringoptionalLast name.

Tool: update_vm_cloudinit

Set Cloud-Init parameters for a VM (user, password, SSH keys, network).

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.
cipasswordstringoptionalCloud-Init password.
ciuserstringoptionalCloud-Init user name.
ipconfig0stringoptionalIP config for first interface (e.g. 'ip=dhcp' or 'ip=10.0.0.5/24,gw=10.0.0.1').
nameserverstringoptionalDNS nameserver IP.
searchdomainstringoptionalDNS search domain.
sshkeysstringoptionalSSH public keys (URL-encoded, newline delimited).

Tool: update_vm_config

Update the configuration of an existing VM. Only provided parameters are changed.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.
agentstringoptionalGuest agent config.
bootstringoptionalBoot order.
coresintegeroptionalCPU cores per socket.
cpustringoptionalCPU type.
deletestringoptionalComma-separated list of settings to delete.
descriptionstringoptionalDescription.
hotplugstringoptionalHotplug features (disk, network, usb, memory, cpu).
memoryintegeroptionalMemory in MB.
namestringoptionalVM name.
net0stringoptionalNetwork config.
onbootstringoptionalStart on boot.
socketsintegeroptionalCPU sockets.
tagsstringoptionalSemicolon-separated tags.

Tool: upload_to_storage

Upload a file (ISO, template, etc.) to storage. Note: actual file upload must go through the HTTP API directly.

ParametersTypeDescription
contentstringContent type: 'iso', 'vztmpl', 'snippets', 'import'.
filenamestringTarget filename.
nodestringThe node name.
storagestringThe storage ID.
tmpfilenamestringoptionalTemporary filename for the upload.

Tool: vm_agent_exec

Execute a command inside a VM via the QEMU Guest Agent.

ParametersTypeDescription
commandstringThe command to execute.
nodestringThe node name.
vmidintegerThe VM ID.
input_datastringoptionalData to pass to stdin.

Tool: vm_agent_exec_status

Get the status/result of a command previously executed via the guest agent.

ParametersTypeDescription
nodestringThe node name.
pidintegerThe PID returned by the exec call.
vmidintegerThe VM ID.

Tool: vm_agent_file_read

Read a file from inside a VM via the guest agent.

ParametersTypeDescription
filestringAbsolute file path inside the guest.
nodestringThe node name.
vmidintegerThe VM ID.

Tool: vm_agent_file_write

Write content to a file inside a VM via the guest agent.

ParametersTypeDescription
contentstringFile content to write.
filestringAbsolute file path inside the guest.
nodestringThe node name.
vmidintegerThe VM ID.

Tool: vm_agent_get_info

Get various system information from a VM via the guest agent.

ParametersTypeDescription
nodestringThe node name.
vmidintegerThe VM ID.
info_typestringoptionalInfo to retrieve: 'get-osinfo', 'get-host-name', 'get-time',

Tool: vm_agent_set_password

Set a user password inside a VM via the guest agent.

ParametersTypeDescription
nodestringThe node name.
passwordstringThe new password.
usernamestringThe username.
vmidintegerThe VM ID.
cryptedbooleanoptionalIf True, password is already encrypted.

Tool: wakeonlan_node

Send a Wake-on-LAN magic packet to a node.

ParametersTypeDescription
nodestringThe node name.

Use this MCP Server

{
  "mcpServers": {
    "proxmox": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "PROXMOX_HOST",
        "-e",
        "PROXMOX_USER",
        "-e",
        "PROXMOX_TOKEN_NAME",
        "-e",
        "PROXMOX_PORT",
        "-e",
        "PROXMOX_VERIFY_SSL",
        "-e",
        "PROXMOX_TIMEOUT",
        "-e",
        "PROXMOX_TOKEN_VALUE",
        "-e",
        "PROXMOX_PASSWORD",
        "mcp/proxmox"
      ],
      "env": {
        "PROXMOX_HOST": "192.168.1.100",
        "PROXMOX_USER": "root@pam",
        "PROXMOX_TOKEN_NAME": "mcp-token",
        "PROXMOX_PORT": "8006",
        "PROXMOX_VERIFY_SSL": "false",
        "PROXMOX_TIMEOUT": "30",
        "PROXMOX_TOKEN_VALUE": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "PROXMOX_PASSWORD": "your-proxmox-password"
      }
    }
  }
}

Why is it safer to run MCP Servers with Docker?⁠

Related servers