Module nodes_api 

Enums

NodesExecuteError

struct for typed errors of method nodes_execute

NodesGetNodesError

struct for typed errors of method nodes_get_nodes

NodesIndexGetNodesError

struct for typed errors of method nodes_index_get_nodes

NodesJournalError

struct for typed errors of method nodes_journal

NodesMigrateallError

struct for typed errors of method nodes_migrateall

NodesNetstatError

struct for typed errors of method nodes_netstat

NodesQueryOciRepoTagsError

struct for typed errors of method nodes_query_oci_repo_tags

NodesQueryUrlMetadataError

struct for typed errors of method nodes_query_url_metadata

NodesReportError

struct for typed errors of method nodes_report

NodesRrdError

struct for typed errors of method nodes_rrd

NodesRrddataError

struct for typed errors of method nodes_rrddata

NodesSpiceshellError

struct for typed errors of method nodes_spiceshell

NodesStartallError

struct for typed errors of method nodes_startall

NodesStopallError

struct for typed errors of method nodes_stopall

NodesSuspendallError

struct for typed errors of method nodes_suspendall

NodesSyslogError

struct for typed errors of method nodes_syslog

NodesTermproxyError

struct for typed errors of method nodes_termproxy

NodesVersionError

struct for typed errors of method nodes_version

NodesVncshellError

struct for typed errors of method nodes_vncshell

NodesVncwebsocketError

struct for typed errors of method nodes_vncwebsocket

NodesWakeonlanError

struct for typed errors of method nodes_wakeonlan

Functions

nodes_execute

Execute multiple commands in order, root only.

nodes_get_nodes

Cluster node index.

nodes_index_get_nodes

Node index.

nodes_journal

Read Journal

nodes_migrateall

Migrate all VMs and Containers. Permissions: The ‘VM.Migrate’ permission is required on ‘/’ or on ‘/vms/’ for each ID passed via the ‘vms’ parameter.

nodes_netstat

Read tap/vm network device interface counters

nodes_query_oci_repo_tags

List all tags for an OCI repository reference.

nodes_query_url_metadata

Query metadata of an URL: file size, file name and mime type.

nodes_report

Gather various systems information about a node

nodes_rrd

Read node RRD statistics (returns PNG)

nodes_rrddata

Read node RRD statistics

nodes_spiceshell

Creates a SPICE shell.

nodes_startall

Start all VMs and containers located on this node (by default only those with onboot=1). Permissions: The ‘VM.PowerMgmt’ permission is required on ‘/’ or on ‘/vms/’ for each ID passed via the ‘vms’ parameter.

nodes_stopall

Stop all VMs and Containers. Permissions: The ‘VM.PowerMgmt’ permission is required on ‘/’ or on ‘/vms/’ for each ID passed via the ‘vms’ parameter.

nodes_suspendall

Suspend all VMs. Permissions: The ‘VM.PowerMgmt’ permission is required on ‘/’ or on ‘/vms/’ for each ID passed via the ‘vms’ parameter. Additionally, you need ‘VM.Config.Disk’ on the ‘/vms/{vmid}’ path and ‘Datastore.AllocateSpace’ for the configured state-storage(s)

nodes_syslog

Read system log

nodes_termproxy

Creates a VNC Shell proxy.

nodes_version

API version details

nodes_vncshell

Creates a VNC Shell proxy.

nodes_vncwebsocket

Opens a websocket for VNC traffic. Permissions: You also need to pass a valid ticket (vncticket). Wire-level note: this endpoint answers HTTP 101 Upgrade, not a JSON body. The 200 schema below is the apidoc-declared shape for tooling, but real clients perform a WebSocket upgrade and exchange framed messages on the resulting socket. See the x-pve-websocket extension for the framing and the list of sibling endpoints that issue tickets.

nodes_wakeonlan

Try to wake a node via ‘wake on LAN’ network packet.