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}').

List all users in Proxmox.

Args: enabled: Only show enabled users. full: Include detailed info (groups, tokens, etc.).

Get details for a specific user.

Args: userid: User ID (format: 'user@realm', e.g. 'admin@pam').

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).

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.

Delete a user.

Args: userid: User ID to delete (format: 'user@realm').

List API tokens for a user.

Args: userid: User ID (format: 'user@realm').

Get details for a specific API token.

Args: userid: User ID (format: 'user@realm'). tokenid: Token ID.

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).

Delete an API token.

Args: userid: User ID (format: 'user@realm'). tokenid: Token ID.

List all user groups.

Get group details.

Args: groupid: Group ID.

Create a new group.

Args: groupid: Group ID. comment: Description.

Update a group.

Args: groupid: Group ID. comment: Description.

Delete a group.

Args: groupid: Group ID.

List all available roles.

Get role details and its privileges.

Args: roleid: Role ID.

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').

Update role privileges.

Args: roleid: Role ID. privs: Comma-separated list of privileges. append: Append privileges instead of replacing.

Delete a role.

Args: roleid: Role ID.

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

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.

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

Get authentication domain configuration.

Args: realm: Realm ID (e.g. 'pam', 'pve', 'my-ldap').

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).

List TFA (two-factor auth) entries.

Args: userid: Filter by user ID (empty = all users).

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).

Change a user's password.

Args: userid: User ID (format: 'user@realm'). password: New password.

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

Get details of a specific backup job.

Args: id: Backup job ID.

Get volumes included in a backup job.

Args: id: Backup job ID.

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.

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.

Delete a scheduled backup job.

Args: id: Backup job ID.

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.

Get the default vzdump configuration for a node.

Args: node: The node name.

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').

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 '/').

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.

Get the Proxmox VE API version information.

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

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

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

List recent tasks across all nodes in the cluster.

Args: limit: Maximum number of tasks to return.

Get the cluster log (recent events).

Args: max_entries: Max log entries.

Get the next available VMID in the cluster.

Args: vmid: Specific VMID to check availability for (0 = auto-assign).

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

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.

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

List nodes configured in the cluster.

Get info needed to join a node to this cluster.

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.

Get the corosync totem configuration.

List all replication jobs in the cluster.

Get a specific replication job configuration.

Args: id: Replication job ID (format: GUEST-JOBNUM, e.g. '100-0').

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.

Delete a replication job.

Args: id: Replication job ID. force: Force removal (skip cleanup). keep: Keep replicated data on target.

List configured metric servers (InfluxDB, Graphite).

Get metric server configuration.

Args: id: Metric server ID.

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

List all notification targets.

List all notification matchers (rules that route notifications).

Send a test notification to a target.

Args: name: Target name.

Bulk start guests across the cluster.

Args: vms: Comma-separated list of VMIDs (empty = all).

Bulk shutdown guests across the cluster.

Args: vms: Comma-separated list of VMIDs (empty = all).

Bulk migrate guests to a target node.

Args: target: Target node name. vms: Comma-separated VMIDs.

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

Get Ceph metadata (versions, services across nodes).

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

Set a Ceph global flag.

Args: flag: Flag name (noout, noscrub, nobackfill, norebalance, nodown, noup, etc.). value: True to set, False to unset.

Get Ceph status from a specific node's perspective.

Args: node: The node name.

List Ceph OSDs on a node.

Args: node: The node name.

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.

List Ceph pools.

Args: node: The node name.

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).

List Ceph monitors.

Args: node: The node name.

List Ceph managers.

Args: node: The node name.

List Ceph metadata servers (MDS, for CephFS).

Args: node: The node name.

List CephFS filesystems.

Args: node: The node name.

Get the raw Ceph configuration.

Args: node: The node name.

Get Ceph CRUSH rules.

Args: node: The node name.

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

List realm synchronization jobs.

List PCI device mappings for passthrough.

List USB device mappings for passthrough.

List directory mappings.

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

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.

List cluster-level firewall rules.

Get a specific cluster firewall rule.

Args: pos: Rule position number.

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).

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.

Delete a cluster-level firewall rule.

Args: pos: Rule position to delete.

List firewall security groups (reusable sets of rules).

List rules in a firewall security group.

Args: group: Security group name.

Create a new firewall security group.

Args: group: Group name. comment: Description.

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.

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

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.

Delete a firewall alias.

Args: name: Alias name.

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

Create a new firewall IP set.

Args: name: IP set name. comment: Description.

List entries in a firewall IP set.

Args: name: IP set name.

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).

Remove an IP/CIDR from an IP set.

Args: name: IP set name. cidr: IP address or CIDR to remove.

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

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

Get firewall options for a specific node.

Args: node: The node name.

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.

List firewall rules for a node.

Args: node: The node name.

Get firewall log for a node.

Args: node: The node name. limit: Max entries.

Get firewall options for a QEMU VM.

Args: node: The node name. vmid: The VM ID.

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.

List firewall rules for a QEMU VM.

Args: node: The node name. vmid: The VM ID.

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.

Get firewall options for an LXC container.

Args: node: The node name. vmid: The container ID.

List firewall rules for an LXC container.

Args: node: The node name. vmid: The container ID.

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.

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

Get detailed HA manager status.

List all HA-managed resources.

Get HA resource configuration.

Args: sid: HA resource ID (format: 'type:vmid', e.g. 'vm:100' or 'ct:101').

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.

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.

Remove a resource from HA management.

Args: sid: Resource ID (format: 'type:vmid').

Request migration of an HA resource to a different node.

Args: sid: Resource ID. node: Target node.

Request relocation of an HA resource to a different node.

Args: sid: Resource ID. node: Target node.

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

Get HA group configuration.

Args: group: Group ID.

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.

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.

Delete an HA group.

Args: group: Group ID.

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

Args: node: The node name.

Get the current runtime status of a container.

Args: node: The node name. vmid: The container ID (CTID).

Get the configuration of a container.

Args: node: The node name. vmid: The container ID.

Get pending configuration changes for a container.

Args: node: The node name. vmid: The container ID.

Get network interfaces and IPs of a running container.

Args: node: The node name. vmid: The container ID.

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'.

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').

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').

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.

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.

Start a container.

Args: node: The node name. vmid: The container ID.

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

Args: node: The node name. vmid: The container ID.

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.

Reboot a container.

Args: node: The node name. vmid: The container ID. timeout: Timeout in seconds.

Suspend (freeze) a container.

Args: node: The node name. vmid: The container ID.

Resume a suspended container.

Args: node: The node name. vmid: The container ID.

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.

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.

Convert a container into a template (irreversible).

Args: node: The node name. vmid: The container ID.

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').

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.

List all snapshots of a container.

Args: node: The node name. vmid: The container ID.

Create a snapshot of a container.

Args: node: The node name. vmid: The container ID. snapname: Snapshot name. description: Snapshot description.

Delete a container snapshot.

Args: node: The node name. vmid: The container ID. snapname: Snapshot name. force: Force delete.

Rollback a container to a previous snapshot.

Args: node: The node name. vmid: The container ID. snapname: Snapshot name.

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

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

Args: node: The node name (e.g. 'pve1').

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

Args: node: The node name.

Get DNS settings for a node.

Args: node: The node name.

Get network interface configuration for a node.

Args: node: The node name.

Get details for a specific network interface.

Args: node: The node name. iface: Interface name (e.g. 'vmbr0', 'eth0').

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.

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

Args: node: The node name.

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'.

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).

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.

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.).

Get the status of a specific task by its UPID.

Args: node: The node name. upid: The task UPID string.

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.

Stop (abort) a running task.

Args: node: The node name. upid: The task UPID string.

Get the current time and timezone of a node.

Args: node: The node name.

Get subscription status for a node.

Args: node: The node name.

List available package updates on a node.

Args: node: The node name.

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

Args: node: The node name.

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

Args: node: The node name.

List physical disks on a node.

Args: node: The node name.

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

Args: node: The node name. disk: Disk device path (e.g. '/dev/sda').

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

Args: node: The node name.

List USB hardware devices on a node.

Args: node: The node name.

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

Args: node: The node name.

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).

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

Args: node: The node name.

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).

Stop all VMs and containers on a node.

Args: node: The node name. vms: Comma-separated list of VMIDs to stop (empty = all).

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

Args: node: The node name.

Get Proxmox VE version information for a specific node.

Args: node: The node name.

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

Args: node: The node name.

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

Args: node: The node name.

Download an appliance template to local storage.

Args: node: The node name. storage: Target storage ID. template: Template name to download.

List all resource pools.

Get pool configuration and members.

Args: poolid: Pool ID.

Create a resource pool.

Args: poolid: Pool ID. comment: Description.

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.

Delete a resource pool.

Args: poolid: Pool ID.

List ACME (Let's Encrypt) accounts.

Get ACME account details.

Args: name: Account name (default: 'default').

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.

List ACME DNS challenge plugins.

Get ACME plugin configuration.

Args: id: Plugin ID.

List known ACME directory URLs.

Get the ACME Terms of Service URL.

Order/renew ACME certificate for a node.

Args: node: The node name. force: Force renewal even if not due.

Get certificate info for a node.

Args: node: The node name.

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

Args: node: The node name.

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

Args: node: The node name. vmid: The VM ID.

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.

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

Args: node: The node name. vmid: The VM ID.

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').

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'.

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.

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.

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.

Start a VM.

Args: node: The node name. vmid: The VM ID. timeout: Timeout in seconds (0 = default).

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).

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).

Reboot a VM via ACPI.

Args: node: The node name. vmid: The VM ID. timeout: Wait timeout in seconds.

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.

Resume a suspended/paused VM.

Args: node: The node name. vmid: The VM ID.

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

Args: node: The node name. vmid: The VM ID.

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.

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').

Convert a VM into a template (irreversible).

Args: node: The node name. vmid: The VM ID.

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').

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.

List all snapshots of a VM.

Args: node: The node name. vmid: The VM ID.

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).

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.

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.

Get the configuration stored in a VM snapshot.

Args: node: The node name. vmid: The VM ID. snapname: The snapshot name.

Get Cloud-Init configuration for a VM.

Args: node: The node name. vmid: The VM ID.

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.

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'.

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. input_data: Data to pass to stdin.

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.

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.

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.

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'.

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.

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.

Create a SPICE proxy connection for a VM console.

Args: node: The node name. vmid: The VM ID.

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').

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.

List SDN virtual networks (VNets).

Get SDN VNet configuration.

Args: vnet: VNet ID.

Create an SDN VNet.

Args: vnet: VNet ID. zone: Zone ID. tag: VLAN tag. alias: Display alias. vlanaware: Enable VLAN-aware bridge.

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.

Delete an SDN VNet.

Args: vnet: VNet ID.

List subnets for an SDN VNet.

Args: vnet: VNet ID.

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.

List SDN zones.

Get SDN zone configuration.

Args: zone: Zone ID.

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.

Delete an SDN zone.

Args: zone: Zone ID.

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

Get SDN controller configuration.

Args: controller: Controller ID.

List IPAM (IP Address Management) plugins.

Get IPAM plugin configuration.

Args: ipam: IPAM ID.

List SDN DNS plugins.

Apply pending SDN configuration changes to all nodes.

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).

Get configuration of a specific storage pool.

Args: storage: The storage ID.

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.

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.

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

Args: storage: The storage ID.

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.

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

Args: node: The node name. storage: The storage ID.

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.

Get details about a specific volume in storage.

Args: node: The node name. storage: The storage ID. volume: The volume ID.

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.

Delete a volume from storage.

Args: node: The node name. storage: The storage ID. volume: The volume ID.

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.

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).

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'.

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).

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 '/').

List LVM volume groups on a node.

Args: node: The node name.

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.

List LVM thin pools on a node.

Args: node: The node name.

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.

List ZFS pools on a node.

Args: node: The node name.

Get details of a ZFS pool.

Args: node: The node name. name: ZFS pool name.

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.).

List directory-based storage mounts on a node.

Args: node: The node name.

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.

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

Args: node: The node name. disk: Disk device path (e.g. '/dev/sdb').