Get-PveNodesScanPbs
Scan remote Proxmox Backup Server.
API: GET /nodes/{node}/scan/pbs, Proxmox VE API viewer
Syntax
Section titled “Syntax”Get-PveNodesScanPbs [-PveTicket <PveTicket>] [-Fingerprint <string>] -Node <string> -Password <SecureString> [-Port <int>] -Server <string> -Username <string> [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-Fingerprint |
string |
No | Certificate SHA 256 fingerprint. |
-Node |
string |
Yes | The cluster node name. |
-Password |
SecureString |
Yes | User password or API token secret. |
-Port |
int |
No | Optional port. |
-Server |
string |
Yes | The server address (name or IP). |
-Username |
string |
Yes | User-name or API token-ID. |
Every parameter also binds by property name from the pipeline, so an object with node and vmid properties (the output of Get-PveGuest, for one) fills -Node and -Vmid. Without -PveTicket the cmdlet uses the last connection, see Connection.
Output
Section titled “Output”A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.