Skip to content

nodes / scan ​

8 operations.

GET /nodes/{node}/scan ​

ts
proxmox.nodes.$(node).scan.$get()

Index of available scan methods

Returns an array of object.

ParameterTypeRequiredNotes
nodestringyesThe cluster node name. — format pve-node

GET /nodes/{node}/scan/cifs ​

ts
proxmox.nodes.$(node).scan.cifs.$get()

Scan remote CIFS server.

Returns an array of object.

ParameterTypeRequiredNotes
domainstringSMB domain (Workgroup).
nodestringyesThe cluster node name. — format pve-node
passwordstringUser password.
serverstringyesThe server address (name or IP). — format pve-storage-server
usernamestringUser name.

GET /nodes/{node}/scan/iscsi ​

ts
proxmox.nodes.$(node).scan.iscsi.$get()

Scan remote iSCSI server.

Returns an array of object.

ParameterTypeRequiredNotes
nodestringyesThe cluster node name. — format pve-node
portalstringyesThe iSCSI portal (IP or DNS name with optional port). — format pve-storage-portal-dns

GET /nodes/{node}/scan/lvm ​

ts
proxmox.nodes.$(node).scan.lvm.$get()

List local LVM volume groups.

Returns an array of object.

ParameterTypeRequiredNotes
nodestringyesThe cluster node name. — format pve-node

GET /nodes/{node}/scan/lvmthin ​

ts
proxmox.nodes.$(node).scan.lvmthin.$get()

List local LVM Thin Pools.

Returns an array of object.

ParameterTypeRequiredNotes
nodestringyesThe cluster node name. — format pve-node
vgstringyes≤ 100 chars

GET /nodes/{node}/scan/nfs ​

ts
proxmox.nodes.$(node).scan.nfs.$get()

Scan remote NFS server.

Returns an array of object.

ParameterTypeRequiredNotes
nodestringyesThe cluster node name. — format pve-node
serverstringyesThe server address (name or IP). — format pve-storage-server

GET /nodes/{node}/scan/pbs ​

ts
proxmox.nodes.$(node).scan.pbs.$get()

Scan remote Proxmox Backup Server.

Returns an array of object.

ParameterTypeRequiredNotes
fingerprintstringCertificate SHA 256 fingerprint.
nodestringyesThe cluster node name. — format pve-node
passwordstringyesUser password or API token secret.
portnumberOptional port. — min 1, max 65535, default 8007
serverstringyesThe server address (name or IP). — format pve-storage-server
usernamestringyesUser-name or API token-ID.

GET /nodes/{node}/scan/zfs ​

ts
proxmox.nodes.$(node).scan.zfs.$get()

Scan zfs pool list on local node.

Returns an array of object.

ParameterTypeRequiredNotes
nodestringyesThe cluster node name. — format pve-node