Manage Proxmox VE infrastructure including virtual machines, containers, storage, networking, firewall rules, high availability, and more.
10K+
286 Tools
Version 4.43 or later needs to be installed to add the server automatically
Use cases
About
Manage Proxmox VE infrastructure including virtual machines, containers, storage, networking, firewall rules, high availability, and more.
| Attribute | Details |
|---|---|
| Docker Image | mcp/proxmox |
| Author | GethosTheWalrus |
| Repository | https://github.com/GethosTheWalrus/proxmox-mcp |
| Attribute | Details |
|---|---|
| Dockerfile | https://github.com/GethosTheWalrus/proxmox-mcp/blob/060b7f5bbbf14bb69f1dac928f1566125e0b03b5/Dockerfile |
| Commit | 060b7f5bbbf14bb69f1dac928f1566125e0b03b5 |
| Docker Image built by | Docker Inc. |
| Docker Scout Health Score | |
| Verify Signature | COSIGN_REPOSITORY=mcp/signatures cosign verify mcp/proxmox --key https://raw.githubusercontent.com/docker/keyring/refs/heads/main/public/mcp/latest.pub |
| Licence | Other |
| Tools provided by this Server | Short Description |
|---|---|
add_firewall_ipset_entry | Add an IP/CIDR to an IP set. |
allocate_storage_volume | Allocate a new disk volume in storage. |
apply_sdn_changes | Apply pending SDN configuration changes to all nodes. |
bulk_migrate_guests | Bulk migrate guests to a target node. |
bulk_shutdown_guests | Bulk shutdown guests across the cluster. |
bulk_start_guests | Bulk start guests across the cluster. |
change_password | Change a user's password. |
clone_container | Clone a container. |
clone_vm | Clone a VM to create a new one. |
convert_container_to_template | Convert a container into a template (irreversible). |
convert_vm_to_template | Convert a VM into a template (irreversible). |
create_backup_job | Create a scheduled backup job. |
create_ceph_osd | Create a new Ceph OSD on a device. |
create_ceph_pool | Create a new Ceph pool. |
create_cluster_firewall_rule | Create a cluster-level firewall rule. |
create_container | Create a new LXC container. |
create_container_firewall_rule | Create a firewall rule for an LXC container. |
create_container_snapshot | Create a snapshot of a container. |
create_directory_storage | Create a directory-based storage mount from a device. |
create_firewall_alias | Create a firewall alias (named IP address or CIDR). |
create_firewall_group | Create a new firewall security group. |
create_firewall_group_rule | Add a rule to a firewall security group. |
create_firewall_ipset | Create a new firewall IP set. |
create_group | Create a new group. |
create_ha_group | Create an HA group. |
create_ha_resource | Add a resource to HA management. |
create_lvm | Create a new LVM volume group on a device. |
create_lvmthin | Create a new LVM thin pool. |
create_node_network_interface | Create a network interface on a node. |
create_pool | Create a resource pool. |
create_replication_job | Create a storage replication job. |
create_role | Create a new role with specific privileges. |
create_sdn_subnet | Create a subnet for an SDN VNet. |
create_sdn_vnet | Create an SDN VNet. |
create_sdn_zone | Create an SDN zone. |
create_storage | Create a new storage pool configuration. |
create_user | Create a new user. |
create_user_token | Create a new API token for a user. |
create_vm | Create a new QEMU virtual machine. |
create_vm_firewall_rule | Create a firewall rule for a QEMU VM. |
create_vm_snapshot | Create a snapshot of a VM. |
create_vzdump | Start an immediate backup (vzdump) on a node. |
create_zfs_pool | Create a new ZFS pool. |
delete_backup_job | Delete a scheduled backup job. |
delete_cluster_firewall_rule | Delete a cluster-level firewall rule. |
delete_container | Delete a container. |
delete_container_snapshot | Delete a container snapshot. |
delete_firewall_alias | Delete a firewall alias. |
delete_firewall_ipset_entry | Remove an IP/CIDR from an IP set. |
delete_group | Delete a group. |
delete_ha_group | Delete an HA group. |
delete_ha_resource | Remove a resource from HA management. |
delete_pool | Delete a resource pool. |
delete_replication_job | Delete a replication job. |
delete_role | Delete a role. |
delete_sdn_vnet | Delete an SDN VNet. |
delete_sdn_zone | Delete an SDN zone. |
delete_storage | Delete a storage pool configuration (does not delete data on the backend). |
delete_storage_volume | Delete a volume from storage. |
delete_user | Delete a user. |
delete_user_token | Delete an API token. |
delete_vm | Delete a VM. |
delete_vm_snapshot | Delete a VM snapshot. |
download_appliance_template | Download an appliance template to local storage. |
download_file_restore | Download a file from a vzdump backup. |
download_url_to_storage | Download a file from a URL directly to storage (ISO, template, etc.). |
dump_vm_cloudinit | Dump the Cloud-Init generated config file (user-data, network-data, or meta-data). |
get_acl | Get the full ACL (access control list) — shows all permission assignments. |
get_acme_account | Get ACME account details. |
get_acme_directories | List known ACME directory URLs. |
get_acme_plugin | Get ACME plugin configuration. |
get_acme_tos | Get the ACME Terms of Service URL. |
get_auth_domain | Get authentication domain configuration. |
get_backup_job | Get details of a specific backup job. |
get_backup_job_included_volumes | Get volumes included in a backup job. |
get_ceph_config | Get the raw Ceph configuration. |
get_ceph_crush_rules | Get Ceph CRUSH rules. |
get_ceph_flags | Get Ceph global flags (noout, noscrub, etc.). |
get_ceph_metadata | Get Ceph metadata (versions, services across nodes). |
get_ceph_status_cluster | Get Ceph cluster status (health, monitors, OSDs, PGs). |
get_ceph_status_node | Get Ceph status from a specific node's perspective. |
get_cluster_config | Get the current cluster configuration (corosync, nodes, join info). |
get_cluster_config_nodes | List nodes configured in the cluster. |
get_cluster_firewall_options | Get cluster-wide firewall options (enable, policy_in, policy_out, etc.). |
get_cluster_firewall_rule | Get a specific cluster firewall rule. |
get_cluster_join_info | Get info needed to join a node to this cluster. |
get_cluster_log | Get the cluster log (recent events). |
get_cluster_options | Get datacenter/cluster-wide options (keyboard layout, console, language, etc.). |
get_cluster_resources | List all resources across the cluster (VMs, containers, storage, nodes). |
get_cluster_status | Get cluster status (nodes online, quorum, HA state). |
get_cluster_tasks | List recent tasks across all nodes in the cluster. |
get_cluster_totem | Get the corosync totem configuration. |
get_container_config | Get the configuration of a container. |
get_container_feature | Check if a feature is available for a container (snapshot, clone, copy). |
get_container_firewall_options | Get firewall options for an LXC container. |
get_container_interfaces | Get network interfaces and IPs of a running container. |
get_container_pending | Get pending configuration changes for a container. |
get_container_rrddata | Get RRD statistics data for a container (CPU, memory, disk, network over time). |
get_container_status | Get the current runtime status of a container. |
get_disk_smart | Get S.M.A.R.T. |
get_firewall_group_rules | List rules in a firewall security group. |
get_firewall_refs | Get available firewall references (aliases, ipsets, names usable in rules). |
get_group | Get group details. |
get_ha_group | Get HA group configuration. |
get_ha_manager_status | Get detailed HA manager status. |
get_ha_resource | Get HA resource configuration. |
get_ha_status | Get HA manager status (active, quorum, manager status). |
get_metric_server | Get metric server configuration. |
get_next_vmid | Get the next available VMID in the cluster. |
get_node_aplinfo | List available appliance templates (LXC templates) that can be downloaded. |
get_node_apt_update | List available package updates on a node. |
get_node_capabilities_qemu | Get QEMU capabilities for a node: supported CPU models, machine types, etc. |
get_node_certificates | Get certificate info for a node. |
get_node_config | Get the configuration of a node (description, wakeonlan, etc.). |
get_node_disks | List physical disks on a node. |
get_node_dns | Get DNS settings for a node. |
get_node_firewall_log | Get firewall log for a node. |
get_node_firewall_options | Get firewall options for a specific node. |
get_node_hardware_pci | List PCI hardware devices on a node (for passthrough). |
get_node_hardware_usb | List USB hardware devices on a node. |
get_node_hosts | Get the /etc/hosts file content for a node. |
get_node_journal | Read systemd journal entries from a node. |
get_node_netstat | Get network statistics for a node (per-interface traffic). |
get_node_network | Get network interface configuration for a node. |
get_node_network_interface | Get details for a specific network interface. |
get_node_report | Generate a system report for a node (useful for diagnostics). |
get_node_status | Get detailed status of a specific node including CPU, memory, disk, uptime, and kernel info. |
get_node_storage_scan | Scan for available storage targets (NFS, CIFS, iSCSI, LVM, ZFS, PBS). |
get_node_storage_status | Get usage status of a storage pool on a node (total, used, available). |
get_node_subscription | Get subscription status for a node. |
get_node_syslog | Read system log (syslog) entries from a node. |
get_node_time | Get the current time and timezone of a node. |
get_node_version | Get Proxmox VE version information for a specific node. |
get_permissions | Check effective permissions for a user on a given path. |
get_pool | Get pool configuration and members. |
get_replication_job | Get a specific replication job configuration. |
get_role | Get role details and its privileges. |
get_sdn_controller | Get SDN controller configuration. |
get_sdn_ipam | Get IPAM plugin configuration. |
get_sdn_vnet | Get SDN VNet configuration. |
get_sdn_zone | Get SDN zone configuration. |
get_storage_config | Get configuration of a specific storage pool. |
get_storage_rrddata | Get RRD statistics for a storage pool (usage over time). |
get_storage_volume_info | Get details about a specific volume in storage. |
get_task_log | Get log output of a specific task. |
get_task_status | Get the status of a specific task by its UPID. |
get_user | Get details for a specific user. |
get_user_token | Get details for a specific API token. |
get_version | Get the Proxmox VE API version information. |
get_vm_cloudinit | Get Cloud-Init configuration for a VM. |
get_vm_config | Get the configuration of a VM. |
get_vm_feature | Check if a specific feature is available/supported for a VM (e.g. |
get_vm_firewall_options | Get firewall options for a QEMU VM. |
get_vm_pending | Get pending configuration changes for a VM (not yet applied). |
get_vm_rrddata | Get RRD statistics data for a VM (CPU, memory, disk, network over time). |
get_vm_snapshot_config | Get the configuration stored in a VM snapshot. |
get_vm_spiceproxy | Create a SPICE proxy connection for a VM console. |
get_vm_status | Get the current runtime status of a VM (state, CPU, memory, disk, network, uptime). |
get_vm_vncproxy | Create a VNC proxy connection ticket for a VM (for console access). |
get_vzdump_defaults | Get the default vzdump configuration for a node. |
get_vzdump_extractconfig | Extract the guest configuration from a vzdump backup archive. |
get_zfs_pool | Get details of a ZFS pool. |
initialize_gpt | Initialize a disk with GPT partition table (WARNING: destroys all data). |
join_cluster | Join a node to an existing cluster. |
list_acme_accounts | List ACME (Let's Encrypt) accounts. |
list_acme_plugins | List ACME DNS challenge plugins. |
list_auth_domains | List configured authentication realms/domains (PAM, PVE, LDAP, AD, OpenID). |
list_backup_file_restore | List files in a vzdump backup for single-file restore. |
list_backup_jobs | List all scheduled backup jobs (vzdump) in the cluster. |
list_ceph_fs | List CephFS filesystems. |
list_ceph_managers | List Ceph managers. |
list_ceph_mds | List Ceph metadata servers (MDS, for CephFS). |
list_ceph_monitors | List Ceph monitors. |
list_ceph_osds | List Ceph OSDs on a node. |
list_ceph_pools | List Ceph pools. |
list_cluster_firewall_rules | List cluster-level firewall rules. |
list_container_firewall_rules | List firewall rules for an LXC container. |
list_container_snapshots | List all snapshots of a container. |
list_containers | List all LXC containers on a node with status, memory, CPU, and disk info. |
list_dir_mappings | List directory mappings. |
list_directory_storage | List directory-based storage mounts on a node. |
list_file_restore | List files in a backup volume for file-level restore (PBS backups). |
list_firewall_aliases | List cluster firewall aliases (named IP addresses/ranges). |
list_firewall_groups | List firewall security groups (reusable sets of rules). |
list_firewall_ipset_entries | List entries in a firewall IP set. |
list_firewall_ipsets | List cluster firewall IP sets (named groups of IPs). |
list_firewall_macros | List available firewall macros (predefined rule sets like SSH, HTTP, etc.). |
list_groups | List all user groups. |
list_ha_groups | List HA groups (define which nodes can run HA resources). |
list_ha_resources | List all HA-managed resources. |
list_lvm_volumes | List LVM volume groups on a node. |
list_lvmthin_pools | List LVM thin pools on a node. |
list_metric_servers | List configured metric servers (InfluxDB, Graphite). |
list_node_firewall_rules | List firewall rules for a node. |
list_node_services | List all system services on a node (pve, ssh, cron, etc.). |
list_node_storage | List storage pools available on a specific node with usage info. |
list_node_tasks | List recent tasks on a node. |
list_nodes | List all nodes in the Proxmox cluster with their status, CPU, memory, and uptime. |
list_notification_endpoints | List all configured notification endpoints (sendmail, gotify, smtp, webhook). |
list_notification_matchers | List all notification matchers (rules that route notifications). |
list_notification_targets | List all notification targets. |
list_pci_mappings | List PCI device mappings for passthrough. |
list_pools | List all resource pools. |
list_realm_sync_jobs | List realm synchronization jobs. |
list_replication_jobs | List all replication jobs in the cluster. |
list_roles | List all available roles. |
list_scheduled_jobs | List all scheduled cluster jobs (realm-sync, etc.). |
list_sdn_controllers | List SDN controllers (e.g. |
list_sdn_dns | List SDN DNS plugins. |
list_sdn_ipams | List IPAM (IP Address Management) plugins. |
list_sdn_subnets | List subnets for an SDN VNet. |
list_sdn_vnets | List SDN virtual networks (VNets). |
list_sdn_zones | List SDN zones. |
list_storage | List all configured storage pools at the datacenter level. |
list_storage_content | List content of a storage pool (disk images, ISOs, templates, backups). |
list_tfa | List TFA (two-factor auth) entries. |
list_usb_mappings | List USB device mappings for passthrough. |
list_user_tokens | List API tokens for a user. |
list_users | List all users in Proxmox. |
list_vm_firewall_rules | List firewall rules for a QEMU VM. |
list_vm_snapshots | List all snapshots of a VM. |
list_vms | List all QEMU virtual machines on a node with status, memory, CPU, and disk info. |
list_zfs_pools | List ZFS pools on a node. |
manage_node_service | Start, stop, restart, or reload a system service on a node. |
migrate_container | Migrate a container to another node. |
migrate_ha_resource | Request migration of an HA resource to a different node. |
migrate_vm | Migrate a VM to another node in the cluster. |
move_container_volume | Move a container volume to different storage or to another container. |
move_vm_disk | Move a VM disk to different storage or attach to another VM. |
order_node_certificate | Order/renew ACME certificate for a node. |
proxmox_api_raw | Make an arbitrary Proxmox API call for any endpoint not covered by specific tools. |
prune_storage_backups | Prune (delete) old backups from storage according to retention policy. |
reboot_container | Reboot a container. |
reboot_vm | Reboot a VM via ACPI. |
register_acme_account | Register a new ACME account. |
relocate_ha_resource | Request relocation of an HA resource to a different node. |
reset_vm | Hard reset a VM (like pressing the reset button). |
resize_container_disk | Resize a container disk/volume. |
resize_vm_disk | Resize a VM disk. |
resume_container | Resume a suspended container. |
resume_vm | Resume a suspended/paused VM. |
rollback_container_snapshot | Rollback a container to a previous snapshot. |
rollback_vm_snapshot | Rollback a VM to a previous snapshot (current state will be lost). |
run_apt_update | Refresh the package index on a node (apt update). |
send_vm_key | Send a key event to a VM (e.g. |
send_vm_monitor_command | Send a QEMU monitor command to a VM (advanced/low-level). |
set_ceph_flags | Set a Ceph global flag. |
set_cluster_firewall_options | Set cluster-wide firewall options. |
set_node_firewall_options | Set firewall options for a node. |
set_vm_firewall_options | Set firewall options for a QEMU VM. |
shutdown_container | Gracefully shut down a container. |
shutdown_vm | Gracefully shut down a VM via ACPI. |
start_container | Start a container. |
start_vm | Start a VM. |
startall_node | Start all VMs and containers on a node (respecting boot order). |
stop_container | Hard-stop a container (immediate, like power off). |
stop_task | Stop (abort) a running task. |
stop_vm | Hard-stop a VM (like pulling the power plug). |
stopall_node | Stop all VMs and containers on a node. |
suspend_container | Suspend (freeze) a container. |
suspend_vm | Suspend a VM (pause execution or hibernate to disk). |
sync_auth_domain | Sync users/groups from an external auth domain (LDAP/AD). |
test_notification_target | Send a test notification to a target. |
update_acl | Add or remove ACL entries (permission assignments). |
update_backup_job | Update a scheduled backup job. |
update_cluster_firewall_rule | Update a cluster-level firewall rule. |
update_cluster_options | Update datacenter/cluster-wide options. |
update_container_config | Update the configuration of an existing container. |
update_group | Update a group. |
update_ha_group | Update an HA group. |
update_ha_resource | Update an HA resource configuration. |
update_pool | Update a resource pool (add/remove members). |
update_role | Update role privileges. |
update_sdn_vnet | Update an SDN VNet. |
update_storage | Update an existing storage pool configuration. |
update_user | Update an existing user. |
update_vm_cloudinit | Set Cloud-Init parameters for a VM (user, password, SSH keys, network). |
update_vm_config | Update the configuration of an existing VM. |
upload_to_storage | Upload a file (ISO, template, etc.) to storage. |
vm_agent_exec | Execute a command inside a VM via the QEMU Guest Agent. |
vm_agent_exec_status | Get the status/result of a command previously executed via the guest agent. |
vm_agent_file_read | Read a file from inside a VM via the guest agent. |
vm_agent_file_write | Write content to a file inside a VM via the guest agent. |
vm_agent_get_info | Get various system information from a VM via the guest agent. |
vm_agent_set_password | Set a user password inside a VM via the guest agent. |
wakeonlan_node | Send a Wake-on-LAN magic packet to a node. |
add_firewall_ipset_entryAdd an IP/CIDR to an IP set.
| Parameters | Type | Description |
|---|---|---|
cidr | string | IP address or CIDR. |
name | string | IP set name. |
comment | stringoptional | Description. |
nomatch | booleanoptional | Exclude this entry (nomatch). |
allocate_storage_volumeAllocate a new disk volume in storage.
| Parameters | Type | Description |
|---|---|---|
filename | string | Volume name. |
node | string | The node name. |
size | string | Volume size (e.g. '10G'). |
storage | string | The storage ID. |
vmid | integer | VM ID to associate with. |
format | stringoptional | Disk format (raw, qcow2, vmdk). Auto-detected if empty. |
apply_sdn_changesApply pending SDN configuration changes to all nodes.
bulk_migrate_guestsBulk migrate guests to a target node.
| Parameters | Type | Description |
|---|---|---|
target | string | Target node name. |
vms | stringoptional | Comma-separated VMIDs. |
bulk_shutdown_guestsBulk shutdown guests across the cluster.
| Parameters | Type | Description |
|---|---|---|
vms | stringoptional | Comma-separated list of VMIDs (empty = all). |
bulk_start_guestsBulk start guests across the cluster.
| Parameters | Type | Description |
|---|---|---|
vms | stringoptional | Comma-separated list of VMIDs (empty = all). |
change_passwordChange a user's password.
| Parameters | Type | Description |
|---|---|---|
password | string | New password. |
userid | string | User ID (format: 'user@realm'). |
clone_containerClone a container.
| Parameters | Type | Description |
|---|---|---|
newid | integer | ID for the new container. |
node | string | The source node name. |
vmid | integer | The source container ID. |
description | stringoptional | Description. |
full | booleanoptional | Full clone (True) or linked clone (False). |
hostname | stringoptional | Hostname for the clone. |
pool | stringoptional | Resource pool. |
snapname | stringoptional | Snapshot to clone from. |
storage | stringoptional | Target storage for full clone. |
target | stringoptional | Target node (default: same node). |
clone_vmClone a VM to create a new one. Can be a full copy or linked clone.
| Parameters | Type | Description |
|---|---|---|
newid | integer | The VMID for the new clone. |
node | string | The source node name. |
vmid | integer | The source VM ID. |
description | stringoptional | Description for the clone. |
full | booleanoptional | Full clone (True) or linked clone (False). |
name | stringoptional | Name for the clone. |
pool | stringoptional | Resource pool. |
snapname | stringoptional | Snapshot name to clone from. |
storage | stringoptional | Target storage for full clone. |
target | stringoptional | Target node for the clone (default: same node). |
convert_container_to_templateConvert a container into a template (irreversible).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID. |
convert_vm_to_templateConvert a VM into a template (irreversible).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
create_backup_jobCreate a scheduled backup job.
| Parameters | Type | Description |
|---|---|---|
storage | string | Target storage ID for backups. |
all_guests | booleanoptional | Backup all guests. |
comment | stringoptional | Description. |
compress | stringoptional | Compression: 'none', 'lzo', 'gzip', 'zstd'. |
enabled | booleanoptional | Enable the job. |
mailnotification | stringoptional | 'always' or 'failure'. |
mailto | stringoptional | Comma-separated email addresses. |
maxfiles | integeroptional | Max backup files to keep (0 = unlimited, deprecated - use prune_backups). |
mode | stringoptional | Backup mode: 'snapshot', 'suspend', 'stop'. |
node | stringoptional | Only back up guests on this node. |
notes_template | stringoptional | Template for backup notes. |
prune_backups | stringoptional | Retention schedule (e.g. 'keep-daily=7,keep-weekly=4'). |
schedule | stringoptional | Schedule in systemd calendar format (e.g. 'daily', 'weekly', '02:00'). |
vmid | stringoptional | Comma-separated VMIDs to back up (if not all_guests). |
create_ceph_osdCreate a new Ceph OSD on a device.
| Parameters | Type | Description |
|---|---|---|
dev | string | Block device for the OSD (e.g. '/dev/sdb'). |
node | string | The node name. |
db_dev | stringoptional | Separate block device for DB. |
encrypted | booleanoptional | Encrypt the OSD. |
wal_dev | stringoptional | Separate block device for WAL. |
create_ceph_poolCreate a new Ceph pool.
| Parameters | Type | Description |
|---|---|---|
name | string | Pool name. |
node | string | The node name. |
application | stringoptional | Pool application (rbd, cephfs, rgw). |
min_size | integeroptional | Minimum replicas for I/O (default 2). |
pg_num | integeroptional | Number of placement groups (default 128). |
size | integeroptional | Number of replicas (default 3). |
create_cluster_firewall_ruleCreate a cluster-level firewall rule.
| Parameters | Type | Description |
|---|---|---|
action | string | 'ACCEPT', 'DROP', 'REJECT'. |
type | string | 'in', 'out', 'group'. |
comment | stringoptional | Description. |
dest | stringoptional | Destination address/range. |
dport | stringoptional | Destination port(s). |
enable | integeroptional | 1 = enabled, 0 = disabled. |
iface | stringoptional | Network interface. |
log | stringoptional | Log level: 'emerg', 'alert', 'crit', 'err', 'warning', 'notice', 'info', 'debug', 'nolog'. |
macro | stringoptional | Use predefined macro (e.g. 'SSH', 'HTTP', 'HTTPS', 'Ping'). |
pos | integeroptional | Rule position (-1 = append). |
proto | stringoptional | Protocol (tcp, udp, icmp, etc.). |
source | stringoptional | Source address/range (CIDR or alias). |
sport | stringoptional | Source port(s). |
create_containerCreate a new LXC container.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
ostemplate | string | Template volume (e.g. 'local:vztmpl/debian-12-standard_12.2-1_amd64.tar.zst'). |
vmid | integer | The container ID. |
cores | integeroptional | CPU cores (default 1). |
cpulimit | numberoptional | CPU limit (0 = unlimited). |
description | stringoptional | Container description. |
features | stringoptional | Comma-separated features (e.g. 'nesting=1,keyctl=1'). |
hostname | stringoptional | Container hostname. |
memory | integeroptional | Memory in MB (default 512). |
mp0 | stringoptional | Mount point (e.g. 'local-lvm:4,mp=/mnt/data'). |
nameserver | stringoptional | DNS nameserver. |
net0 | stringoptional | Network config (e.g. 'name=eth0,bridge=vmbr0,ip=dhcp'). |
onboot | booleanoptional | Start on host boot. |
password | stringoptional | Root password. |
pool | stringoptional | Resource pool. |
rootfs | stringoptional | Root filesystem spec (e.g. 'local-lvm:8' for 8GB). |
searchdomain | stringoptional | DNS search domain. |
ssh_public_keys | stringoptional | SSH public keys (newline delimited). |
start | booleanoptional | Start after creation. |
storage | stringoptional | Storage for rootfs (default 'local'). |
swap | integeroptional | Swap in MB (default 512). |
tags | stringoptional | Semicolon-separated tags. |
unprivileged | booleanoptional | Create an unprivileged container (default True, recommended). |
create_container_firewall_ruleCreate a firewall rule for an LXC container.
| Parameters | Type | Description |
|---|---|---|
action | string | 'ACCEPT', 'DROP', 'REJECT'. |
node | string | The node name. |
type | string | 'in', 'out', 'group'. |
vmid | integer | The container ID. |
comment | stringoptional | Description. |
dest | stringoptional | Destination CIDR or alias. |
dport | stringoptional | Destination port(s). |
enable | integeroptional | 1 = enabled, 0 = disabled. |
macro | stringoptional | Predefined macro. |
proto | stringoptional | Protocol. |
source | stringoptional | Source CIDR or alias. |
create_container_snapshotCreate a snapshot of a container.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
snapname | string | Snapshot name. |
vmid | integer | The container ID. |
description | stringoptional | Snapshot description. |
create_directory_storageCreate a directory-based storage mount from a device.
| Parameters | Type | Description |
|---|---|---|
device | string | Block device path. |
name | string | Storage name. |
node | string | The node name. |
add_to_storage | booleanoptional | Auto-add as Proxmox storage. |
filesystem | stringoptional | Filesystem type (ext4, xfs). |
create_firewall_aliasCreate a firewall alias (named IP address or CIDR).
| Parameters | Type | Description |
|---|---|---|
cidr | string | IP address or CIDR (e.g. '10.0.0.0/24' or '192.168.1.1'). |
name | string | Alias name. |
comment | stringoptional | Description. |
create_firewall_groupCreate a new firewall security group.
| Parameters | Type | Description |
|---|---|---|
group | string | Group name. |
comment | stringoptional | Description. |
create_firewall_group_ruleAdd a rule to a firewall security group.
| Parameters | Type | Description |
|---|---|---|
action | string | 'ACCEPT', 'DROP', 'REJECT'. |
group | string | Security group name. |
type | string | 'in', 'out'. |
comment | stringoptional | Description. |
dest | stringoptional | Destination address/range. |
dport | stringoptional | Destination port(s). |
enable | integeroptional | 1 = enabled, 0 = disabled. |
macro | stringoptional | Predefined macro. |
proto | stringoptional | Protocol. |
source | stringoptional | Source address/range. |
sport | stringoptional | Source port(s). |
create_firewall_ipsetCreate a new firewall IP set.
| Parameters | Type | Description |
|---|---|---|
name | string | IP set name. |
comment | stringoptional | Description. |
create_groupCreate a new group.
| Parameters | Type | Description |
|---|---|---|
groupid | string | Group ID. |
comment | stringoptional | Description. |
create_ha_groupCreate an HA group.
| Parameters | Type | Description |
|---|---|---|
group | string | Group ID. |
nodes | string | Node list with optional priority (e.g. 'node1:2,node2:1' — higher = preferred). |
comment | stringoptional | Description. |
nofailback | booleanoptional | If true, don't fail back to higher-priority nodes once recovered. |
restricted | booleanoptional | Only run on nodes in this group (otherwise runs anywhere but prefers group nodes). |
create_ha_resourceAdd a resource to HA management.
| Parameters | Type | Description |
|---|---|---|
sid | string | Resource ID (format: 'type:vmid', e.g. 'vm:100' or 'ct:101'). |
comment | stringoptional | Description. |
group | stringoptional | HA group name. |
max_relocate | integeroptional | Max relocations on failure. |
max_restart | integeroptional | Max restarts on failure. |
state | stringoptional | Desired state: 'started', 'stopped', 'enabled', 'disabled', 'ignored'. |
create_lvmCreate a new LVM volume group on a device.
| Parameters | Type | Description |
|---|---|---|
device | string | Block device path (e.g. '/dev/sdb'). |
name | string | VG name. |
node | string | The node name. |
add_to_storage | booleanoptional | Auto-add as Proxmox storage. |
create_lvmthinCreate a new LVM thin pool.
| Parameters | Type | Description |
|---|---|---|
device | string | Block device path. |
name | string | Thin pool name. |
node | string | The node name. |
add_to_storage | booleanoptional | Auto-add as Proxmox storage. |
create_node_network_interfaceCreate a network interface on a node.
| Parameters | Type | Description |
|---|---|---|
iface | string | Interface name (e.g. 'vmbr1'). |
node | string | The node name. |
type | string | Interface type (bridge, bond, eth, alias, vlan, OVSBridge, OVSPort, OVSIntPort, OVSBond). |
address | stringoptional | IP address (CIDR notation or IP). |
autostart | booleanoptional | Whether to start on boot. |
bridge_ports | stringoptional | Bridge ports (for bridge type). |
comments | stringoptional | Comments for the interface. |
gateway | stringoptional | Default gateway. |
netmask | stringoptional | Subnet mask. |
create_poolCreate a resource pool.
| Parameters | Type | Description |
|---|---|---|
poolid | string | Pool ID. |
comment | stringoptional | Description. |
create_replication_jobCreate a storage replication job.
| Parameters | Type | Description |
|---|---|---|
id | string | Job ID (format: GUEST-JOBNUM, e.g. '100-0'). |
target | string | Target node. |
comment | stringoptional | Description. |
disable | booleanoptional | Create disabled. |
rate | numberoptional | Rate limit in mbps. |
schedule | stringoptional | Schedule in systemd calendar format (default '*/15' = every 15 min). |
type | stringoptional | Replication type (currently only 'local'). |
create_roleCreate a new role with specific privileges.
| Parameters | Type | Description |
|---|---|---|
privs | string | Comma-separated list of privileges (e.g. 'VM.Allocate,VM.Config.Disk,VM.PowerMgmt'). |
roleid | string | Role ID. |
create_sdn_subnetCreate a subnet for an SDN VNet.
| Parameters | Type | Description |
|---|---|---|
subnet | string | Subnet CIDR (e.g. '10.0.0.0/24'). |
vnet | string | VNet ID. |
dnszoneprefix | stringoptional | DNS zone prefix. |
gateway | stringoptional | Gateway IP. |
snat | booleanoptional | Enable SNAT. |
create_sdn_vnetCreate an SDN VNet.
| Parameters | Type | Description |
|---|---|---|
vnet | string | VNet ID. |
zone | string | Zone ID. |
alias | stringoptional | Display alias. |
tag | integeroptional | VLAN tag. |
vlanaware | booleanoptional | Enable VLAN-aware bridge. |
create_sdn_zoneCreate an SDN zone.
| Parameters | Type | Description |
|---|---|---|
type | string | Zone type: 'simple', 'vlan', 'qinq', 'vxlan', 'evpn'. |
zone | string | Zone ID. |
bridge | stringoptional | Bridge name. |
dns | stringoptional | DNS plugin name. |
ipam | stringoptional | IPAM plugin name. |
mtu | integeroptional | MTU. |
nodes | stringoptional | Comma-separated node list. |
create_storageCreate a new storage pool configuration.
| Parameters | Type | Description |
|---|---|---|
storage | string | Storage ID. |
type | string | Storage type: dir, lvm, lvmthin, zfspool, nfs, cifs, iscsi, rbd, cephfs, pbs, glusterfs, btrfs. |
content | stringoptional | Comma-separated content types (images, rootdir, vztmpl, iso, backup, snippets, import). |
datastore | stringoptional | PBS datastore name. |
disable | booleanoptional | Create disabled. |
export | stringoptional | NFS export path. |
maxfiles | integeroptional | Max backup files (0 = unlimited). |
nodes | stringoptional | Restrict storage to these nodes (comma-separated). |
path | stringoptional | File system path (for dir, nfs mounts). |
pool | stringoptional | Pool name (for Ceph RBD/CephFS, ZFS). |
portal | stringoptional | iSCSI portal. |
prune_backups | stringoptional | Backup retention policy. |
server | stringoptional | Server IP/hostname (for nfs, cifs, iscsi, pbs, glusterfs, rbd, cephfs). |
shared | booleanoptional | Mark as shared storage. |
target | stringoptional | iSCSI target. |
thinpool | stringoptional | LVM thin pool name (for lvmthin). |
vgname | stringoptional | LVM volume group name. |
create_userCreate a new user.
| Parameters | Type | Description |
|---|---|---|
userid | string | User ID (format: 'user@realm', e.g. 'myuser@pve'). |
comment | stringoptional | Description. |
email | stringoptional | Email address. |
enable | booleanoptional | Enable user. |
expire | integeroptional | Account expiration (Unix epoch, 0 = never). |
firstname | stringoptional | First name. |
groups | stringoptional | Comma-separated group list. |
lastname | stringoptional | Last name. |
password | stringoptional | Password (only for pve/pam realms). |
create_user_tokenCreate a new API token for a user. Returns the token value (shown only once).
| Parameters | Type | Description |
|---|---|---|
tokenid | string | Token ID (alphanumeric). |
userid | string | User ID (format: 'user@realm'). |
comment | stringoptional | Token description. |
expire | integeroptional | Expiration (Unix epoch, 0 = never). |
privsep | booleanoptional | Enable privilege separation (token has own permissions, not user's full permissions). |
create_vmCreate a new QEMU virtual machine.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID number. |
agent | stringoptional | QEMU guest agent: '1' to enable, 'enabled=1,fstrim_cloned_disks=1'. |
bios | stringoptional | BIOS type: seabios, ovmf (UEFI). |
boot | stringoptional | Boot order (e.g. 'order=scsi0;ide2;net0'). |
cdrom | stringoptional | CD-ROM ISO image path. |
cores | integeroptional | Number of CPU cores per socket (default 1). |
cpu | stringoptional | CPU type (default 'host'). |
description | stringoptional | VM description. |
ide2 | stringoptional | IDE device, often used for CD-ROM (e.g. 'local:iso/ubuntu.iso,media=cdrom'). |
machine | stringoptional | Machine type (e.g. 'q35', 'i440fx'). |
memory | integeroptional | Memory in MB (default 2048). |
name | stringoptional | VM name. |
net0 | stringoptional | Network device (e.g. 'virtio,bridge=vmbr0'). |
onboot | booleanoptional | Start on host boot. |
ostype | stringoptional | OS type: l26 (Linux 2.6+), win10, win11, wxp, other, etc. |
pool | stringoptional | Resource pool to add the VM to. |
scsi0 | stringoptional | First SCSI disk (e.g. 'local-lvm:32' for 32GB on local-lvm). |
scsihw | stringoptional | SCSI controller: virtio-scsi-single, virtio-scsi-pci, lsi, megasas, pvscsi. |
sockets | integeroptional | Number of CPU sockets (default 1). |
start | booleanoptional | Start the VM after creation. |
tags | stringoptional | Semicolon-separated tags. |
create_vm_firewall_ruleCreate a firewall rule for a QEMU VM.
| Parameters | Type | Description |
|---|---|---|
action | string | 'ACCEPT', 'DROP', 'REJECT'. |
node | string | The node name. |
type | string | 'in', 'out', 'group'. |
vmid | integer | The VM ID. |
comment | stringoptional | Description. |
dest | stringoptional | Destination CIDR or alias. |
dport | stringoptional | Destination port(s). |
enable | integeroptional | 1 = enabled, 0 = disabled. |
macro | stringoptional | Predefined macro. |
proto | stringoptional | Protocol. |
source | stringoptional | Source CIDR or alias. |
create_vm_snapshotCreate a snapshot of a VM.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
snapname | string | Snapshot name. |
vmid | integer | The VM ID. |
description | stringoptional | Snapshot description. |
vmstate | booleanoptional | Include RAM state (for running VMs). |
create_vzdumpStart an immediate backup (vzdump) on a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node to run the backup on. |
all_guests | booleanoptional | Back up all guests on the node. |
compress | stringoptional | Compression: 'none', 'lzo', 'gzip', 'zstd'. |
mode | stringoptional | Backup mode: 'snapshot', 'suspend', 'stop'. |
stdout | booleanoptional | Write to stdout instead of storage. |
storage | stringoptional | Target storage (empty = default). |
vmid | stringoptional | Comma-separated VMIDs (required if not all_guests). |
create_zfs_poolCreate a new ZFS pool.
| Parameters | Type | Description |
|---|---|---|
devices | string | Space-separated device paths (e.g. '/dev/sdb /dev/sdc'). |
name | string | Pool name. |
node | string | The node name. |
raidlevel | string | RAID level: single, mirror, raid10, raidz, raidz2, raidz3, draid, draid2, draid3. |
add_to_storage | booleanoptional | Auto-add as Proxmox storage. |
ashift | integeroptional | ashift value (default 12). |
compression | stringoptional | Compression (on, off, lz4, zstd, etc.). |
delete_backup_jobDelete a scheduled backup job.
| Parameters | Type | Description |
|---|---|---|
id | string | Backup job ID. |
delete_cluster_firewall_ruleDelete a cluster-level firewall rule.
| Parameters | Type | Description |
|---|---|---|
pos | integer | Rule position to delete. |
delete_containerDelete a container. Must be stopped first unless force=True.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID. |
destroy_unreferenced_disks | booleanoptional | Destroy unreferenced disks. |
force | booleanoptional | Force destroy even if running. |
purge | booleanoptional | Remove from replication, HA, backup and ACLs too. |
delete_container_snapshotDelete a container snapshot.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
snapname | string | Snapshot name. |
vmid | integer | The container ID. |
force | booleanoptional | Force delete. |
delete_firewall_aliasDelete a firewall alias.
| Parameters | Type | Description |
|---|---|---|
name | string | Alias name. |
delete_firewall_ipset_entryRemove an IP/CIDR from an IP set.
| Parameters | Type | Description |
|---|---|---|
cidr | string | IP address or CIDR to remove. |
name | string | IP set name. |
delete_groupDelete a group.
| Parameters | Type | Description |
|---|---|---|
groupid | string | Group ID. |
delete_ha_groupDelete an HA group.
| Parameters | Type | Description |
|---|---|---|
group | string | Group ID. |
delete_ha_resourceRemove a resource from HA management.
| Parameters | Type | Description |
|---|---|---|
sid | string | Resource ID (format: 'type:vmid'). |
delete_poolDelete a resource pool.
| Parameters | Type | Description |
|---|---|---|
poolid | string | Pool ID. |
delete_replication_jobDelete a replication job.
| Parameters | Type | Description |
|---|---|---|
id | string | Replication job ID. |
force | booleanoptional | Force removal (skip cleanup). |
keep | booleanoptional | Keep replicated data on target. |
delete_roleDelete a role.
| Parameters | Type | Description |
|---|---|---|
roleid | string | Role ID. |
delete_sdn_vnetDelete an SDN VNet.
| Parameters | Type | Description |
|---|---|---|
vnet | string | VNet ID. |
delete_sdn_zoneDelete an SDN zone.
| Parameters | Type | Description |
|---|---|---|
zone | string | Zone ID. |
delete_storageDelete a storage pool configuration (does not delete data on the backend).
| Parameters | Type | Description |
|---|---|---|
storage | string | The storage ID. |
delete_storage_volumeDelete a volume from storage.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
storage | string | The storage ID. |
volume | string | The volume ID. |
delete_userDelete a user.
| Parameters | Type | Description |
|---|---|---|
userid | string | User ID to delete (format: 'user@realm'). |
delete_user_tokenDelete an API token.
| Parameters | Type | Description |
|---|---|---|
tokenid | string | Token ID. |
userid | string | User ID (format: 'user@realm'). |
delete_vmDelete a VM. The VM must be stopped first.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
destroy_unreferenced_disks | booleanoptional | Also destroy unreferenced disks owned by the VM. |
purge | booleanoptional | Remove from replication, HA, backup jobs and ACLs too. |
delete_vm_snapshotDelete a VM snapshot.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
snapname | string | Snapshot name to delete. |
vmid | integer | The VM ID. |
force | booleanoptional | Force delete even if snapshot is in use. |
download_appliance_templateDownload an appliance template to local storage.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
storage | string | Target storage ID. |
template | string | Template name to download. |
download_file_restoreDownload a file from a vzdump backup.
| Parameters | Type | Description |
|---|---|---|
filepath | string | Path of the file to download from the backup. |
node | string | The node name. |
storage | string | Storage ID. |
volume | string | Backup volume ID. |
download_url_to_storageDownload a file from a URL directly to storage (ISO, template, etc.).
| Parameters | Type | Description |
|---|---|---|
content | string | Content type: 'iso', 'vztmpl'. |
filename | string | Target filename. |
node | string | The node name. |
storage | string | The storage ID. |
url | string | URL to download from. |
checksum | stringoptional | Expected checksum. |
checksum_algorithm | stringoptional | Checksum algorithm (sha256, sha512, md5). |
dump_vm_cloudinitDump the Cloud-Init generated config file (user-data, network-data, or meta-data).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
type | stringoptional | Config type: 'user', 'network', or 'meta'. |
get_aclGet the full ACL (access control list) — shows all permission assignments.
get_acme_accountGet ACME account details.
| Parameters | Type | Description |
|---|---|---|
name | stringoptional | Account name (default: 'default'). |
get_acme_directoriesList known ACME directory URLs.
get_acme_pluginGet ACME plugin configuration.
| Parameters | Type | Description |
|---|---|---|
id | string | Plugin ID. |
get_acme_tosGet the ACME Terms of Service URL.
get_auth_domainGet authentication domain configuration.
| Parameters | Type | Description |
|---|---|---|
realm | string | Realm ID (e.g. 'pam', 'pve', 'my-ldap'). |
get_backup_jobGet details of a specific backup job.
| Parameters | Type | Description |
|---|---|---|
id | string | Backup job ID. |
get_backup_job_included_volumesGet volumes included in a backup job.
| Parameters | Type | Description |
|---|---|---|
id | string | Backup job ID. |
get_ceph_configGet the raw Ceph configuration.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_ceph_crush_rulesGet Ceph CRUSH rules.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
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.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
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.
| Parameters | Type | Description |
|---|---|---|
pos | integer | Rule position number. |
get_cluster_join_infoGet info needed to join a node to this cluster.
get_cluster_logGet the cluster log (recent events).
| Parameters | Type | Description |
|---|---|---|
max_entries | integeroptional | Max log entries. |
get_cluster_optionsGet datacenter/cluster-wide options (keyboard layout, console, language, etc.).
get_cluster_resourcesList all resources across the cluster (VMs, containers, storage, nodes).
| Parameters | Type | Description |
|---|---|---|
type | stringoptional | Filter by type: 'vm', 'storage', 'node', 'sdn', 'pool' (empty = all). |
get_cluster_statusGet cluster status (nodes online, quorum, HA state).
get_cluster_tasksList recent tasks across all nodes in the cluster.
| Parameters | Type | Description |
|---|---|---|
limit | integeroptional | Maximum number of tasks to return. |
get_cluster_totemGet the corosync totem configuration.
get_container_configGet the configuration of a container.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID. |
get_container_featureCheck if a feature is available for a container (snapshot, clone, copy).
| Parameters | Type | Description |
|---|---|---|
feature | string | Feature to check ('snapshot', 'clone', 'copy'). |
node | string | The node name. |
vmid | integer | The container ID. |
get_container_firewall_optionsGet firewall options for an LXC container.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID. |
get_container_interfacesGet network interfaces and IPs of a running container.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID. |
get_container_pendingGet pending configuration changes for a container.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID. |
get_container_rrddataGet RRD statistics data for a container (CPU, memory, disk, network over time).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID. |
timeframe | stringoptional | Time range: 'hour', 'day', 'week', 'month', 'year'. |
get_container_statusGet the current runtime status of a container.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID (CTID). |
get_disk_smartGet S.M.A.R.T. health data for a disk.
| Parameters | Type | Description |
|---|---|---|
disk | string | Disk device path (e.g. '/dev/sda'). |
node | string | The node name. |
get_firewall_group_rulesList rules in a firewall security group.
| Parameters | Type | Description |
|---|---|---|
group | string | Security group name. |
get_firewall_refsGet available firewall references (aliases, ipsets, names usable in rules).
get_groupGet group details.
| Parameters | Type | Description |
|---|---|---|
groupid | string | Group ID. |
get_ha_groupGet HA group configuration.
| Parameters | Type | Description |
|---|---|---|
group | string | Group ID. |
get_ha_manager_statusGet detailed HA manager status.
get_ha_resourceGet HA resource configuration.
| Parameters | Type | Description |
|---|---|---|
sid | string | HA resource ID (format: 'type:vmid', e.g. 'vm:100' or 'ct:101'). |
get_ha_statusGet HA manager status (active, quorum, manager status).
get_metric_serverGet metric server configuration.
| Parameters | Type | Description |
|---|---|---|
id | string | Metric server ID. |
get_next_vmidGet the next available VMID in the cluster.
| Parameters | Type | Description |
|---|---|---|
vmid | integeroptional | Specific VMID to check availability for (0 = auto-assign). |
get_node_aplinfoList available appliance templates (LXC templates) that can be downloaded.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_node_apt_updateList available package updates on a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_node_capabilities_qemuGet QEMU capabilities for a node: supported CPU models, machine types, etc.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_node_certificatesGet certificate info for a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_node_configGet the configuration of a node (description, wakeonlan, etc.).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_node_disksList physical disks on a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_node_dnsGet DNS settings for a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_node_firewall_logGet firewall log for a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
limit | integeroptional | Max entries. |
get_node_firewall_optionsGet firewall options for a specific node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_node_hardware_pciList PCI hardware devices on a node (for passthrough).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_node_hardware_usbList USB hardware devices on a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_node_hostsGet the /etc/hosts file content for a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_node_journalRead systemd journal entries from a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
lastentries | integeroptional | Max number of entries (default 50). |
since | stringoptional | Show entries since date/time. |
startcursor | stringoptional | Start cursor for paging. |
until | stringoptional | Show entries until date/time. |
get_node_netstatGet network statistics for a node (per-interface traffic).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_node_networkGet network interface configuration for a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_node_network_interfaceGet details for a specific network interface.
| Parameters | Type | Description |
|---|---|---|
iface | string | Interface name (e.g. 'vmbr0', 'eth0'). |
node | string | The node name. |
get_node_reportGenerate a system report for a node (useful for diagnostics).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_node_statusGet detailed status of a specific node including CPU, memory, disk, uptime, and kernel info.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name (e.g. 'pve1'). |
get_node_storage_scanScan for available storage targets (NFS, CIFS, iSCSI, LVM, ZFS, PBS).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
scan_type | string | Type to scan: 'nfs', 'cifs', 'iscsi', 'lvm', 'lvmthin', 'zfs', 'pbs'. |
server | stringoptional | Server address (required for nfs, cifs, iscsi, pbs). |
get_node_storage_statusGet usage status of a storage pool on a node (total, used, available).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
storage | string | The storage ID. |
get_node_subscriptionGet subscription status for a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_node_syslogRead system log (syslog) entries from a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
limit | integeroptional | Max number of log lines to return (default 50). |
since | stringoptional | Only show entries since this date (YYYY-MM-DD). |
start | integeroptional | Start line number. |
until | stringoptional | Only show entries until this date (YYYY-MM-DD). |
get_node_timeGet the current time and timezone of a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_node_versionGet Proxmox VE version information for a specific node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_permissionsCheck effective permissions for a user on a given path.
| Parameters | Type | Description |
|---|---|---|
path | stringoptional | Object path to check (empty = root). |
userid | stringoptional | User to check (empty = current user). |
get_poolGet pool configuration and members.
| Parameters | Type | Description |
|---|---|---|
poolid | string | Pool ID. |
get_replication_jobGet a specific replication job configuration.
| Parameters | Type | Description |
|---|---|---|
id | string | Replication job ID (format: GUEST-JOBNUM, e.g. '100-0'). |
get_roleGet role details and its privileges.
| Parameters | Type | Description |
|---|---|---|
roleid | string | Role ID. |
get_sdn_controllerGet SDN controller configuration.
| Parameters | Type | Description |
|---|---|---|
controller | string | Controller ID. |
get_sdn_ipamGet IPAM plugin configuration.
| Parameters | Type | Description |
|---|---|---|
ipam | string | IPAM ID. |
get_sdn_vnetGet SDN VNet configuration.
| Parameters | Type | Description |
|---|---|---|
vnet | string | VNet ID. |
get_sdn_zoneGet SDN zone configuration.
| Parameters | Type | Description |
|---|---|---|
zone | string | Zone ID. |
get_storage_configGet configuration of a specific storage pool.
| Parameters | Type | Description |
|---|---|---|
storage | string | The storage ID. |
get_storage_rrddataGet RRD statistics for a storage pool (usage over time).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
storage | string | The storage ID. |
timeframe | stringoptional | Time range: 'hour', 'day', 'week', 'month', 'year'. |
get_storage_volume_infoGet details about a specific volume in storage.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
storage | string | The storage ID. |
volume | string | The volume ID. |
get_task_logGet log output of a specific task.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
upid | string | The task UPID string. |
limit | integeroptional | Max lines to return. |
start | integeroptional | Start line number. |
get_task_statusGet the status of a specific task by its UPID.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
upid | string | The task UPID string. |
get_userGet details for a specific user.
| Parameters | Type | Description |
|---|---|---|
userid | string | User ID (format: 'user@realm', e.g. 'admin@pam'). |
get_user_tokenGet details for a specific API token.
| Parameters | Type | Description |
|---|---|---|
tokenid | string | Token ID. |
userid | string | User ID (format: 'user@realm'). |
get_versionGet the Proxmox VE API version information.
get_vm_cloudinitGet Cloud-Init configuration for a VM.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
get_vm_configGet the configuration of a VM.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
current | booleanoptional | If True, return current (runtime) config. If False, return pending config. |
get_vm_featureCheck if a specific feature is available/supported for a VM (e.g. snapshot, clone, copy).
| Parameters | Type | Description |
|---|---|---|
feature | string | Feature to check ('snapshot', 'clone', 'copy'). |
node | string | The node name. |
vmid | integer | The VM ID. |
get_vm_firewall_optionsGet firewall options for a QEMU VM.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
get_vm_pendingGet pending configuration changes for a VM (not yet applied).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
get_vm_rrddataGet RRD statistics data for a VM (CPU, memory, disk, network over time).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
timeframe | stringoptional | Time range: 'hour', 'day', 'week', 'month', 'year'. |
get_vm_snapshot_configGet the configuration stored in a VM snapshot.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
snapname | string | The snapshot name. |
vmid | integer | The VM ID. |
get_vm_spiceproxyCreate a SPICE proxy connection for a VM console.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
get_vm_statusGet the current runtime status of a VM (state, CPU, memory, disk, network, uptime).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
get_vm_vncproxyCreate a VNC proxy connection ticket for a VM (for console access).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
websocket | booleanoptional | Use WebSocket connection. |
get_vzdump_defaultsGet the default vzdump configuration for a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
get_vzdump_extractconfigExtract the guest configuration from a vzdump backup archive.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
volume | string | Backup volume ID (e.g. 'local:backup/vzdump-qemu-100-2024_01_01-00_00_00.vma.zst'). |
get_zfs_poolGet details of a ZFS pool.
| Parameters | Type | Description |
|---|---|---|
name | string | ZFS pool name. |
node | string | The node name. |
initialize_gptInitialize a disk with GPT partition table (WARNING: destroys all data).
| Parameters | Type | Description |
|---|---|---|
disk | string | Disk device path (e.g. '/dev/sdb'). |
node | string | The node name. |
join_clusterJoin a node to an existing cluster.
| Parameters | Type | Description |
|---|---|---|
fingerprint | string | SSL fingerprint of the cluster node. |
hostname | string | Hostname/IP of existing cluster node. |
password | string | Root password of the cluster node. |
force | booleanoptional | Force join even with warnings. |
nodeid | integeroptional | Force specific node ID. |
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.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
storage | string | Storage ID. |
volume | string | Backup volume ID. |
filepath | stringoptional | Path within the backup (default '/'). |
list_backup_jobsList all scheduled backup jobs (vzdump) in the cluster.
list_ceph_fsList CephFS filesystems.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
list_ceph_managersList Ceph managers.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
list_ceph_mdsList Ceph metadata servers (MDS, for CephFS).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
list_ceph_monitorsList Ceph monitors.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
list_ceph_osdsList Ceph OSDs on a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
list_ceph_poolsList Ceph pools.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
list_cluster_firewall_rulesList cluster-level firewall rules.
list_container_firewall_rulesList firewall rules for an LXC container.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID. |
list_container_snapshotsList all snapshots of a container.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID. |
list_containersList all LXC containers on a node with status, memory, CPU, and disk info.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
list_dir_mappingsList directory mappings.
list_directory_storageList directory-based storage mounts on a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
list_file_restoreList files in a backup volume for file-level restore (PBS backups).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
storage | string | The storage ID. |
volume | string | The backup volume ID. |
filepath | stringoptional | Path inside the backup to list (default '/'). |
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.
| Parameters | Type | Description |
|---|---|---|
name | string | IP set name. |
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.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
list_lvmthin_poolsList LVM thin pools on a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
list_metric_serversList configured metric servers (InfluxDB, Graphite).
list_node_firewall_rulesList firewall rules for a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
list_node_servicesList all system services on a node (pve, ssh, cron, etc.).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
list_node_storageList storage pools available on a specific node with usage info.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
content | stringoptional | Filter by content type (images, rootdir, vztmpl, iso, backup). |
enabled | booleanoptional | Only show enabled storage. |
list_node_tasksList recent tasks on a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
limit | integeroptional | Max tasks to return (default 50). |
start | integeroptional | Offset for paging. |
statusfilter | stringoptional | Filter by status ('running', 'ok', 'error', etc.). |
typefilter | stringoptional | Filter by task type (e.g. 'qmstart', 'vzstart', 'vzcreate'). |
vmid | integeroptional | Filter by VM ID (0 = all). |
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. EVPN controller).
list_sdn_dnsList SDN DNS plugins.
list_sdn_ipamsList IPAM (IP Address Management) plugins.
list_sdn_subnetsList subnets for an SDN VNet.
| Parameters | Type | Description |
|---|---|---|
vnet | string | VNet ID. |
list_sdn_vnetsList SDN virtual networks (VNets).
list_sdn_zonesList SDN zones.
list_storageList all configured storage pools at the datacenter level.
| Parameters | Type | Description |
|---|---|---|
enabled | booleanoptional | Only show enabled storage (default True). |
type | stringoptional | Filter by type (dir, lvm, lvmthin, zfspool, nfs, cifs, iscsi, rbd, cephfs, pbs, glusterfs, btrfs). |
list_storage_contentList content of a storage pool (disk images, ISOs, templates, backups).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
storage | string | The storage ID. |
content | stringoptional | Filter by type: 'images', 'rootdir', 'vztmpl', 'iso', 'backup', 'snippets'. |
vmid | integeroptional | Filter by VM ID. |
list_tfaList TFA (two-factor auth) entries.
| Parameters | Type | Description |
|---|---|---|
userid | stringoptional | Filter by user ID (empty = all users). |
list_usb_mappingsList USB device mappings for passthrough.
list_user_tokensList API tokens for a user.
| Parameters | Type | Description |
|---|---|---|
userid | string | User ID (format: 'user@realm'). |
list_usersList all users in Proxmox.
| Parameters | Type | Description |
|---|---|---|
enabled | booleanoptional | Only show enabled users. |
full | booleanoptional | Include detailed info (groups, tokens, etc.). |
list_vm_firewall_rulesList firewall rules for a QEMU VM.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
list_vm_snapshotsList all snapshots of a VM.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
list_vmsList all QEMU virtual machines on a node with status, memory, CPU, and disk info.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
list_zfs_poolsList ZFS pools on a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
manage_node_serviceStart, stop, restart, or reload a system service on a node.
| Parameters | Type | Description |
|---|---|---|
action | string | One of 'start', 'stop', 'restart', 'reload'. |
node | string | The node name. |
service | string | Service name (e.g. 'pvedaemon', 'pveproxy', 'ssh', 'cron', 'postfix'). |
migrate_containerMigrate a container to another node.
| Parameters | Type | Description |
|---|---|---|
node | string | The source node. |
target | string | Target node name. |
vmid | integer | The container ID. |
online | booleanoptional | Live migration. |
restart | booleanoptional | Restart container after migration (for non-live). |
target_storage | stringoptional | Target storage mapping. |
migrate_ha_resourceRequest migration of an HA resource to a different node.
| Parameters | Type | Description |
|---|---|---|
node | string | Target node. |
sid | string | Resource ID. |
migrate_vmMigrate a VM to another node in the cluster.
| Parameters | Type | Description |
|---|---|---|
node | string | The source node. |
target | string | Target node name. |
vmid | integer | The VM ID. |
online | booleanoptional | Live migration (True) or offline (False). |
targetstorage | stringoptional | Target storage mapping for migration (e.g. 'local-lvm'). |
with_local_disks | booleanoptional | Migrate local disks as well. |
move_container_volumeMove a container volume to different storage or to another container.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID. |
volume | string | Volume name (e.g. 'rootfs', 'mp0'). |
delete_original | booleanoptional | Delete original after move. |
storage | stringoptional | Target storage. |
target_vmid | integeroptional | Target container ID. |
target_volume | stringoptional | Target volume slot. |
move_vm_diskMove a VM disk to different storage or attach to another VM.
| Parameters | Type | Description |
|---|---|---|
disk | string | Source disk name (e.g. 'scsi0'). |
node | string | The node name. |
vmid | integer | The VM ID. |
delete_original | booleanoptional | Delete the original disk after moving. |
storage | stringoptional | Target storage ID (for moving to different storage). |
target_disk | stringoptional | Target disk slot on the target VM. |
target_vmid | integeroptional | Target VM ID (for moving disk to another VM). |
order_node_certificateOrder/renew ACME certificate for a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
force | booleanoptional | Force renewal even if not due. |
proxmox_api_rawMake an arbitrary Proxmox API call for any endpoint not covered by specific tools.
| Parameters | Type | Description |
|---|---|---|
method | string | HTTP method: 'get', 'post', 'put', 'delete'. |
path | string | API path (e.g. '/nodes/pve1/qemu/100/status/current'). |
params | stringoptional | JSON string of parameters (e.g. '{"memory": 4096}'). |
prune_storage_backupsPrune (delete) old backups from storage according to retention policy.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
storage | string | The storage ID. |
dry_run | booleanoptional | If True, only simulate (default True for safety). |
prune_backups | stringoptional | Retention spec (e.g. 'keep-last=3,keep-daily=7,keep-weekly=4'). |
type | stringoptional | Guest type filter ('qemu' or 'lxc'). |
vmid | integeroptional | Filter by VM ID. |
reboot_containerReboot a container.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID. |
timeout | integeroptional | Timeout in seconds. |
reboot_vmReboot a VM via ACPI.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
timeout | integeroptional | Wait timeout in seconds. |
register_acme_accountRegister a new ACME account.
| Parameters | Type | Description |
|---|---|---|
contact | string | Contact email address. |
directory | stringoptional | ACME directory URL (empty = Let's Encrypt production). |
name | stringoptional | Account name. |
tos_url | stringoptional | Terms of service URL to accept. |
relocate_ha_resourceRequest relocation of an HA resource to a different node.
| Parameters | Type | Description |
|---|---|---|
node | string | Target node. |
sid | string | Resource ID. |
reset_vmHard reset a VM (like pressing the reset button).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
resize_container_diskResize a container disk/volume.
| Parameters | Type | Description |
|---|---|---|
disk | string | Disk name (e.g. 'rootfs', 'mp0'). |
node | string | The node name. |
size | string | New size or increment (e.g. '10G', '+2G'). |
vmid | integer | The container ID. |
resize_vm_diskResize a VM disk. Can only grow, not shrink.
| Parameters | Type | Description |
|---|---|---|
disk | string | Disk name (e.g. 'scsi0', 'virtio0', 'ide0'). |
node | string | The node name. |
size | string | New size or size increment (e.g. '50G', '+10G'). |
vmid | integer | The VM ID. |
resume_containerResume a suspended container.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID. |
resume_vmResume a suspended/paused VM.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
rollback_container_snapshotRollback a container to a previous snapshot.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
snapname | string | Snapshot name. |
vmid | integer | The container ID. |
rollback_vm_snapshotRollback a VM to a previous snapshot (current state will be lost).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
snapname | string | The snapshot name to rollback to. |
vmid | integer | The VM ID. |
run_apt_updateRefresh the package index on a node (apt update).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
send_vm_keySend a key event to a VM (e.g. ctrl-alt-del).
| Parameters | Type | Description |
|---|---|---|
key | string | Key combination (e.g. 'ctrl-alt-delete'). |
node | string | The node name. |
vmid | integer | The VM ID. |
send_vm_monitor_commandSend a QEMU monitor command to a VM (advanced/low-level).
| Parameters | Type | Description |
|---|---|---|
command | string | The QEMU monitor command. |
node | string | The node name. |
vmid | integer | The VM ID. |
set_ceph_flagsSet a Ceph global flag.
| Parameters | Type | Description |
|---|---|---|
flag | string | Flag name (noout, noscrub, nobackfill, norebalance, nodown, noup, etc.). |
value | boolean | True to set, False to unset. |
set_cluster_firewall_optionsSet cluster-wide firewall options.
| Parameters | Type | Description |
|---|---|---|
delete | stringoptional | Comma-separated options to delete. |
ebtables | integeroptional | 1 to enable ebtables rules, 0 to disable, -1 to not change. |
enable | integeroptional | 1 to enable, 0 to disable, -1 to not change. |
log_ratelimit | stringoptional | Log rate limit (e.g. 'enable=1,rate=1/second,burst=5'). |
policy_in | stringoptional | Default input policy: 'ACCEPT', 'REJECT', 'DROP'. |
policy_out | stringoptional | Default output policy: 'ACCEPT', 'REJECT', 'DROP'. |
set_node_firewall_optionsSet firewall options for a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
delete | stringoptional | Comma-separated options to delete. |
enable | integeroptional | 1 = enable, 0 = disable, -1 = don't change. |
log_level_in | stringoptional | Input log level. |
log_level_out | stringoptional | Output log level. |
ndp | integeroptional | 1 = enable NDP, 0 = disable, -1 = don't change. |
nf_conntrack_max | integeroptional | Max conntrack entries (0 = don't change). |
set_vm_firewall_optionsSet firewall options for a QEMU VM.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
delete | stringoptional | Comma-separated options to delete. |
dhcp | integeroptional | 1 = enable DHCP. |
enable | integeroptional | 1 = enable, 0 = disable. |
ipfilter | integeroptional | 1 = enable IP filter. |
macfilter | integeroptional | 1 = enable MAC filter. |
policy_in | stringoptional | Input policy. |
policy_out | stringoptional | Output policy. |
shutdown_containerGracefully shut down a container.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID. |
force_stop | booleanoptional | Force stop after timeout. |
timeout | integeroptional | Timeout in seconds before force stop. |
shutdown_vmGracefully shut down a VM via ACPI. Falls back to hard stop after timeout if force_stop is true.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
force_stop | booleanoptional | Force stop after timeout (default True). |
timeout | integeroptional | Timeout in seconds before force stop. |
start_containerStart a container.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID. |
start_vmStart a VM.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
timeout | integeroptional | Timeout in seconds (0 = default). |
startall_nodeStart all VMs and containers on a node (respecting boot order).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
force | booleanoptional | Force start even if already running. |
vms | stringoptional | Comma-separated list of VMIDs to start (empty = all). |
stop_containerHard-stop a container (immediate, like power off).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID. |
stop_taskStop (abort) a running task.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
upid | string | The task UPID string. |
stop_vmHard-stop a VM (like pulling the power plug). Prefer shutdown_vm for graceful stop.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
skiplock | booleanoptional | Ignore locks (requires root). |
timeout | integeroptional | Wait timeout in seconds. |
stopall_nodeStop all VMs and containers on a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vms | stringoptional | Comma-separated list of VMIDs to stop (empty = all). |
suspend_containerSuspend (freeze) a container.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID. |
suspend_vmSuspend a VM (pause execution or hibernate to disk).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
todisk | booleanoptional | If True, hibernate to disk. If False, pause in RAM. |
sync_auth_domainSync users/groups from an external auth domain (LDAP/AD).
| Parameters | Type | Description |
|---|---|---|
realm | string | Realm ID to sync. |
dry_run | booleanoptional | Only show what would change. |
enable_new | booleanoptional | Enable newly synced users. |
full | booleanoptional | Full sync (not just incremental). |
remove_vanished | stringoptional | Comma-separated: 'entry' (remove users), 'properties' (clear), 'acl' (remove ACLs). |
test_notification_targetSend a test notification to a target.
| Parameters | Type | Description |
|---|---|---|
name | string | Target name. |
update_aclAdd or remove ACL entries (permission assignments).
| Parameters | Type | Description |
|---|---|---|
path | string | Object path (e.g. '/', '/vms/100', '/storage/local', '/pool/mypool'). |
roles | string | Comma-separated role list. |
delete | booleanoptional | Remove the ACL entry instead of adding. |
groups | stringoptional | Comma-separated group list. |
propagate | booleanoptional | Propagate permissions to child objects. |
tokens | stringoptional | Comma-separated token list (format: 'user@realm!tokenid'). |
users | stringoptional | Comma-separated user list (format: 'user@realm'). |
update_backup_jobUpdate a scheduled backup job.
| Parameters | Type | Description |
|---|---|---|
id | string | Backup job ID. |
all_guests | booleanoptional | Backup all guests. |
compress | stringoptional | Compression. |
delete | stringoptional | Comma-separated properties to delete. |
enabled | booleanoptional | Enable/disable. |
mode | stringoptional | Backup mode. |
node | stringoptional | Node filter. |
schedule | stringoptional | Schedule in systemd calendar format. |
storage | stringoptional | Target storage ID. |
vmid | stringoptional | Comma-separated VMIDs. |
update_cluster_firewall_ruleUpdate a cluster-level firewall rule.
| Parameters | Type | Description |
|---|---|---|
pos | integer | Rule position to update. |
action | stringoptional | 'ACCEPT', 'DROP', 'REJECT'. |
comment | stringoptional | Description. |
delete | stringoptional | Comma-separated properties to delete. |
dest | stringoptional | Destination address/range. |
dport | stringoptional | Destination port(s). |
enable | integeroptional | 1 = enabled, 0 = disabled, -1 = don't change. |
macro | stringoptional | Predefined macro. |
moveto | integeroptional | Move rule to this position. |
proto | stringoptional | Protocol. |
source | stringoptional | Source address/range. |
sport | stringoptional | Source port(s). |
update_cluster_optionsUpdate datacenter/cluster-wide options.
| Parameters | Type | Description |
|---|---|---|
console | stringoptional | Default console viewer: 'applet', 'vv', 'html5', 'xtermjs'. |
delete | stringoptional | Comma-separated settings to delete. |
description | stringoptional | Datacenter description. |
email_from | stringoptional | Default email sender address. |
http_proxy | stringoptional | HTTP proxy URL. |
keyboard | stringoptional | Keyboard layout (e.g. 'en-us', 'de'). |
language | stringoptional | Default language. |
max_workers | integeroptional | Max parallel workers. |
update_container_configUpdate the configuration of an existing container.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The container ID. |
cores | integeroptional | CPU cores. |
cpulimit | numberoptional | CPU limit (0 = unlimited). |
delete | stringoptional | Comma-separated list of settings to delete. |
description | stringoptional | Description. |
features | stringoptional | Comma-separated features. |
hostname | stringoptional | Container hostname. |
memory | integeroptional | Memory in MB. |
nameserver | stringoptional | DNS nameserver. |
net0 | stringoptional | Network config. |
onboot | stringoptional | Start on boot. |
searchdomain | stringoptional | DNS search domain. |
swap | integeroptional | Swap in MB. |
tags | stringoptional | Semicolon-separated tags. |
update_groupUpdate a group.
| Parameters | Type | Description |
|---|---|---|
groupid | string | Group ID. |
comment | stringoptional | Description. |
update_ha_groupUpdate an HA group.
| Parameters | Type | Description |
|---|---|---|
group | string | Group ID. |
comment | stringoptional | Description. |
delete | stringoptional | Comma-separated properties to delete. |
nodes | stringoptional | Node list with optional priority. |
nofailback | booleanoptional | Don't fail back. |
restricted | booleanoptional | Only run on group nodes. |
update_ha_resourceUpdate an HA resource configuration.
| Parameters | Type | Description |
|---|---|---|
sid | string | Resource ID. |
comment | stringoptional | Description. |
delete | stringoptional | Comma-separated properties to delete. |
group | stringoptional | HA group name. |
max_relocate | integeroptional | Max relocations (-1 = don't change). |
max_restart | integeroptional | Max restarts (-1 = don't change). |
state | stringoptional | Desired state. |
update_poolUpdate a resource pool (add/remove members).
| Parameters | Type | Description |
|---|---|---|
poolid | string | Pool ID. |
comment | stringoptional | Description. |
delete | booleanoptional | If true, remove the specified vms/storage from the pool instead of adding. |
storage | stringoptional | Comma-separated storage IDs to add/remove. |
vms | stringoptional | Comma-separated VMIDs to add/remove. |
update_roleUpdate role privileges.
| Parameters | Type | Description |
|---|---|---|
privs | string | Comma-separated list of privileges. |
roleid | string | Role ID. |
append | booleanoptional | Append privileges instead of replacing. |
update_sdn_vnetUpdate an SDN VNet.
| Parameters | Type | Description |
|---|---|---|
vnet | string | VNet ID. |
alias | stringoptional | Display alias. |
delete | stringoptional | Comma-separated properties to delete. |
tag | integeroptional | VLAN tag (-1 = don't change). |
zone | stringoptional | Zone ID. |
update_storageUpdate an existing storage pool configuration.
| Parameters | Type | Description |
|---|---|---|
storage | string | The storage ID to update. |
content | stringoptional | Content types (images, rootdir, vztmpl, iso, backup, snippets, import). |
delete | stringoptional | Comma-separated list of settings to delete. |
disable | stringoptional | Disable this storage. |
nodes | stringoptional | Allowed nodes (comma-separated). |
prune_backups | stringoptional | Backup retention policy. |
shared | stringoptional | Mark as shared. |
update_userUpdate an existing user.
| Parameters | Type | Description |
|---|---|---|
userid | string | User ID (format: 'user@realm'). |
append | booleanoptional | Append groups instead of replacing. |
comment | stringoptional | Description. |
email | stringoptional | Email address. |
enable | booleanoptional | Enable/disable user. |
expire | integeroptional | Account expiration (Unix epoch, 0 = never, -1 = don't change). |
firstname | stringoptional | First name. |
groups | stringoptional | Comma-separated group list. |
lastname | stringoptional | Last name. |
update_vm_cloudinitSet Cloud-Init parameters for a VM (user, password, SSH keys, network).
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
cipassword | stringoptional | Cloud-Init password. |
ciuser | stringoptional | Cloud-Init user name. |
ipconfig0 | stringoptional | IP config for first interface (e.g. 'ip=dhcp' or 'ip=10.0.0.5/24,gw=10.0.0.1'). |
nameserver | stringoptional | DNS nameserver IP. |
searchdomain | stringoptional | DNS search domain. |
sshkeys | stringoptional | SSH public keys (URL-encoded, newline delimited). |
update_vm_configUpdate the configuration of an existing VM. Only provided parameters are changed.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
agent | stringoptional | Guest agent config. |
boot | stringoptional | Boot order. |
cores | integeroptional | CPU cores per socket. |
cpu | stringoptional | CPU type. |
delete | stringoptional | Comma-separated list of settings to delete. |
description | stringoptional | Description. |
hotplug | stringoptional | Hotplug features (disk, network, usb, memory, cpu). |
memory | integeroptional | Memory in MB. |
name | stringoptional | VM name. |
net0 | stringoptional | Network config. |
onboot | stringoptional | Start on boot. |
sockets | integeroptional | CPU sockets. |
tags | stringoptional | Semicolon-separated tags. |
upload_to_storageUpload a file (ISO, template, etc.) to storage. Note: actual file upload must go through the HTTP API directly.
| Parameters | Type | Description |
|---|---|---|
content | string | Content type: 'iso', 'vztmpl', 'snippets', 'import'. |
filename | string | Target filename. |
node | string | The node name. |
storage | string | The storage ID. |
tmpfilename | stringoptional | Temporary filename for the upload. |
vm_agent_execExecute a command inside a VM via the QEMU Guest Agent.
| Parameters | Type | Description |
|---|---|---|
command | string | The command to execute. |
node | string | The node name. |
vmid | integer | The VM ID. |
input_data | stringoptional | Data to pass to stdin. |
vm_agent_exec_statusGet the status/result of a command previously executed via the guest agent.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
pid | integer | The PID returned by the exec call. |
vmid | integer | The VM ID. |
vm_agent_file_readRead a file from inside a VM via the guest agent.
| Parameters | Type | Description |
|---|---|---|
file | string | Absolute file path inside the guest. |
node | string | The node name. |
vmid | integer | The VM ID. |
vm_agent_file_writeWrite content to a file inside a VM via the guest agent.
| Parameters | Type | Description |
|---|---|---|
content | string | File content to write. |
file | string | Absolute file path inside the guest. |
node | string | The node name. |
vmid | integer | The VM ID. |
vm_agent_get_infoGet various system information from a VM via the guest agent.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
vmid | integer | The VM ID. |
info_type | stringoptional | Info to retrieve: 'get-osinfo', 'get-host-name', 'get-time', |
vm_agent_set_passwordSet a user password inside a VM via the guest agent.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
password | string | The new password. |
username | string | The username. |
vmid | integer | The VM ID. |
crypted | booleanoptional | If True, password is already encrypted. |
wakeonlan_nodeSend a Wake-on-LAN magic packet to a node.
| Parameters | Type | Description |
|---|---|---|
node | string | The node name. |
{
"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"
}
}
}
}