New-PveNodesLxcSpiceproxy
Returns a SPICE configuration to connect to the CT.
API: POST /nodes/{node}/lxc/{vmid}/spiceproxy, Proxmox VE API viewer
Syntax
Section titled “Syntax”New-PveNodesLxcSpiceproxy [-PveTicket <PveTicket>] -Node <string> [-Proxy <string>] -Vmid <int> [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
-PveTicket |
PveTicket |
No | Ticket data connection. |
-Node |
string |
Yes | The cluster node name. |
-Proxy |
string |
No | SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs ‘spiceproxy’, so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI). |
-Vmid |
int |
Yes | The (unique) ID of the VM. |
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.
