Get-PveClusterSdnControllersIdx
Read sdn controller configuration.
API: GET /cluster/sdn/controllers/{controller}, Proxmox VE API viewer
Syntax
Section titled “Syntax”Get-PveClusterSdnControllersIdx [-PveTicket <PveTicket>] -Controller <string> [-Pending <bool>] [-Running <bool>] [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-Controller |
string |
Yes | The SDN controller object identifier. |
-Pending |
bool |
No | Display pending config. |
-Running |
bool |
No | Display running config. |
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.
