Connect-PveCluster
Connect to Proxmox VE Cluster.
Explained with examples in this guide.
Syntax
Section titled “Syntax”Connect-PveCluster -HostsAndPorts <string[]> [-Credentials <pscredential>] [-ApiToken <string>] [-Otp <string>] [-SkipCertificateCheck] [-TimeoutSec <int>] [-SkipRefreshPveTicketLast] [<CommonParameters>]Parameters
Section titled “Parameters”| Parameter | Type | Required | Pipeline | Description |
|---|---|---|---|---|
-HostsAndPorts |
string[] |
Yes | By value, by property name | Host and ports Format 10.1.1.90:8006,10.1.1.91:8006,10.1.1.92:8006. |
-Credentials |
pscredential |
No | No | Username and password, username formatted as user@pam, user@pve, user@yourdomain or user (default domain pam). |
-ApiToken |
string |
No | No | Api Token format USER@REALM!TOKENID=UUID. |
-Otp |
string |
No | No | Second factor of a user with two-factor authentication: a TOTP code (e.g. 123456) or ‘type:value’ (e.g. recovery:abcd-1234). |
-SkipCertificateCheck |
switch |
No | No | Skips certificate validation checks. |
-TimeoutSec |
int |
No | No | Seconds a request waits for the answer of the node, 100 by default; 0 for no limit. Default: 100. |
-SkipRefreshPveTicketLast |
switch |
No | No | Skip refresh PveTicket Last global variable. |
Output
Section titled “Output”PveTicket. Return ticket connection.
Example
Section titled “Example”$PveTicket = Connect-PveCluster -HostsAndPorts 192.168.128.115 -Credentials (Get-Credential -Username 'root')