Proxmox MCP Server
This server provides comprehensive Proxmox VE management through an MCP interface, enabling AI assistants to perform administrative tasks across nodes, VMs, containers, storage, networking, firewall, HA, access control, backup, SDN, and more.
Node Management: List nodes, get status/config, manage network interfaces, services, system logs, tasks, disks, PCI/USB hardware, QEMU capabilities, storage scanning, Wake-on-LAN, start/stop all guests, view hosts, version, netstat, appliance templates.
QEMU Virtual Machines: Full lifecycle (list, create, update, delete, start, stop, shutdown, reboot, suspend, resume, reset, clone, migrate, convert to template), resize/move disks, manage snapshots, Cloud-Init configuration, QEMU Guest Agent (exec, file read/write, set password, get info), VNC/SPICE proxy, send keys, QEMU monitor commands.
LXC Containers: Full lifecycle (list, create, update, delete, start, stop, shutdown, reboot, suspend, resume, clone, migrate, convert to template), resize/move disks, snapshots, network interfaces, RRD data, features.
Storage Management: List, create, update, delete storage pools; node storage status; manage content (volumes, ISOs, backups); upload/download files; prune backups; file-level restore from PBS; manage LVM, LVM thin, ZFS, directory storage; initialize GPT.
Cluster Management: Get version, status, resources, tasks, logs; next VMID; cluster options; config/nodes/join info; totem; replication jobs; metric servers (InfluxDB, Graphite); notification endpoints/targets/matchers; bulk guest operations (start, shutdown, migrate); scheduled jobs; realm sync; PCI/USB/directory mappings; Ceph cluster monitoring (status, flags, OSDs, pools, monitors, managers, MDS, CephFS, config, CRUSH).
Access Control: Full user management (list, get, create, update, delete, change password, check permissions); API tokens; groups; roles with specific privileges; ACLs; authentication domains (PAM, PVE, LDAP, AD, OpenID) with sync; TFA listing.
Backup: Scheduled jobs (list, create, update, delete); immediate vzdump; get defaults; extract config from backup; list and download files from backups; file-level restore.
Firewall: Manage cluster/node/VM/container firewall options and rules; security groups; aliases; IP sets with dynamic entries; macros; logs.
High Availability: HA status and manager status; manage HA resources (list, get, create, update, delete, migrate, relocate); manage HA groups.
SDN (Software-Defined Networking): Manage VNets, subnets, zones, controllers, IPAM, DNS; apply pending changes.
Resource Pools & ACME: Manage resource pools; ACME accounts, plugins, certificate ordering.
Generic API Access:
proxmox_api_rawfor arbitrary Proxmox API calls.
Provides tools for managing Proxmox VE infrastructure, including nodes, virtual machines, containers, storage, networking, firewall rules, and high availability.
Provides tools for managing QEMU virtual machines, including creation, configuration, snapshots, cloning, migration, and guest agent operations.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Proxmox MCP Server List all VMs on node proxmox-node1"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Proxmox MCP Server
Overview
This is a Model Context Protocol (MCP) server that provides tools for interacting with Proxmox VE infrastructure. It enables AI assistants and other MCP clients to manage virtual machines, containers, storage, networking, firewall rules, high availability, and more through a standardized interface. The server supports both API token and password-based authentication against local and remote Proxmox instances.
Related MCP server: ProxmoxEmCP
Distributions
Tools
Node Management
list_nodes- List all nodes in the Proxmox cluster with their status, CPU, memory, and uptimeget_node_status- Get detailed status of a specific node including CPU, memory, disk, uptime, and kernel infoget_node_config- Get the configuration of a node (description, wakeonlan, etc.)get_node_dns- Get DNS settings for a nodeget_node_network- Get network interface configuration for a nodeget_node_network_interface- Get details for a specific network interfacecreate_node_network_interface- Create a network interface on a nodelist_node_services- List all system services on a node (pve, ssh, cron, etc.)manage_node_service- Start, stop, restart, or reload a system service on a nodeget_node_syslog- Read system log (syslog) entries from a nodeget_node_journal- Read systemd journal entries from a nodelist_node_tasks- List recent tasks on a nodeget_task_status- Get the status of a specific task by its UPIDget_task_log- Get log output of a specific taskstop_task- Stop (abort) a running taskget_node_time- Get the current time and timezone of a nodeget_node_subscription- Get subscription status for a nodeget_node_apt_update- List available package updates on a noderun_apt_update- Refresh the package index on a node (apt update)get_node_report- Generate a system report for a node (useful for diagnostics)get_node_disks- List physical disks on a nodeget_disk_smart- Get S.M.A.R.T. health data for a diskget_node_hardware_pci- List PCI hardware devices on a node (for passthrough)get_node_hardware_usb- List USB hardware devices on a nodeget_node_capabilities_qemu- Get QEMU capabilities for a node: supported CPU models, machine types, etc.get_node_storage_scan- Scan for available storage targets (NFS, CIFS, iSCSI, LVM, ZFS, PBS)wakeonlan_node- Send a Wake-on-LAN magic packet to a nodestartall_node- Start all VMs and containers on a node (respecting boot order)stopall_node- Stop all VMs and containers on a nodeget_node_hosts- Get the /etc/hosts file content for a nodeget_node_version- Get Proxmox VE version information for a specific nodeget_node_netstat- Get network statistics for a node (per-interface traffic)get_node_aplinfo- List available appliance templates (LXC templates) that can be downloadeddownload_appliance_template- Download an appliance template to local storage
QEMU Virtual Machines
list_vms- List all QEMU virtual machines on a node with status, memory, CPU, and disk infoget_vm_status- Get the current runtime status of a VM (state, CPU, memory, disk, network, uptime)get_vm_config- Get the configuration of a VMget_vm_pending- Get pending configuration changes for a VM (not yet applied)get_vm_feature- Check if a specific feature is available/supported for a VM (e.g. snapshot, clone, copy)get_vm_rrddata- Get RRD statistics data for a VM (CPU, memory, disk, network over time)create_vm- Create a new QEMU virtual machineupdate_vm_config- Update the configuration of an existing VMdelete_vm- Delete a VM (must be stopped first)start_vm- Start a VMstop_vm- Hard-stop a VM (like pulling the power plug)shutdown_vm- Gracefully shut down a VM via ACPIreboot_vm- Reboot a VM via ACPIsuspend_vm- Suspend a VM (pause execution or hibernate to disk)resume_vm- Resume a suspended/paused VMreset_vm- Hard reset a VM (like pressing the reset button)clone_vm- Clone a VM to create a new one (full copy or linked clone)migrate_vm- Migrate a VM to another node in the clusterconvert_vm_to_template- Convert a VM into a template (irreversible)resize_vm_disk- Resize a VM disk (can only grow, not shrink)move_vm_disk- Move a VM disk to different storage or attach to another VMlist_vm_snapshots- List all snapshots of a VMcreate_vm_snapshot- Create a snapshot of a VMdelete_vm_snapshot- Delete a VM snapshotrollback_vm_snapshot- Rollback a VM to a previous snapshot (current state will be lost)get_vm_snapshot_config- Get the configuration stored in a VM snapshotget_vm_cloudinit- Get Cloud-Init configuration for a VMupdate_vm_cloudinit- Set Cloud-Init parameters for a VM (user, password, SSH keys, network)dump_vm_cloudinit- Dump the Cloud-Init generated config file (user-data, network-data, or meta-data)vm_agent_exec- Execute a command inside a VM via the QEMU Guest Agentvm_agent_exec_status- Get the status/result of a command previously executed via the guest agentvm_agent_file_read- Read a file from inside a VM via the guest agentvm_agent_file_write- Write content to a file inside a VM via the guest agentvm_agent_get_info- Get various system information from a VM via the guest agentvm_agent_set_password- Set a user password inside a VM via the guest agentget_vm_vncproxy- Create a VNC proxy connection ticket for a VM (for console access)get_vm_spiceproxy- Create a SPICE proxy connection for a VM consolesend_vm_key- Send a key event to a VM (e.g. ctrl-alt-del)send_vm_monitor_command- Send a QEMU monitor command to a VM (advanced/low-level)
LXC Containers
list_containers- List all LXC containers on a node with status, memory, CPU, and disk infoget_container_status- Get the current runtime status of a containerget_container_config- Get the configuration of a containerget_container_pending- Get pending configuration changes for a containerget_container_interfaces- Get network interfaces and IPs of a running containerget_container_rrddata- Get RRD statistics data for a container (CPU, memory, disk, network over time)get_container_feature- Check if a feature is available for a container (snapshot, clone, copy)create_container- Create a new LXC containerupdate_container_config- Update the configuration of an existing containerdelete_container- Delete a container (must be stopped first unless force=True)start_container- Start a containerstop_container- Hard-stop a container (immediate, like power off)shutdown_container- Gracefully shut down a containerreboot_container- Reboot a containersuspend_container- Suspend (freeze) a containerresume_container- Resume a suspended containerclone_container- Clone a containermigrate_container- Migrate a container to another nodeconvert_container_to_template- Convert a container into a template (irreversible)resize_container_disk- Resize a container disk/volumemove_container_volume- Move a container volume to different storage or to another containerlist_container_snapshots- List all snapshots of a containercreate_container_snapshot- Create a snapshot of a containerdelete_container_snapshot- Delete a container snapshotrollback_container_snapshot- Rollback a container to a previous snapshot
Storage
list_storage- List all configured storage pools at the datacenter levelget_storage_config- Get configuration of a specific storage poolcreate_storage- Create a new storage pool configurationupdate_storage- Update an existing storage pool configurationdelete_storage- Delete a storage pool configuration (does not delete data on the backend)list_node_storage- List storage pools available on a specific node with usage infoget_node_storage_status- Get usage status of a storage pool on a node (total, used, available)list_storage_content- List content of a storage pool (disk images, ISOs, templates, backups)get_storage_volume_info- Get details about a specific volume in storageallocate_storage_volume- Allocate a new disk volume in storagedelete_storage_volume- Delete a volume from storageupload_to_storage- Upload a file (ISO, template, etc.) to storagedownload_url_to_storage- Download a file from a URL directly to storage (ISO, template, etc.)get_storage_rrddata- Get RRD statistics for a storage pool (usage over time)prune_storage_backups- Prune (delete) old backups from storage according to retention policylist_file_restore- List files in a backup volume for file-level restore (PBS backups)list_lvm_volumes- List LVM volume groups on a nodecreate_lvm- Create a new LVM volume group on a devicelist_lvmthin_pools- List LVM thin pools on a nodecreate_lvmthin- Create a new LVM thin poollist_zfs_pools- List ZFS pools on a nodeget_zfs_pool- Get details of a ZFS poolcreate_zfs_pool- Create a new ZFS poollist_directory_storage- List directory-based storage mounts on a nodecreate_directory_storage- Create a directory-based storage mount from a deviceinitialize_gpt- Initialize a disk with GPT partition table (WARNING: destroys all data)
Cluster
get_version- Get the Proxmox VE API version informationget_cluster_status- Get cluster status (nodes online, quorum, HA state)get_cluster_resources- List all resources across the cluster (VMs, containers, storage, nodes)get_cluster_tasks- List recent tasks across all nodes in the clusterget_cluster_log- Get the cluster log (recent events)get_next_vmid- Get the next available VMID in the clusterget_cluster_options- Get datacenter/cluster-wide options (keyboard layout, console, language, etc.)update_cluster_options- Update datacenter/cluster-wide optionsget_cluster_config- Get the current cluster configuration (corosync, nodes, join info)get_cluster_config_nodes- List nodes configured in the clusterget_cluster_join_info- Get info needed to join a node to this clusterjoin_cluster- Join a node to an existing clusterget_cluster_totem- Get the corosync totem configurationlist_replication_jobs- List all replication jobs in the clusterget_replication_job- Get a specific replication job configurationcreate_replication_job- Create a storage replication jobdelete_replication_job- Delete a replication joblist_metric_servers- List configured metric servers (InfluxDB, Graphite)get_metric_server- Get metric server configurationlist_notification_endpoints- List all configured notification endpoints (sendmail, gotify, smtp, webhook)list_notification_targets- List all notification targetslist_notification_matchers- List all notification matchers (rules that route notifications)test_notification_target- Send a test notification to a targetbulk_start_guests- Bulk start guests across the clusterbulk_shutdown_guests- Bulk shutdown guests across the clusterbulk_migrate_guests- Bulk migrate guests to a target nodeget_ceph_status_cluster- Get Ceph cluster status (health, monitors, OSDs, PGs)get_ceph_metadata- Get Ceph metadata (versions, services across nodes)get_ceph_flags- Get Ceph global flags (noout, noscrub, etc.)set_ceph_flags- Set a Ceph global flagget_ceph_status_node- Get Ceph status from a specific node's perspectivelist_ceph_osds- List Ceph OSDs on a nodecreate_ceph_osd- Create a new Ceph OSD on a devicelist_ceph_pools- List Ceph poolscreate_ceph_pool- Create a new Ceph poollist_ceph_monitors- List Ceph monitorslist_ceph_managers- List Ceph managerslist_ceph_mds- List Ceph metadata servers (MDS, for CephFS)list_ceph_fs- List CephFS filesystemsget_ceph_config- Get the raw Ceph configurationget_ceph_crush_rules- Get Ceph CRUSH ruleslist_scheduled_jobs- List all scheduled cluster jobslist_realm_sync_jobs- List realm synchronization jobslist_pci_mappings- List PCI device mappings for passthroughlist_usb_mappings- List USB device mappings for passthroughlist_dir_mappings- List directory mappings
Access Control
list_users- List all users in Proxmoxget_user- Get details for a specific usercreate_user- Create a new userupdate_user- Update an existing userdelete_user- Delete a userlist_user_tokens- List API tokens for a userget_user_token- Get details for a specific API tokencreate_user_token- Create a new API token for a user (token value shown only once)delete_user_token- Delete an API tokenlist_groups- List all user groupsget_group- Get group detailscreate_group- Create a new groupupdate_group- Update a groupdelete_group- Delete a grouplist_roles- List all available rolesget_role- Get role details and its privilegescreate_role- Create a new role with specific privilegesupdate_role- Update role privilegesdelete_role- Delete a roleget_acl- Get the full ACL — shows all permission assignmentsupdate_acl- Add or remove ACL entries (permission assignments)list_auth_domains- List configured authentication realms (PAM, PVE, LDAP, AD, OpenID)get_auth_domain- Get authentication domain configurationsync_auth_domain- Sync users/groups from an external auth domain (LDAP/AD)list_tfa- List TFA (two-factor auth) entriesget_permissions- Check effective permissions for a user on a given pathchange_password- Change a user's password
Backup
list_backup_jobs- List all scheduled backup jobs (vzdump) in the clusterget_backup_job- Get details of a specific backup jobget_backup_job_included_volumes- Get volumes included in a backup jobcreate_backup_job- Create a scheduled backup jobupdate_backup_job- Update a scheduled backup jobdelete_backup_job- Delete a scheduled backup jobcreate_vzdump- Start an immediate backup (vzdump) on a nodeget_vzdump_defaults- Get the default vzdump configuration for a nodeget_vzdump_extractconfig- Extract the guest configuration from a vzdump backup archivelist_backup_file_restore- List files in a vzdump backup for single-file restoredownload_file_restore- Download a file from a vzdump backup
Firewall
get_cluster_firewall_options- Get cluster-wide firewall options (enable, policy_in, policy_out, etc.)set_cluster_firewall_options- Set cluster-wide firewall optionslist_cluster_firewall_rules- List cluster-level firewall rulesget_cluster_firewall_rule- Get a specific cluster firewall rulecreate_cluster_firewall_rule- Create a cluster-level firewall ruleupdate_cluster_firewall_rule- Update a cluster-level firewall ruledelete_cluster_firewall_rule- Delete a cluster-level firewall rulelist_firewall_groups- List firewall security groups (reusable sets of rules)get_firewall_group_rules- List rules in a firewall security groupcreate_firewall_group- Create a new firewall security groupcreate_firewall_group_rule- Add a rule to a firewall security grouplist_firewall_aliases- List cluster firewall aliases (named IP addresses/ranges)create_firewall_alias- Create a firewall alias (named IP address or CIDR)delete_firewall_alias- Delete a firewall aliaslist_firewall_ipsets- List cluster firewall IP sets (named groups of IPs)create_firewall_ipset- Create a new firewall IP setlist_firewall_ipset_entries- List entries in a firewall IP setadd_firewall_ipset_entry- Add an IP/CIDR to an IP setdelete_firewall_ipset_entry- Remove an IP/CIDR from an IP setlist_firewall_macros- List available firewall macros (predefined rule sets like SSH, HTTP, etc.)get_firewall_refs- Get available firewall references (aliases, ipsets, names usable in rules)get_node_firewall_options- Get firewall options for a specific nodeset_node_firewall_options- Set firewall options for a nodelist_node_firewall_rules- List firewall rules for a nodeget_node_firewall_log- Get firewall log for a nodeget_vm_firewall_options- Get firewall options for a QEMU VMset_vm_firewall_options- Set firewall options for a QEMU VMlist_vm_firewall_rules- List firewall rules for a QEMU VMcreate_vm_firewall_rule- Create a firewall rule for a QEMU VMget_container_firewall_options- Get firewall options for an LXC containerlist_container_firewall_rules- List firewall rules for an LXC containercreate_container_firewall_rule- Create a firewall rule for an LXC container
High Availability
get_ha_status- Get HA manager status (active, quorum, manager status)get_ha_manager_status- Get detailed HA manager statuslist_ha_resources- List all HA-managed resourcesget_ha_resource- Get HA resource configurationcreate_ha_resource- Add a resource to HA managementupdate_ha_resource- Update an HA resource configurationdelete_ha_resource- Remove a resource from HA managementmigrate_ha_resource- Request migration of an HA resource to a different noderelocate_ha_resource- Request relocation of an HA resource to a different nodelist_ha_groups- List HA groups (define which nodes can run HA resources)get_ha_group- Get HA group configurationcreate_ha_group- Create an HA groupupdate_ha_group- Update an HA groupdelete_ha_group- Delete an HA group
SDN
list_sdn_vnets- List SDN virtual networks (VNets)get_sdn_vnet- Get SDN VNet configurationcreate_sdn_vnet- Create an SDN VNetupdate_sdn_vnet- Update an SDN VNetdelete_sdn_vnet- Delete an SDN VNetlist_sdn_subnets- List subnets for an SDN VNetcreate_sdn_subnet- Create a subnet for an SDN VNetlist_sdn_zones- List SDN zonesget_sdn_zone- Get SDN zone configurationcreate_sdn_zone- Create an SDN zonedelete_sdn_zone- Delete an SDN zonelist_sdn_controllers- List SDN controllers (e.g. EVPN controller)get_sdn_controller- Get SDN controller configurationlist_sdn_ipams- List IPAM (IP Address Management) pluginsget_sdn_ipam- Get IPAM plugin configurationlist_sdn_dns- List SDN DNS pluginsapply_sdn_changes- Apply pending SDN configuration changes to all nodes
Pools & ACME
list_pools- List all resource poolsget_pool- Get pool configuration and memberscreate_pool- Create a resource poolupdate_pool- Update a resource pool (add/remove members)delete_pool- Delete a resource poollist_acme_accounts- List ACME (Let's Encrypt) accountsget_acme_account- Get ACME account detailsregister_acme_account- Register a new ACME accountlist_acme_plugins- List ACME DNS challenge pluginsget_acme_plugin- Get ACME plugin configurationget_acme_directories- List known ACME directory URLsget_acme_tos- Get the ACME Terms of Service URLorder_node_certificate- Order/renew ACME certificate for a nodeget_node_certificates- Get certificate info for a node
Generic
proxmox_api_raw- Make an arbitrary Proxmox API call for any endpoint not covered by specific tools
Proxmox Documentation
For more information about Proxmox VE, refer to the official documentation:
Proxmox VE Documentation: https://pve.proxmox.com/pve-docs/
API Reference: https://pve.proxmox.com/pve-docs/api-viewer/
Proxmox VE Wiki: https://pve.proxmox.com/wiki/Main_Page
proxmoxer Python Library: https://proxmoxer.github.io/docs/
VS Code MCP Config
Add a .vscode/mcp.json file to your workspace. Choose the approach that fits your setup.
Docker (environment variables)
Recommended when running via Docker. Configuration is passed through environment variables.
{
"servers": {
"proxmox": {
"command": "docker",
"args": [
"run", "-i", "--rm",
"-e", "PROXMOX_HOST",
"-e", "PROXMOX_PORT",
"-e", "PROXMOX_USER",
"-e", "PROXMOX_TOKEN_NAME",
"-e", "PROXMOX_TOKEN_VALUE",
"-e", "PROXMOX_VERIFY_SSL",
"-e", "PROXMOX_TIMEOUT",
"-e", "TOOL_ROUTING",
"-e", "ROUTER_TOP_K",
"-e", "PROXMOX_READ_ONLY",
"-e", "PROXMOX_DISABLE_RAW_API",
"mcp/proxmox"
],
"env": {
"PROXMOX_HOST": "192.168.1.100",
"PROXMOX_PORT": "8006",
"PROXMOX_USER": "root@pam",
"PROXMOX_TOKEN_NAME": "mcp",
"PROXMOX_TOKEN_VALUE": "your-token-here",
"PROXMOX_VERIFY_SSL": "0"
}
}
}
}Python via uvx (environment variables)
Recommended when running from PyPI via uvx. No local install required — uvx fetches and runs the package automatically.
{
"servers": {
"proxmox": {
"command": "uvx",
"args": ["proxmox-mcp-server"],
"env": {
"PROXMOX_HOST": "192.168.1.100",
"PROXMOX_PORT": "8006",
"PROXMOX_USER": "root@pam",
"PROXMOX_TOKEN_NAME": "mcp",
"PROXMOX_TOKEN_VALUE": "your-token-here",
"PROXMOX_VERIFY_SSL": "0"
}
}
}
}Configuration Options
Option | Environment Variable | Default |
Proxmox host |
| — |
API port |
|
|
User |
|
|
API token name |
| — |
API token value |
| — |
Password |
| — |
SSL verification |
|
|
Request timeout (seconds) |
|
|
Semantic tool routing |
|
|
Routed tool result count |
|
|
Read-only mode |
|
|
Disable raw API tool |
|
|
Either PROXMOX_TOKEN_NAME + PROXMOX_TOKEN_VALUE or PROXMOX_PASSWORD is required for authentication.
When TOOL_ROUTING is set to true, the server uses manifest-backed semantic tool routing. MCP clients only see 3 tools — route_tools, call_routed_tool, and proxmox_api_raw — while domain tool modules are imported and registered lazily only when call_routed_tool invokes one of their tools. Use route_tools with a natural-language query to find relevant tools, then invoke them via call_routed_tool. This significantly reduces LLM context usage and routed-mode startup work. Requires the router extra (pip install proxmox-mcp-server[router]). Docker images include this extra.
Set ROUTER_TOP_K to control how many candidate tools route_tools returns. Lower values save more response context; higher values improve recall for broad queries.
Set PROXMOX_READ_ONLY=true to block all non-GET Proxmox API operations. Set PROXMOX_DISABLE_RAW_API=true to keep the generic proxmox_api_raw escape-hatch visible but unavailable at runtime.
Development
Running Tests
Install development dependencies:
pip install -e ".[dev]"Run the test suite:
pytest tests/ -vRegenerate the routed-mode tool manifest after adding, removing, or changing tool signatures:
python scripts/generate_tool_manifest.py
python scripts/generate_tool_manifest.py --checkBuilding the Docker Image
docker build -t mcp/proxmox:latest .License
Apache-2.0
Available Tools
286 toolsadd_firewall_ipset_entryB
Add an IP/CIDR to an IP set.
Args: name: IP set name. cidr: IP address or CIDR. comment: Description. nomatch: Exclude this entry (nomatch).
Inputs: cidr (required), name (required), comment, nomatch. Returns: result
allocate_storage_volumeA
Allocate a new disk volume in storage.
Args: node: The node name. storage: The storage ID. vmid: VM ID to associate with. filename: Volume name. size: Volume size (e.g. '10G'). format: Disk format (raw, qcow2, vmdk). Auto-detected if empty.
Inputs: node (required), size (required), vmid (required), storage (required), +2 more. Returns: result
apply_sdn_changesA
Apply pending SDN configuration changes to all nodes.
Inputs: no named parameters. Returns: result
bulk_migrate_guestsC
Bulk migrate guests to a target node.
Args: target: Target node name. vms: Comma-separated VMIDs.
Inputs: target (required), vms. Returns: result
bulk_shutdown_guestsB
Bulk shutdown guests across the cluster.
Args: vms: Comma-separated list of VMIDs (empty = all).
Inputs: vms. Returns: result
bulk_start_guestsA
Bulk start guests across the cluster.
Args: vms: Comma-separated list of VMIDs (empty = all).
Inputs: vms. Returns: result
change_passwordC
Change a user's password.
Args: userid: User ID (format: 'user@realm'). password: New password.
Inputs: userid (required), password (required). Returns: result
clone_containerC
Clone a container.
Args: node: The source node name. vmid: The source container ID. newid: ID for the new container. hostname: Hostname for the clone. target: Target node (default: same node). full: Full clone (True) or linked clone (False). storage: Target storage for full clone. description: Description. pool: Resource pool. snapname: Snapshot to clone from.
Inputs: node (required), vmid (required), newid (required), full, +6 more. Returns: result
clone_vmA
Clone a VM to create a new one. Can be a full copy or linked clone.
Args: node: The source node name. vmid: The source VM ID. newid: The VMID for the new clone. name: Name for the clone. target: Target node for the clone (default: same node). full: Full clone (True) or linked clone (False). storage: Target storage for full clone. description: Description for the clone. pool: Resource pool. snapname: Snapshot name to clone from.
Inputs: node (required), vmid (required), newid (required), full, +6 more. Returns: result
convert_container_to_templateA
Convert a container into a template (irreversible).
Args: node: The node name. vmid: The container ID.
Inputs: node (required), vmid (required). Returns: result
convert_vm_to_templateA
Convert a VM into a template (irreversible).
Args: node: The node name. vmid: The VM ID.
Inputs: node (required), vmid (required). Returns: result
create_backup_jobB
Create a scheduled backup job.
Args: storage: Target storage ID for backups. schedule: Schedule in systemd calendar format (e.g. 'daily', 'weekly', '02:00'). all_guests: Backup all guests. vmid: Comma-separated VMIDs to back up (if not all_guests). node: Only back up guests on this node. mode: Backup mode: 'snapshot', 'suspend', 'stop'. compress: Compression: 'none', 'lzo', 'gzip', 'zstd'. mailnotification: 'always' or 'failure'. mailto: Comma-separated email addresses. maxfiles: Max backup files to keep (0 = unlimited, deprecated - use prune_backups). prune_backups: Retention schedule (e.g. 'keep-daily=7,keep-weekly=4'). notes_template: Template for backup notes. enabled: Enable the job. comment: Description.
Inputs: storage (required), mode, node, vmid, +10 more. Returns: result
create_ceph_osdA
Create a new Ceph OSD on a device.
Args: node: The node name. dev: Block device for the OSD (e.g. '/dev/sdb'). db_dev: Separate block device for DB. wal_dev: Separate block device for WAL. encrypted: Encrypt the OSD.
Inputs: dev (required), node (required), db_dev, wal_dev, +1 more. Returns: result
create_ceph_poolB
Create a new Ceph pool.
Args: node: The node name. name: Pool name. size: Number of replicas (default 3). min_size: Minimum replicas for I/O (default 2). pg_num: Number of placement groups (default 128). application: Pool application (rbd, cephfs, rgw).
Inputs: name (required), node (required), size, pg_num, +2 more. Returns: result
create_cluster_firewall_ruleA
Create a cluster-level firewall rule.
Args: action: 'ACCEPT', 'DROP', 'REJECT'. type: 'in', 'out', 'group'. enable: 1 = enabled, 0 = disabled. source: Source address/range (CIDR or alias). dest: Destination address/range. proto: Protocol (tcp, udp, icmp, etc.). sport: Source port(s). dport: Destination port(s). iface: Network interface. macro: Use predefined macro (e.g. 'SSH', 'HTTP', 'HTTPS', 'Ping'). comment: Description. log: Log level: 'emerg', 'alert', 'crit', 'err', 'warning', 'notice', 'info', 'debug', 'nolog'. pos: Rule position (-1 = append).
Inputs: type (required), action (required), log, pos, +9 more. Returns: result
create_containerB
Create a new LXC container.
Args: node: The node name. vmid: The container ID. ostemplate: Template volume (e.g. 'local:vztmpl/debian-12-standard_12.2-1_amd64.tar.zst'). hostname: Container hostname. password: Root password. ssh_public_keys: SSH public keys (newline delimited). storage: Storage for rootfs (default 'local'). rootfs: Root filesystem spec (e.g. 'local-lvm:8' for 8GB). memory: Memory in MB (default 512). swap: Swap in MB (default 512). cores: CPU cores (default 1). cpulimit: CPU limit (0 = unlimited). net0: Network config (e.g. 'name=eth0,bridge=vmbr0,ip=dhcp'). nameserver: DNS nameserver. searchdomain: DNS search domain. onboot: Start on host boot. start: Start after creation. unprivileged: Create an unprivileged container (default True, recommended). features: Comma-separated features (e.g. 'nesting=1,keyctl=1'). description: Container description. pool: Resource pool. tags: Tags for the container. mp0: Mount point (e.g. 'local-lvm:4,mp=/mnt/data').
Inputs: node (required), vmid (required), ostemplate (required), mp0, +19 more. Returns: result
create_container_firewall_ruleA
Create a firewall rule for an LXC container.
Args: node: The node name. vmid: The container ID. action: 'ACCEPT', 'DROP', 'REJECT'. type: 'in', 'out', 'group'. enable: 1 = enabled, 0 = disabled. source: Source CIDR or alias. dest: Destination CIDR or alias. proto: Protocol. dport: Destination port(s). macro: Predefined macro. comment: Description.
Inputs: node (required), type (required), vmid (required), action (required), +7 more. Returns: result
create_container_snapshotB
Create a snapshot of a container.
Args: node: The node name. vmid: The container ID. snapname: Snapshot name. description: Snapshot description.
Inputs: node (required), vmid (required), snapname (required), description. Returns: result
create_directory_storageA
Create a directory-based storage mount from a device.
Args: node: The node name. name: Storage name. device: Block device path. filesystem: Filesystem type (ext4, xfs). add_to_storage: Auto-add as Proxmox storage.
Inputs: name (required), node (required), device (required), filesystem, +1 more. Returns: result
create_firewall_aliasB
Create a firewall alias (named IP address or CIDR).
Args: name: Alias name. cidr: IP address or CIDR (e.g. '10.0.0.0/24' or '192.168.1.1'). comment: Description.
Inputs: cidr (required), name (required), comment. Returns: result
create_firewall_groupC
Create a new firewall security group.
Args: group: Group name. comment: Description.
Inputs: group (required), comment. Returns: result
create_firewall_group_ruleB
Add a rule to a firewall security group.
Args: group: Security group name. action: 'ACCEPT', 'DROP', 'REJECT'. type: 'in', 'out'. enable: 1 = enabled, 0 = disabled. source: Source address/range. dest: Destination address/range. proto: Protocol. sport: Source port(s). dport: Destination port(s). macro: Predefined macro. comment: Description.
Inputs: type (required), group (required), action (required), dest, +7 more. Returns: result
create_firewall_ipsetC
Create a new firewall IP set.
Args: name: IP set name. comment: Description.
Inputs: name (required), comment. Returns: result
create_groupC
Create a new group.
Args: groupid: Group ID. comment: Description.
Inputs: groupid (required), comment. Returns: result
create_ha_groupA
Create an HA group.
Args: group: Group ID. nodes: Node list with optional priority (e.g. 'node1:2,node2:1' — higher = preferred). nofailback: If true, don't fail back to higher-priority nodes once recovered. restricted: Only run on nodes in this group (otherwise runs anywhere but prefers group nodes). comment: Description.
Inputs: group (required), nodes (required), comment, nofailback, +1 more. Returns: result
create_ha_resourceA
Add a resource to HA management.
Args: sid: Resource ID (format: 'type:vmid', e.g. 'vm:100' or 'ct:101'). group: HA group name. max_relocate: Max relocations on failure. max_restart: Max restarts on failure. state: Desired state: 'started', 'stopped', 'enabled', 'disabled', 'ignored'. comment: Description.
Inputs: sid (required), group, state, comment, +2 more. Returns: result
create_lvmC
Create a new LVM volume group on a device.
Args: node: The node name. name: VG name. device: Block device path (e.g. '/dev/sdb'). add_to_storage: Auto-add as Proxmox storage.
Inputs: name (required), node (required), device (required), add_to_storage. Returns: result
create_lvmthinA
Create a new LVM thin pool.
Args: node: The node name. name: Thin pool name. device: Block device path. add_to_storage: Auto-add as Proxmox storage.
Inputs: name (required), node (required), device (required), add_to_storage. Returns: result
create_node_network_interfaceB
Create a network interface on a node.
Args: node: The node name. iface: Interface name (e.g. 'vmbr1'). type: Interface type (bridge, bond, eth, alias, vlan, OVSBridge, OVSPort, OVSIntPort, OVSBond). address: IP address (CIDR notation or IP). netmask: Subnet mask. gateway: Default gateway. bridge_ports: Bridge ports (for bridge type). autostart: Whether to start on boot. comments: Comments for the interface.
Inputs: node (required), type (required), iface (required), address, +5 more. Returns: result
create_poolC
Create a resource pool.
Args: poolid: Pool ID. comment: Description.
Inputs: poolid (required), comment. Returns: result
create_replication_jobA
Create a storage replication job.
Args: id: Job ID (format: GUEST-JOBNUM, e.g. '100-0'). target: Target node. type: Replication type (currently only 'local'). schedule: Schedule in systemd calendar format (default '*/15' = every 15 min). comment: Description. rate: Rate limit in mbps. disable: Create disabled.
Inputs: id (required), target (required), rate, type, +3 more. Returns: result
create_roleC
Create a new role with specific privileges.
Args: roleid: Role ID. privs: Comma-separated list of privileges (e.g. 'VM.Allocate,VM.Config.Disk,VM.PowerMgmt').
Inputs: privs (required), roleid (required). Returns: result
create_sdn_subnetC
Create a subnet for an SDN VNet.
Args: vnet: VNet ID. subnet: Subnet CIDR (e.g. '10.0.0.0/24'). gateway: Gateway IP. snat: Enable SNAT. dnszoneprefix: DNS zone prefix.
Inputs: vnet (required), subnet (required), snat, gateway, +1 more. Returns: result
create_sdn_vnetC
Create an SDN VNet.
Args: vnet: VNet ID. zone: Zone ID. tag: VLAN tag. alias: Display alias. vlanaware: Enable VLAN-aware bridge.
Inputs: vnet (required), zone (required), tag, alias, +1 more. Returns: result
create_sdn_zoneB
Create an SDN zone.
Args: zone: Zone ID. type: Zone type: 'simple', 'vlan', 'qinq', 'vxlan', 'evpn'. nodes: Comma-separated node list. ipam: IPAM plugin name. dns: DNS plugin name. bridge: Bridge name. mtu: MTU.
Inputs: type (required), zone (required), dns, mtu, +3 more. Returns: result
create_storageC
Create a new storage pool configuration.
Args: storage: Storage ID. type: Storage type: dir, lvm, lvmthin, zfspool, nfs, cifs, iscsi, rbd, cephfs, pbs, glusterfs, btrfs. path: File system path (for dir, nfs mounts). server: Server IP/hostname (for nfs, cifs, iscsi, pbs, glusterfs, rbd, cephfs). export: NFS export path. vgname: LVM volume group name. thinpool: LVM thin pool name (for lvmthin). pool: Pool name (for Ceph RBD/CephFS, ZFS). portal: iSCSI portal. target: iSCSI target. datastore: PBS datastore name. content: Comma-separated content types (images, rootdir, vztmpl, iso, backup, snippets, import). nodes: Restrict storage to these nodes (comma-separated). shared: Mark as shared storage. disable: Create disabled. maxfiles: Max backup files (0 = unlimited). prune_backups: Backup retention policy.
Inputs: type (required), storage (required), path, pool, +13 more. Returns: result
create_userA
Create a new user.
Args: userid: User ID (format: 'user@realm', e.g. 'myuser@pve'). password: Password (only for pve/pam realms). email: Email address. firstname: First name. lastname: Last name. groups: Comma-separated group list. comment: Description. enable: Enable user. expire: Account expiration (Unix epoch, 0 = never).
Inputs: userid (required), email, enable, expire, +5 more. Returns: result
create_user_tokenA
Create a new API token for a user. Returns the token value (shown only once).
Args: userid: User ID (format: 'user@realm'). tokenid: Token ID (alphanumeric). comment: Token description. privsep: Enable privilege separation (token has own permissions, not user's full permissions). expire: Expiration (Unix epoch, 0 = never).
Inputs: userid (required), tokenid (required), expire, comment, +1 more. Returns: result
create_vmA
Create a new QEMU virtual machine.
Args: node: The node name. vmid: The VM ID number. name: VM name. memory: Memory in MB (default 2048). cores: Number of CPU cores per socket (default 1). sockets: Number of CPU sockets (default 1). cpu: CPU type (default 'host'). ostype: OS type: l26 (Linux 2.6+), win10, win11, wxp, other, etc. scsihw: SCSI controller: virtio-scsi-single, virtio-scsi-pci, lsi, megasas, pvscsi. scsi0: First SCSI disk (e.g. 'local-lvm:32' for 32GB on local-lvm). ide2: IDE device, often used for CD-ROM (e.g. 'local:iso/ubuntu.iso,media=cdrom'). net0: Network device (e.g. 'virtio,bridge=vmbr0'). boot: Boot order, for example scsi0 then ide2 then net0. bios: BIOS type: seabios, ovmf (UEFI). machine: Machine type (e.g. 'q35', 'i440fx'). cdrom: CD-ROM ISO image path. agent: QEMU guest agent: '1' to enable, 'enabled=1,fstrim_cloned_disks=1'. start: Start the VM after creation. onboot: Start on host boot. description: VM description. pool: Resource pool to add the VM to. tags: Tags for the VM.
Inputs: node (required), vmid (required), cpu, bios, +18 more. Returns: result
create_vm_firewall_ruleA
Create a firewall rule for a QEMU VM.
Args: node: The node name. vmid: The VM ID. action: 'ACCEPT', 'DROP', 'REJECT'. type: 'in', 'out', 'group'. enable: 1 = enabled, 0 = disabled. source: Source CIDR or alias. dest: Destination CIDR or alias. proto: Protocol. dport: Destination port(s). macro: Predefined macro. comment: Description.
Inputs: node (required), type (required), vmid (required), action (required), +7 more. Returns: result
create_vm_snapshotC
Create a snapshot of a VM.
Args: node: The node name. vmid: The VM ID. snapname: Snapshot name. description: Snapshot description. vmstate: Include RAM state (for running VMs).
Inputs: node (required), vmid (required), snapname (required), vmstate, +1 more. Returns: result
create_vzdumpA
Start an immediate backup (vzdump) on a node.
Args: node: The node to run the backup on. vmid: Comma-separated VMIDs (required if not all_guests). all_guests: Back up all guests on the node. storage: Target storage (empty = default). mode: Backup mode: 'snapshot', 'suspend', 'stop'. compress: Compression: 'none', 'lzo', 'gzip', 'zstd'. stdout: Write to stdout instead of storage.
Inputs: node (required), mode, vmid, stdout, +3 more. Returns: result
create_zfs_poolB
Create a new ZFS pool.
Args: node: The node name. name: Pool name. raidlevel: RAID level: single, mirror, raid10, raidz, raidz2, raidz3, draid, draid2, draid3. devices: Space-separated device paths (e.g. '/dev/sdb /dev/sdc'). add_to_storage: Auto-add as Proxmox storage. ashift: ashift value (default 12). compression: Compression (on, off, lz4, zstd, etc.).
Inputs: name (required), node (required), devices (required), raidlevel (required), +3 more. Returns: result
delete_backup_jobB
Delete a scheduled backup job.
Args: id: Backup job ID.
Inputs: id (required). Returns: result
delete_cluster_firewall_ruleB
Delete a cluster-level firewall rule.
Args: pos: Rule position to delete.
Inputs: pos (required). Returns: result
delete_containerA
Delete a container. Must be stopped first unless force=True.
Args: node: The node name. vmid: The container ID. purge: Remove from replication, HA, backup and ACLs too. destroy_unreferenced_disks: Destroy unreferenced disks. force: Force destroy even if running.
Inputs: node (required), vmid (required), force, purge, +1 more. Returns: result
delete_container_snapshotC
Delete a container snapshot.
Args: node: The node name. vmid: The container ID. snapname: Snapshot name. force: Force delete.
Inputs: node (required), vmid (required), snapname (required), force. Returns: result
delete_firewall_aliasC
Delete a firewall alias.
Args: name: Alias name.
Inputs: name (required). Returns: result
delete_firewall_ipset_entryA
Remove an IP/CIDR from an IP set.
Args: name: IP set name. cidr: IP address or CIDR to remove.
Inputs: cidr (required), name (required). Returns: result
delete_groupC
Delete a group.
Args: groupid: Group ID.
Inputs: groupid (required). Returns: result
delete_ha_groupC
Delete an HA group.
Args: group: Group ID.
Inputs: group (required). Returns: result
delete_ha_resourceB
Remove a resource from HA management.
Args: sid: Resource ID (format: 'type:vmid').
Inputs: sid (required). Returns: result
delete_poolC
Delete a resource pool.
Args: poolid: Pool ID.
Inputs: poolid (required). Returns: result
delete_replication_jobB
Delete a replication job.
Args: id: Replication job ID. force: Force removal (skip cleanup). keep: Keep replicated data on target.
Inputs: id (required), keep, force. Returns: result
delete_roleC
Delete a role.
Args: roleid: Role ID.
Inputs: roleid (required). Returns: result
delete_sdn_vnetC
Delete an SDN VNet.
Args: vnet: VNet ID.
Inputs: vnet (required). Returns: result
delete_sdn_zoneC
Delete an SDN zone.
Args: zone: Zone ID.
Inputs: zone (required). Returns: result
delete_storageA
Delete a storage pool configuration (does not delete data on the backend).
Args: storage: The storage ID.
Inputs: storage (required). Returns: result
delete_storage_volumeC
Delete a volume from storage.
Args: node: The node name. storage: The storage ID. volume: The volume ID.
Inputs: node (required), volume (required), storage (required). Returns: result
delete_userB
Delete a user.
Args: userid: User ID to delete (format: 'user@realm').
Inputs: userid (required). Returns: result
delete_user_tokenB
Delete an API token.
Args: userid: User ID (format: 'user@realm'). tokenid: Token ID.
Inputs: userid (required), tokenid (required). Returns: result
delete_vmA
Delete a VM. The VM must be stopped first.
Args: node: The node name. vmid: The VM ID. purge: Remove from replication, HA, backup jobs and ACLs too. destroy_unreferenced_disks: Also destroy unreferenced disks owned by the VM.
Inputs: node (required), vmid (required), purge, destroy_unreferenced_disks. Returns: result
delete_vm_snapshotC
Delete a VM snapshot.
Args: node: The node name. vmid: The VM ID. snapname: Snapshot name to delete. force: Force delete even if snapshot is in use.
Inputs: node (required), vmid (required), snapname (required), force. Returns: result
download_appliance_templateB
Download an appliance template to local storage.
Args: node: The node name. storage: Target storage ID. template: Template name to download.
Inputs: node (required), storage (required), template (required). Returns: result
download_file_restoreC
Download a file from a vzdump backup.
Args: node: The node name. storage: Storage ID. volume: Backup volume ID. filepath: Path of the file to download from the backup.
Inputs: node (required), volume (required), storage (required), filepath (required). Returns: result
download_url_to_storageB
Download a file from a URL directly to storage (ISO, template, etc.).
Args: node: The node name. storage: The storage ID. url: URL to download from. content: Content type: 'iso', 'vztmpl'. filename: Target filename. checksum: Expected checksum. checksum_algorithm: Checksum algorithm (sha256, sha512, md5).
Inputs: url (required), node (required), content (required), storage (required), +3 more. Returns: result
dump_vm_cloudinitB
Dump the Cloud-Init generated config file (user-data, network-data, or meta-data).
Args: node: The node name. vmid: The VM ID. type: Config type: 'user', 'network', or 'meta'.
Inputs: node (required), vmid (required), type. Returns: result
get_aclA
Get the full ACL (access control list) — shows all permission assignments.
Inputs: no named parameters. Returns: result
get_acme_accountA
Get ACME account details.
Args: name: Account name (default: 'default').
Inputs: name. Returns: result
get_acme_directoriesA
List known ACME directory URLs.
Inputs: no named parameters. Returns: result
get_acme_pluginB
Get ACME plugin configuration.
Args: id: Plugin ID.
Inputs: id (required). Returns: result
get_acme_tosA
Get the ACME Terms of Service URL.
Inputs: no named parameters. Returns: result
get_auth_domainB
Get authentication domain configuration.
Args: realm: Realm ID (e.g. 'pam', 'pve', 'my-ldap').
Inputs: realm (required). Returns: result
get_backup_jobC
Get details of a specific backup job.
Args: id: Backup job ID.
Inputs: id (required). Returns: result
get_backup_job_included_volumesB
Get volumes included in a backup job.
Args: id: Backup job ID.
Inputs: id (required). Returns: result
get_ceph_configC
Get the raw Ceph configuration.
Args: node: The node name.
Inputs: node (required). Returns: result
get_ceph_crush_rulesC
Get Ceph CRUSH rules.
Args: node: The node name.
Inputs: node (required). Returns: result
get_ceph_flagsA
Get Ceph global flags (noout, noscrub, etc.).
Inputs: no named parameters. Returns: result
get_ceph_metadataA
Get Ceph metadata (versions, services across nodes).
Inputs: no named parameters. Returns: result
get_ceph_status_clusterA
Get Ceph cluster status (health, monitors, OSDs, PGs).
Inputs: no named parameters. Returns: result
get_ceph_status_nodeB
Get Ceph status from a specific node's perspective.
Args: node: The node name.
Inputs: node (required). Returns: result
get_cluster_configA
Get the current cluster configuration (corosync, nodes, join info).
Inputs: no named parameters. Returns: result
get_cluster_config_nodesB
List nodes configured in the cluster.
Inputs: no named parameters. Returns: result
get_cluster_firewall_optionsA
Get cluster-wide firewall options (enable, policy_in, policy_out, etc.).
Inputs: no named parameters. Returns: result
get_cluster_firewall_ruleB
Get a specific cluster firewall rule.
Args: pos: Rule position number.
Inputs: pos (required). Returns: result
get_cluster_join_infoA
Get info needed to join a node to this cluster.
Inputs: no named parameters. Returns: result
get_cluster_logC
Get the cluster log (recent events).
Args: max_entries: Max log entries.
Inputs: max_entries. Returns: result
get_cluster_optionsA
Get datacenter/cluster-wide options (keyboard layout, console, language, etc.).
Inputs: no named parameters. Returns: result
get_cluster_resourcesA
List all resources across the cluster (VMs, containers, storage, nodes).
Args: type: Filter by type: 'vm', 'storage', 'node', 'sdn', 'pool' (empty = all).
Inputs: type. Returns: result
get_cluster_statusB
Get cluster status (nodes online, quorum, HA state).
Inputs: no named parameters. Returns: result
get_cluster_tasksC
List recent tasks across all nodes in the cluster.
Args: limit: Maximum number of tasks to return.
Inputs: limit. Returns: result
get_cluster_totemB
Get the corosync totem configuration.
Inputs: no named parameters. Returns: result
get_container_configB
Get the configuration of a container.
Args: node: The node name. vmid: The container ID.
Inputs: node (required), vmid (required). Returns: result
get_container_featureA
Check if a feature is available for a container (snapshot, clone, copy).
Args: node: The node name. vmid: The container ID. feature: Feature to check ('snapshot', 'clone', 'copy').
Inputs: node (required), vmid (required), feature (required). Returns: result
get_container_firewall_optionsB
Get firewall options for an LXC container.
Args: node: The node name. vmid: The container ID.
Inputs: node (required), vmid (required). Returns: result
get_container_interfacesC
Get network interfaces and IPs of a running container.
Args: node: The node name. vmid: The container ID.
Inputs: node (required), vmid (required). Returns: result
get_container_pendingA
Get pending configuration changes for a container.
Args: node: The node name. vmid: The container ID.
Inputs: node (required), vmid (required). Returns: result
get_container_rrddataA
Get RRD statistics data for a container (CPU, memory, disk, network over time).
Args: node: The node name. vmid: The container ID. timeframe: Time range: 'hour', 'day', 'week', 'month', 'year'.
Inputs: node (required), vmid (required), timeframe. Returns: result
get_container_statusB
Get the current runtime status of a container.
Args: node: The node name. vmid: The container ID (CTID).
Inputs: node (required), vmid (required). Returns: result
get_disk_smartC
Get S.M.A.R.T. health data for a disk.
Args: node: The node name. disk: Disk device path (e.g. '/dev/sda').
Inputs: disk (required), node (required). Returns: result
get_firewall_group_rulesB
List rules in a firewall security group.
Args: group: Security group name.
Inputs: group (required). Returns: result
get_firewall_refsA
Get available firewall references (aliases, ipsets, names usable in rules).
Inputs: no named parameters. Returns: result
get_groupB
Get group details.
Args: groupid: Group ID.
Inputs: groupid (required). Returns: result
get_ha_groupC
Get HA group configuration.
Args: group: Group ID.
Inputs: group (required). Returns: result
get_ha_manager_statusC
Get detailed HA manager status.
Inputs: no named parameters. Returns: result
get_ha_resourceA
Get HA resource configuration.
Args: sid: HA resource ID (format: 'type:vmid', e.g. 'vm:100' or 'ct:101').
Inputs: sid (required). Returns: result
get_ha_statusA
Get HA manager status (active, quorum, manager status).
Inputs: no named parameters. Returns: result
get_metric_serverB
Get metric server configuration.
Args: id: Metric server ID.
Inputs: id (required). Returns: result
get_next_vmidA
Get the next available VMID in the cluster.
Args: vmid: Specific VMID to check availability for (0 = auto-assign).
Inputs: vmid. Returns: result
get_node_aplinfoA
List available appliance templates (LXC templates) that can be downloaded.
Args: node: The node name.
Inputs: node (required). Returns: result
get_node_apt_updateC
List available package updates on a node.
Args: node: The node name.
Inputs: node (required). Returns: result
get_node_capabilities_qemuC
Get QEMU capabilities for a node: supported CPU models, machine types, etc.
Args: node: The node name.
Inputs: node (required). Returns: result
get_node_certificatesC
Get certificate info for a node.
Args: node: The node name.
Inputs: node (required). Returns: result
get_node_configC
Get the configuration of a node (description, wakeonlan, etc.).
Args: node: The node name.
Inputs: node (required). Returns: result
get_node_disksC
List physical disks on a node.
Args: node: The node name.
Inputs: node (required). Returns: result
get_node_dnsC
Get DNS settings for a node.
Args: node: The node name.
Inputs: node (required). Returns: result
get_node_firewall_logB
Get firewall log for a node.
Args: node: The node name. limit: Max entries.
Inputs: node (required), limit. Returns: result
get_node_firewall_optionsC
Get firewall options for a specific node.
Args: node: The node name.
Inputs: node (required). Returns: result
get_node_hardware_pciB
List PCI hardware devices on a node (for passthrough).
Args: node: The node name.
Inputs: node (required). Returns: result
get_node_hardware_usbC
List USB hardware devices on a node.
Args: node: The node name.
Inputs: node (required). Returns: result
get_node_hostsB
Get the /etc/hosts file content for a node.
Args: node: The node name.
Inputs: node (required). Returns: result
get_node_journalB
Read systemd journal entries from a node.
Args: node: The node name. lastentries: Max number of entries (default 50). since: Show entries since date/time. until: Show entries until date/time. startcursor: Start cursor for paging.
Inputs: node (required), since, until, lastentries, +1 more. Returns: result
get_node_netstatC
Get network statistics for a node (per-interface traffic).
Args: node: The node name.
Inputs: node (required). Returns: result
get_node_networkC
Get network interface configuration for a node.
Args: node: The node name.
Inputs: node (required). Returns: result
get_node_network_interfaceB
Get details for a specific network interface.
Args: node: The node name. iface: Interface name (e.g. 'vmbr0', 'eth0').
Inputs: node (required), iface (required). Returns: result
get_node_reportC
Generate a system report for a node (useful for diagnostics).
Args: node: The node name.
Inputs: node (required). Returns: result
get_node_statusA
Get detailed status of a specific node including CPU, memory, disk, uptime, and kernel info.
Args: node: The node name (e.g. 'pve1').
Inputs: node (required). Returns: result
get_node_storage_scanA
Scan for available storage targets (NFS, CIFS, iSCSI, LVM, ZFS, PBS).
Args: node: The node name. scan_type: Type to scan: 'nfs', 'cifs', 'iscsi', 'lvm', 'lvmthin', 'zfs', 'pbs'. server: Server address (required for nfs, cifs, iscsi, pbs).
Inputs: node (required), scan_type (required), server. Returns: result
get_node_storage_statusB
Get usage status of a storage pool on a node (total, used, available).
Args: node: The node name. storage: The storage ID.
Inputs: node (required), storage (required). Returns: result
get_node_subscriptionC
Get subscription status for a node.
Args: node: The node name.
Inputs: node (required). Returns: result
get_node_syslogA
Read system log (syslog) entries from a node.
Args: node: The node name. limit: Max number of log lines to return (default 50). start: Start line number. since: Only show entries since this date (YYYY-MM-DD). until: Only show entries until this date (YYYY-MM-DD).
Inputs: node (required), limit, since, start, +1 more. Returns: result
get_node_timeB
Get the current time and timezone of a node.
Args: node: The node name.
Inputs: node (required). Returns: result
get_node_versionB
Get Proxmox VE version information for a specific node.
Args: node: The node name.
Inputs: node (required). Returns: result
get_permissionsB
Check effective permissions for a user on a given path.
Args: userid: User to check (empty = current user). path: Object path to check (empty = root).
Inputs: path, userid. Returns: result
get_poolC
Get pool configuration and members.
Args: poolid: Pool ID.
Inputs: poolid (required). Returns: result
get_replication_jobA
Get a specific replication job configuration.
Args: id: Replication job ID (format: GUEST-JOBNUM, e.g. '100-0').
Inputs: id (required). Returns: result
get_roleB
Get role details and its privileges.
Args: roleid: Role ID.
Inputs: roleid (required). Returns: result
get_sdn_controllerC
Get SDN controller configuration.
Args: controller: Controller ID.
Inputs: controller (required). Returns: result
get_sdn_ipamC
Get IPAM plugin configuration.
Args: ipam: IPAM ID.
Inputs: ipam (required). Returns: result
get_sdn_vnetB
Get SDN VNet configuration.
Args: vnet: VNet ID.
Inputs: vnet (required). Returns: result
get_sdn_zoneB
Get SDN zone configuration.
Args: zone: Zone ID.
Inputs: zone (required). Returns: result
get_storage_configA
Get configuration of a specific storage pool.
Args: storage: The storage ID.
Inputs: storage (required). Returns: result
get_storage_rrddataA
Get RRD statistics for a storage pool (usage over time).
Args: node: The node name. storage: The storage ID. timeframe: Time range: 'hour', 'day', 'week', 'month', 'year'.
Inputs: node (required), storage (required), timeframe. Returns: result
get_storage_volume_infoC
Get details about a specific volume in storage.
Args: node: The node name. storage: The storage ID. volume: The volume ID.
Inputs: node (required), volume (required), storage (required). Returns: result
get_task_logB
Get log output of a specific task.
Args: node: The node name. upid: The task UPID string. limit: Max lines to return. start: Start line number.
Inputs: node (required), upid (required), limit, start. Returns: result
get_task_statusB
Get the status of a specific task by its UPID.
Args: node: The node name. upid: The task UPID string.
Inputs: node (required), upid (required). Returns: result
get_userA
Get details for a specific user.
Args: userid: User ID (format: 'user@realm', e.g. 'admin@pam').
Inputs: userid (required). Returns: result
get_user_tokenA
Get details for a specific API token.
Args: userid: User ID (format: 'user@realm'). tokenid: Token ID.
Inputs: userid (required), tokenid (required). Returns: result
get_versionA
Get the Proxmox VE API version information.
Inputs: no named parameters. Returns: result
get_vm_cloudinitC
Get Cloud-Init configuration for a VM.
Args: node: The node name. vmid: The VM ID.
Inputs: node (required), vmid (required). Returns: result
get_vm_configA
Get the configuration of a VM.
Args: node: The node name. vmid: The VM ID. current: If True, return current (runtime) config. If False, return pending config.
Inputs: node (required), vmid (required), current. Returns: result
get_vm_featureA
Check if a specific feature is available/supported for a VM (e.g. snapshot, clone, copy).
Args: node: The node name. vmid: The VM ID. feature: Feature to check ('snapshot', 'clone', 'copy').
Inputs: node (required), vmid (required), feature (required). Returns: result
get_vm_firewall_optionsC
Get firewall options for a QEMU VM.
Args: node: The node name. vmid: The VM ID.
Inputs: node (required), vmid (required). Returns: result
get_vm_pendingA
Get pending configuration changes for a VM (not yet applied).
Args: node: The node name. vmid: The VM ID.
Inputs: node (required), vmid (required). Returns: result
get_vm_rrddataA
Get RRD statistics data for a VM (CPU, memory, disk, network over time).
Args: node: The node name. vmid: The VM ID. timeframe: Time range: 'hour', 'day', 'week', 'month', 'year'.
Inputs: node (required), vmid (required), timeframe. Returns: result
get_vm_snapshot_configC
Get the configuration stored in a VM snapshot.
Args: node: The node name. vmid: The VM ID. snapname: The snapshot name.
Inputs: node (required), vmid (required), snapname (required). Returns: result
get_vm_spiceproxyC
Create a SPICE proxy connection for a VM console.
Args: node: The node name. vmid: The VM ID.
Inputs: node (required), vmid (required). Returns: result
get_vm_statusA
Get the current runtime status of a VM (state, CPU, memory, disk, network, uptime).
Args: node: The node name. vmid: The VM ID.
Inputs: node (required), vmid (required). Returns: result
get_vm_vncproxyC
Create a VNC proxy connection ticket for a VM (for console access).
Args: node: The node name. vmid: The VM ID. websocket: Use WebSocket connection.
Inputs: node (required), vmid (required), websocket. Returns: result
get_vzdump_defaultsC
Get the default vzdump configuration for a node.
Args: node: The node name.
Inputs: node (required). Returns: result
get_vzdump_extractconfigB
Extract the guest configuration from a vzdump backup archive.
Args: node: The node name. volume: Backup volume ID (e.g. 'local:backup/vzdump-qemu-100-2024_01_01-00_00_00.vma.zst').
Inputs: node (required), volume (required). Returns: result
get_zfs_poolB
Get details of a ZFS pool.
Args: node: The node name. name: ZFS pool name.
Inputs: name (required), node (required). Returns: result
initialize_gptA
Initialize a disk with GPT partition table (WARNING: destroys all data).
Args: node: The node name. disk: Disk device path (e.g. '/dev/sdb').
Inputs: disk (required), node (required). Returns: result
join_clusterA
Join a node to an existing cluster.
Args: hostname: Hostname/IP of existing cluster node. fingerprint: SSL fingerprint of the cluster node. password: Root password of the cluster node. nodeid: Force specific node ID. force: Force join even with warnings.
Inputs: hostname (required), password (required), fingerprint (required), force, +1 more. Returns: result
list_acme_accountsB
List ACME (Let's Encrypt) accounts.
Inputs: no named parameters. Returns: result
list_acme_pluginsA
List ACME DNS challenge plugins.
Inputs: no named parameters. Returns: result
list_auth_domainsA
List configured authentication realms/domains (PAM, PVE, LDAP, AD, OpenID).
Inputs: no named parameters. Returns: result
list_backup_file_restoreB
List files in a vzdump backup for single-file restore.
Args: node: The node name. storage: Storage ID. volume: Backup volume ID. filepath: Path within the backup (default '/').
Inputs: node (required), volume (required), storage (required), filepath. Returns: result
list_backup_jobsA
List all scheduled backup jobs (vzdump) in the cluster.
Inputs: no named parameters. Returns: result
list_ceph_fsB
List CephFS filesystems.
Args: node: The node name.
Inputs: node (required). Returns: result
list_ceph_managersC
List Ceph managers.
Args: node: The node name.
Inputs: node (required). Returns: result
list_ceph_mdsC
List Ceph metadata servers (MDS, for CephFS).
Args: node: The node name.
Inputs: node (required). Returns: result
list_ceph_monitorsB
List Ceph monitors.
Args: node: The node name.
Inputs: node (required). Returns: result
list_ceph_osdsB
List Ceph OSDs on a node.
Args: node: The node name.
Inputs: node (required). Returns: result
list_ceph_poolsC
List Ceph pools.
Args: node: The node name.
Inputs: node (required). Returns: result
list_cluster_firewall_rulesA
List cluster-level firewall rules.
Inputs: no named parameters. Returns: result
list_container_firewall_rulesB
List firewall rules for an LXC container.
Args: node: The node name. vmid: The container ID.
Inputs: node (required), vmid (required). Returns: result
list_containersB
List all LXC containers on a node with status, memory, CPU, and disk info.
Args: node: The node name.
Inputs: node (required). Returns: result
list_container_snapshotsB
List all snapshots of a container.
Args: node: The node name. vmid: The container ID.
Inputs: node (required), vmid (required). Returns: result
list_directory_storageB
List directory-based storage mounts on a node.
Args: node: The node name.
Inputs: node (required). Returns: result
list_dir_mappingsB
List directory mappings.
Inputs: no named parameters. Returns: result
list_file_restoreA
List files in a backup volume for file-level restore (PBS backups).
Args: node: The node name. storage: The storage ID. volume: The backup volume ID. filepath: Path inside the backup to list (default '/').
Inputs: node (required), volume (required), storage (required), filepath. Returns: result
list_firewall_aliasesA
List cluster firewall aliases (named IP addresses/ranges).
Inputs: no named parameters. Returns: result
list_firewall_groupsA
List firewall security groups (reusable sets of rules).
Inputs: no named parameters. Returns: result
list_firewall_ipset_entriesB
List entries in a firewall IP set.
Args: name: IP set name.
Inputs: name (required). Returns: result
list_firewall_ipsetsA
List cluster firewall IP sets (named groups of IPs).
Inputs: no named parameters. Returns: result
list_firewall_macrosA
List available firewall macros (predefined rule sets like SSH, HTTP, etc.).
Inputs: no named parameters. Returns: result
list_groupsA
List all user groups.
Inputs: no named parameters. Returns: result
list_ha_groupsA
List HA groups (define which nodes can run HA resources).
Inputs: no named parameters. Returns: result
list_ha_resourcesA
List all HA-managed resources.
Inputs: no named parameters. Returns: result
list_lvmthin_poolsB
List LVM thin pools on a node.
Args: node: The node name.
Inputs: node (required). Returns: result
list_lvm_volumesC
List LVM volume groups on a node.
Args: node: The node name.
Inputs: node (required). Returns: result
list_metric_serversA
List configured metric servers (InfluxDB, Graphite).
Inputs: no named parameters. Returns: result
list_node_firewall_rulesC
List firewall rules for a node.
Args: node: The node name.
Inputs: node (required). Returns: result
list_nodesA
List all nodes in the Proxmox cluster with their status, CPU, memory, and uptime.
Inputs: no named parameters. Returns: result
list_node_servicesC
List all system services on a node (pve, ssh, cron, etc.).
Args: node: The node name.
Inputs: node (required). Returns: result
list_node_storageA
List storage pools available on a specific node with usage info.
Args: node: The node name. content: Filter by content type (images, rootdir, vztmpl, iso, backup). enabled: Only show enabled storage.
Inputs: node (required), content, enabled. Returns: result
list_node_tasksB
List recent tasks on a node.
Args: node: The node name. limit: Max tasks to return (default 50). start: Offset for paging. vmid: Filter by VM ID (0 = all). typefilter: Filter by task type (e.g. 'qmstart', 'vzstart', 'vzcreate'). statusfilter: Filter by status ('running', 'ok', 'error', etc.).
Inputs: node (required), vmid, limit, start, +2 more. Returns: result
list_notification_endpointsB
List all configured notification endpoints (sendmail, gotify, smtp, webhook).
Inputs: no named parameters. Returns: result
list_notification_matchersA
List all notification matchers (rules that route notifications).
Inputs: no named parameters. Returns: result
list_notification_targetsC
List all notification targets.
Inputs: no named parameters. Returns: result
list_pci_mappingsA
List PCI device mappings for passthrough.
Inputs: no named parameters. Returns: result
list_poolsA
List all resource pools.
Inputs: no named parameters. Returns: result
list_realm_sync_jobsB
List realm synchronization jobs.
Inputs: no named parameters. Returns: result
list_replication_jobsA
List all replication jobs in the cluster.
Inputs: no named parameters. Returns: result
list_rolesA
List all available roles.
Inputs: no named parameters. Returns: result
list_scheduled_jobsA
List all scheduled cluster jobs (realm-sync, etc.).
Inputs: no named parameters. Returns: result
list_sdn_controllersA
List SDN controllers (e.g. EVPN controller).
Inputs: no named parameters. Returns: result
list_sdn_dnsC
List SDN DNS plugins.
Inputs: no named parameters. Returns: result
list_sdn_ipamsA
List IPAM (IP Address Management) plugins.
Inputs: no named parameters. Returns: result
list_sdn_subnetsC
List subnets for an SDN VNet.
Args: vnet: VNet ID.
Inputs: vnet (required). Returns: result
list_sdn_vnetsA
List SDN virtual networks (VNets).
Inputs: no named parameters. Returns: result
list_sdn_zonesA
List SDN zones.
Inputs: no named parameters. Returns: result
list_storageA
List all configured storage pools at the datacenter level.
Args: type: Filter by type (dir, lvm, lvmthin, zfspool, nfs, cifs, iscsi, rbd, cephfs, pbs, glusterfs, btrfs). enabled: Only show enabled storage (default True).
Inputs: type, enabled. Returns: result
list_storage_contentB
List content of a storage pool (disk images, ISOs, templates, backups).
Args: node: The node name. storage: The storage ID. content: Filter by type: 'images', 'rootdir', 'vztmpl', 'iso', 'backup', 'snippets'. vmid: Filter by VM ID.
Inputs: node (required), storage (required), vmid, content. Returns: result
list_tfaB
List TFA (two-factor auth) entries.
Args: userid: Filter by user ID (empty = all users).
Inputs: userid. Returns: result
list_usb_mappingsA
List USB device mappings for passthrough.
Inputs: no named parameters. Returns: result
list_usersA
List all users in Proxmox.
Args: enabled: Only show enabled users. full: Include detailed info (groups, tokens, etc.).
Inputs: full, enabled. Returns: result
list_user_tokensA
List API tokens for a user.
Args: userid: User ID (format: 'user@realm').
Inputs: userid (required). Returns: result
list_vm_firewall_rulesC
List firewall rules for a QEMU VM.
Args: node: The node name. vmid: The VM ID.
Inputs: node (required), vmid (required). Returns: result
list_vmsA
List all QEMU virtual machines on a node with status, memory, CPU, and disk info.
Args: node: The node name.
Inputs: node (required). Returns: result
list_vm_snapshotsB
List all snapshots of a VM.
Args: node: The node name. vmid: The VM ID.
Inputs: node (required), vmid (required). Returns: result
list_zfs_poolsC
List ZFS pools on a node.
Args: node: The node name.
Inputs: node (required). Returns: result
manage_node_serviceB
Start, stop, restart, or reload a system service on a node.
Args: node: The node name. service: Service name (e.g. 'pvedaemon', 'pveproxy', 'ssh', 'cron', 'postfix'). action: One of 'start', 'stop', 'restart', 'reload'.
Inputs: node (required), action (required), service (required). Returns: result
migrate_containerB
Migrate a container to another node.
Args: node: The source node. vmid: The container ID. target: Target node name. online: Live migration. restart: Restart container after migration (for non-live). target_storage: Target storage mapping.
Inputs: node (required), vmid (required), target (required), online, +2 more. Returns: result
migrate_ha_resourceC
Request migration of an HA resource to a different node.
Args: sid: Resource ID. node: Target node.
Inputs: sid (required), node (required). Returns: result
migrate_vmB
Migrate a VM to another node in the cluster.
Args: node: The source node. vmid: The VM ID. target: Target node name. online: Live migration (True) or offline (False). with_local_disks: Migrate local disks as well. targetstorage: Target storage mapping for migration (e.g. 'local-lvm').
Inputs: node (required), vmid (required), target (required), online, +2 more. Returns: result
move_container_volumeA
Move a container volume to different storage or to another container.
Args: node: The node name. vmid: The container ID. volume: Volume name (e.g. 'rootfs', 'mp0'). storage: Target storage. target_vmid: Target container ID. target_volume: Target volume slot. delete_original: Delete original after move.
Inputs: node (required), vmid (required), volume (required), storage, +3 more. Returns: result
move_vm_diskA
Move a VM disk to different storage or attach to another VM.
Args: node: The node name. vmid: The VM ID. disk: Source disk name (e.g. 'scsi0'). storage: Target storage ID (for moving to different storage). target_vmid: Target VM ID (for moving disk to another VM). target_disk: Target disk slot on the target VM. delete_original: Delete the original disk after moving.
Inputs: disk (required), node (required), vmid (required), storage, +3 more. Returns: result
order_node_certificateB
Order/renew ACME certificate for a node.
Args: node: The node name. force: Force renewal even if not due.
Inputs: node (required), force. Returns: result
proxmox_api_rawA
Make an arbitrary Proxmox API call for any endpoint not covered by specific tools.
Args: method: HTTP method: 'get', 'post', 'put', 'delete'. path: API path (e.g. '/nodes/pve1/qemu/100/status/current'). params: JSON string of parameters (e.g. '{"memory": 4096}').
Inputs: path (required), method (required), params. Returns: result
prune_storage_backupsA
Prune (delete) old backups from storage according to retention policy.
Args: node: The node name. storage: The storage ID. type: Guest type filter ('qemu' or 'lxc'). vmid: Filter by VM ID. prune_backups: Retention spec (e.g. 'keep-last=3,keep-daily=7,keep-weekly=4'). dry_run: If True, only simulate (default True for safety).
Inputs: node (required), storage (required), type, vmid, +2 more. Returns: result
reboot_containerC
Reboot a container.
Args: node: The node name. vmid: The container ID. timeout: Timeout in seconds.
Inputs: node (required), vmid (required), timeout. Returns: result
reboot_vmC
Reboot a VM via ACPI.
Args: node: The node name. vmid: The VM ID. timeout: Wait timeout in seconds.
Inputs: node (required), vmid (required), timeout. Returns: result
register_acme_accountA
Register a new ACME account.
Args: contact: Contact email address. directory: ACME directory URL (empty = Let's Encrypt production). name: Account name. tos_url: Terms of service URL to accept.
Inputs: contact (required), name, tos_url, directory. Returns: result
relocate_ha_resourceC
Request relocation of an HA resource to a different node.
Args: sid: Resource ID. node: Target node.
Inputs: sid (required), node (required). Returns: result
reset_vmB
Hard reset a VM (like pressing the reset button).
Args: node: The node name. vmid: The VM ID.
Inputs: node (required), vmid (required). Returns: result
resize_container_diskA
Resize a container disk/volume.
Args: node: The node name. vmid: The container ID. disk: Disk name (e.g. 'rootfs', 'mp0'). size: New size or increment (e.g. '10G', '+2G').
Inputs: disk (required), node (required), size (required), vmid (required). Returns: result
resize_vm_diskA
Resize a VM disk. Can only grow, not shrink.
Args: node: The node name. vmid: The VM ID. disk: Disk name (e.g. 'scsi0', 'virtio0', 'ide0'). size: New size or size increment (e.g. '50G', '+10G').
Inputs: disk (required), node (required), size (required), vmid (required). Returns: result
resume_containerC
Resume a suspended container.
Args: node: The node name. vmid: The container ID.
Inputs: node (required), vmid (required). Returns: result
resume_vmA
Resume a suspended/paused VM.
Args: node: The node name. vmid: The VM ID.
Inputs: node (required), vmid (required). Returns: result
rollback_container_snapshotB
Rollback a container to a previous snapshot.
Args: node: The node name. vmid: The container ID. snapname: Snapshot name.
Inputs: node (required), vmid (required), snapname (required). Returns: result
rollback_vm_snapshotA
Rollback a VM to a previous snapshot (current state will be lost).
Args: node: The node name. vmid: The VM ID. snapname: The snapshot name to rollback to.
Inputs: node (required), vmid (required), snapname (required). Returns: result
run_apt_updateC
Refresh the package index on a node (apt update).
Args: node: The node name.
Inputs: node (required). Returns: result
send_vm_keyB
Send a key event to a VM (e.g. ctrl-alt-del).
Args: node: The node name. vmid: The VM ID. key: Key combination (e.g. 'ctrl-alt-delete').
Inputs: key (required), node (required), vmid (required). Returns: result
send_vm_monitor_commandB
Send a QEMU monitor command to a VM (advanced/low-level).
Args: node: The node name. vmid: The VM ID. command: The QEMU monitor command.
Inputs: node (required), vmid (required), command (required). Returns: result
set_ceph_flagsB
Set a Ceph global flag.
Args: flag: Flag name (noout, noscrub, nobackfill, norebalance, nodown, noup, etc.). value: True to set, False to unset.
Inputs: flag (required), value (required). Returns: result
set_cluster_firewall_optionsA
Set cluster-wide firewall options.
Args: enable: 1 to enable, 0 to disable, -1 to not change. policy_in: Default input policy: 'ACCEPT', 'REJECT', 'DROP'. policy_out: Default output policy: 'ACCEPT', 'REJECT', 'DROP'. log_ratelimit: Log rate limit (e.g. 'enable=1,rate=1/second,burst=5'). ebtables: 1 to enable ebtables rules, 0 to disable, -1 to not change. delete: Comma-separated options to delete.
Inputs: delete, enable, ebtables, policy_in, +2 more. Returns: result
set_node_firewall_optionsA
Set firewall options for a node.
Args: node: The node name. enable: 1 = enable, 0 = disable, -1 = don't change. log_level_in: Input log level. log_level_out: Output log level. ndp: 1 = enable NDP, 0 = disable, -1 = don't change. nf_conntrack_max: Max conntrack entries (0 = don't change). delete: Comma-separated options to delete.
Inputs: node (required), ndp, delete, enable, +3 more. Returns: result
set_vm_firewall_optionsB
Set firewall options for a QEMU VM.
Args: node: The node name. vmid: The VM ID. enable: 1 = enable, 0 = disable. dhcp: 1 = enable DHCP. ipfilter: 1 = enable IP filter. macfilter: 1 = enable MAC filter. policy_in: Input policy. policy_out: Output policy. delete: Comma-separated options to delete.
Inputs: node (required), vmid (required), dhcp, delete, +5 more. Returns: result
shutdown_containerB
Gracefully shut down a container.
Args: node: The node name. vmid: The container ID. timeout: Timeout in seconds before force stop. force_stop: Force stop after timeout.
Inputs: node (required), vmid (required), timeout, force_stop. Returns: result
shutdown_vmA
Gracefully shut down a VM via ACPI. Falls back to hard stop after timeout if force_stop is true.
Args: node: The node name. vmid: The VM ID. timeout: Timeout in seconds before force stop. force_stop: Force stop after timeout (default True).
Inputs: node (required), vmid (required), timeout, force_stop. Returns: result
startall_nodeA
Start all VMs and containers on a node (respecting boot order).
Args: node: The node name. force: Force start even if already running. vms: Comma-separated list of VMIDs to start (empty = all).
Inputs: node (required), vms, force. Returns: result
start_containerC
Start a container.
Args: node: The node name. vmid: The container ID.
Inputs: node (required), vmid (required). Returns: result
start_vmB
Start a VM.
Args: node: The node name. vmid: The VM ID. timeout: Timeout in seconds (0 = default).
Inputs: node (required), vmid (required), timeout. Returns: result
stopall_nodeB
Stop all VMs and containers on a node.
Args: node: The node name. vms: Comma-separated list of VMIDs to stop (empty = all).
Inputs: node (required), vms. Returns: result
stop_containerA
Hard-stop a container (immediate, like power off).
Args: node: The node name. vmid: The container ID.
Inputs: node (required), vmid (required). Returns: result
stop_taskB
Stop (abort) a running task.
Args: node: The node name. upid: The task UPID string.
Inputs: node (required), upid (required). Returns: result
stop_vmA
Hard-stop a VM (like pulling the power plug). Prefer shutdown_vm for graceful stop.
Args: node: The node name. vmid: The VM ID. timeout: Wait timeout in seconds. skiplock: Ignore locks (requires root).
Inputs: node (required), vmid (required), timeout, skiplock. Returns: result
suspend_containerC
Suspend (freeze) a container.
Args: node: The node name. vmid: The container ID.
Inputs: node (required), vmid (required). Returns: result
suspend_vmA
Suspend a VM (pause execution or hibernate to disk).
Args: node: The node name. vmid: The VM ID. todisk: If True, hibernate to disk. If False, pause in RAM.
Inputs: node (required), vmid (required), todisk. Returns: result
sync_auth_domainA
Sync users/groups from an external auth domain (LDAP/AD).
Args: realm: Realm ID to sync. dry_run: Only show what would change. full: Full sync (not just incremental). enable_new: Enable newly synced users. remove_vanished: Comma-separated: 'entry' (remove users), 'properties' (clear), 'acl' (remove ACLs).
Inputs: realm (required), full, dry_run, enable_new, +1 more. Returns: result
test_notification_targetC
Send a test notification to a target.
Args: name: Target name.
Inputs: name (required). Returns: result
update_aclA
Add or remove ACL entries (permission assignments).
Args: path: Object path (e.g. '/', '/vms/100', '/storage/local', '/pool/mypool'). roles: Comma-separated role list. users: Comma-separated user list (format: 'user@realm'). groups: Comma-separated group list. tokens: Comma-separated token list (format: 'user@realm!tokenid'). propagate: Propagate permissions to child objects. delete: Remove the ACL entry instead of adding.
Inputs: path (required), roles (required), users, delete, +3 more. Returns: result
update_backup_jobB
Update a scheduled backup job.
Args: id: Backup job ID. storage: Target storage ID. schedule: Schedule in systemd calendar format. all_guests: Backup all guests. vmid: Comma-separated VMIDs. node: Node filter. mode: Backup mode. compress: Compression. enabled: Enable/disable. delete: Comma-separated properties to delete.
Inputs: id (required), mode, node, vmid, +6 more. Returns: result
update_cluster_firewall_ruleC
Update a cluster-level firewall rule.
Args: pos: Rule position to update. action: 'ACCEPT', 'DROP', 'REJECT'. enable: 1 = enabled, 0 = disabled, -1 = don't change. source: Source address/range. dest: Destination address/range. proto: Protocol. sport: Source port(s). dport: Destination port(s). macro: Predefined macro. comment: Description. moveto: Move rule to this position. delete: Comma-separated properties to delete.
Inputs: pos (required), dest, dport, macro, +8 more. Returns: result
update_cluster_optionsB
Update datacenter/cluster-wide options.
Args: keyboard: Keyboard layout (e.g. 'en-us', 'de'). language: Default language. console: Default console viewer: 'applet', 'vv', 'html5', 'xtermjs'. http_proxy: HTTP proxy URL. email_from: Default email sender address. max_workers: Max parallel workers. description: Datacenter description. delete: Comma-separated settings to delete.
Inputs: delete, console, keyboard, language, +4 more. Returns: result
update_container_configC
Update the configuration of an existing container.
Args: node: The node name. vmid: The container ID. hostname: Container hostname. memory: Memory in MB. swap: Swap in MB. cores: CPU cores. cpulimit: CPU limit (0 = unlimited). net0: Network config. nameserver: DNS nameserver. searchdomain: DNS search domain. onboot: Start on boot. description: Description. features: Comma-separated features. tags: Tags for the container. delete: Comma-separated list of settings to delete.
Inputs: node (required), vmid (required), net0, swap, +11 more. Returns: result
update_groupC
Update a group.
Args: groupid: Group ID. comment: Description.
Inputs: groupid (required), comment. Returns: result
update_ha_groupA
Update an HA group.
Args: group: Group ID. nodes: Node list with optional priority. nofailback: Don't fail back. restricted: Only run on group nodes. comment: Description. delete: Comma-separated properties to delete.
Inputs: group (required), nodes, delete, comment, +2 more. Returns: result
update_ha_resourceB
Update an HA resource configuration.
Args: sid: Resource ID. group: HA group name. max_relocate: Max relocations (-1 = don't change). max_restart: Max restarts (-1 = don't change). state: Desired state. comment: Description. delete: Comma-separated properties to delete.
Inputs: sid (required), group, state, delete, +3 more. Returns: result
update_poolA
Update a resource pool (add/remove members).
Args: poolid: Pool ID. comment: Description. vms: Comma-separated VMIDs to add/remove. storage: Comma-separated storage IDs to add/remove. delete: If true, remove the specified vms/storage from the pool instead of adding.
Inputs: poolid (required), vms, delete, comment, +1 more. Returns: result
update_roleA
Update role privileges.
Args: roleid: Role ID. privs: Comma-separated list of privileges. append: Append privileges instead of replacing.
Inputs: privs (required), roleid (required), append. Returns: result
update_sdn_vnetC
Update an SDN VNet.
Args: vnet: VNet ID. zone: Zone ID. tag: VLAN tag (-1 = don't change). alias: Display alias. delete: Comma-separated properties to delete.
Inputs: vnet (required), tag, zone, alias, +1 more. Returns: result
update_storageB
Update an existing storage pool configuration.
Args: storage: The storage ID to update. content: Content types (images, rootdir, vztmpl, iso, backup, snippets, import). nodes: Allowed nodes (comma-separated). shared: Mark as shared. disable: Disable this storage. prune_backups: Backup retention policy. delete: Comma-separated list of settings to delete.
Inputs: storage (required), nodes, delete, shared, +3 more. Returns: result
update_userB
Update an existing user.
Args: userid: User ID (format: 'user@realm'). email: Email address. firstname: First name. lastname: Last name. groups: Comma-separated group list. comment: Description. enable: Enable/disable user. expire: Account expiration (Unix epoch, 0 = never, -1 = don't change). append: Append groups instead of replacing.
Inputs: userid (required), email, append, enable, +5 more. Returns: result
update_vm_cloudinitA
Set Cloud-Init parameters for a VM (user, password, SSH keys, network).
Args: node: The node name. vmid: The VM ID. ciuser: Cloud-Init user name. cipassword: Cloud-Init password. sshkeys: SSH public keys (URL-encoded, newline delimited). ipconfig0: IP config for first interface (e.g. 'ip=dhcp' or 'ip=10.0.0.5/24,gw=10.0.0.1'). nameserver: DNS nameserver IP. searchdomain: DNS search domain.
Inputs: node (required), vmid (required), ciuser, sshkeys, +4 more. Returns: result
update_vm_configA
Update the configuration of an existing VM. Only provided parameters are changed.
Args: node: The node name. vmid: The VM ID. name: VM name. memory: Memory in MB. cores: CPU cores per socket. sockets: CPU sockets. cpu: CPU type. net0: Network config. description: Description. onboot: Start on boot. agent: Guest agent config. boot: Boot order. tags: Tags for the VM. hotplug: Hotplug features (disk, network, usb, memory, cpu). delete: Comma-separated list of settings to delete.
Inputs: node (required), vmid (required), cpu, boot, +11 more. Returns: result
upload_to_storageC
Upload a file (ISO, template, etc.) to storage. Note: actual file upload must go through the HTTP API directly.
Args: node: The node name. storage: The storage ID. content: Content type: 'iso', 'vztmpl', 'snippets', 'import'. filename: Target filename. tmpfilename: Temporary filename for the upload.
Inputs: node (required), content (required), storage (required), filename (required), +1 more. Returns: result
vm_agent_execB
Execute a command inside a VM via the QEMU Guest Agent.
Args: node: The node name. vmid: The VM ID. command: The command to execute. A string is split into arguments using POSIX shell rules (quote paths containing spaces). A list is passed through unchanged and is recommended for Windows guest paths with backslashes, since POSIX splitting otherwise strips them. input_data: Data to pass to stdin.
Inputs: node (required), vmid (required), command (required), input_data. Returns: result
vm_agent_exec_statusB
Get the status/result of a command previously executed via the guest agent.
Args: node: The node name. vmid: The VM ID. pid: The PID returned by the exec call.
Inputs: pid (required), node (required), vmid (required). Returns: result
vm_agent_file_readB
Read a file from inside a VM via the guest agent.
Args: node: The node name. vmid: The VM ID. file: Absolute file path inside the guest.
Inputs: file (required), node (required), vmid (required). Returns: result
vm_agent_file_writeB
Write content to a file inside a VM via the guest agent.
Args: node: The node name. vmid: The VM ID. file: Absolute file path inside the guest. content: File content to write.
Inputs: file (required), node (required), vmid (required), content (required). Returns: result
vm_agent_get_infoB
Get various system information from a VM via the guest agent.
Args: node: The node name. vmid: The VM ID. info_type: Info to retrieve: 'get-osinfo', 'get-host-name', 'get-time', 'get-timezone', 'get-users', 'get-vcpus', 'get-fsinfo', 'get-memory-blocks', 'get-memory-block-info', 'info', 'network-get-interfaces'.
Inputs: node (required), vmid (required), info_type. Returns: result
vm_agent_set_passwordB
Set a user password inside a VM via the guest agent.
Args: node: The node name. vmid: The VM ID. username: The username. password: The new password. crypted: If True, password is already encrypted.
Inputs: node (required), vmid (required), password (required), username (required), +1 more. Returns: result
wakeonlan_nodeB
Send a Wake-on-LAN magic packet to a node.
Args: node: The node name.
Inputs: node (required). Returns: result
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 286 tools
Most tools have distinct resource/action names, but the 286-tool surface creates real overlap: e.g. list_vms vs. get_cluster_resources(type='vm'), list_storage vs. list_node_storage, and multiple firewall/HA/backup listing tools. Descriptions usually clarify the intended boundary, but agents will still face selection ambiguity at scale.
The set is overwhelmingly snake_case and follows predictable verb_noun patterns such as list_vms, get_vm_status, create_container, and delete_ha_group. There are minor deviations like proxmox_api_raw, startall_node, and several vm_agent_* resource-first names, but the convention remains readable and mostly consistent.
286 tools is an extreme mismatch for a single MCP server, even for a broad platform like Proxmox VE. The surface is effectively a raw API wrapper split into hundreds of endpoints, which makes tool discovery and selection impractical without strong grouping or routing.
Coverage is very broad across VMs, containers, nodes, storage, SDN, firewall, HA, Ceph, backup, users, ACLs, ACME, replication, tasks, and guest agents. Some secondary CRUD operations are missing or uneven, but the proxmox_api_raw fallback mitigates most dead ends.
Maintenance
Related MCP Connectors
MCP-first control plane for ProAgentStore agents and private instances.
MCP server enabling AI agents to manage Bitrix24 features via standardized protocol
MCP server that lets AI assistants use all OneSchema features exposed via the public API.
MCP server for OpenAI API (chat completions, image generation, embeddings) via AceDataCloud
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceEnables AI assistants to manage Proxmox VE virtual machines via MCP and OpenAPI, supporting operations like start, stop, clone, and snapshot.6MIT
- AlicenseNot gradedqualityDmaintenanceEnables AI assistants to manage Proxmox VE infrastructure, including VMs, containers, storage, and cluster operations via natural language.MIT
- AlicenseNot gradedqualityDmaintenanceEnables AI assistants to monitor and manage Proxmox VE infrastructure, including nodes, VMs, containers, storage, backups, and networking, via natural language.1MIT
- AlicenseNot gradedqualityDmaintenanceEnables AI assistants to monitor and analyze Proxmox VE virtualization environments via the MCP protocol.MIT