New-PveNodesSpiceshell

Creates a SPICE shell.

API: POST /nodes/{node}/spiceshell, Proxmox VE API viewer

Syntax

New-PveNodesSpiceshell
    [-PveTicket <PveTicket>]
    [-Cmd <string>]
    [-CmdOpts <string>]
    -Node <string>
    [-Proxy <string>]
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Description
-PveTicket	PveTicket	No	Ticket data connection.
-Cmd	string	No	Run specific command or default to login (requires ‘root@pam’) Values: ceph_install, login, upgrade.
-CmdOpts	string	No	Add parameters to a command. Encoded as null terminated strings.
-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).

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

A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.