cv4pve-api-powershell
______ _ __
/ ____/___ __________(_)___ _ _____ _____/ /_
/ / / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/
/ /___/ /_/ / / (__ ) / / / / |/ / __(__ ) /_
\____/\____/_/ /____/_/_/ /_/|___/\___/____/\__/
powerShell for Proxmox VE (Made in Italy)
cv4pve-api-powershell is a part of suite cv4pve.
For more information visit https://www.corsinvest.it/cv4pve
📰 Copyright
Copyright: Corsinvest Srl For licensing details please visit LICENSE
🦺 Commercial Support
This software is part of a suite of tools called cv4pve. If you want commercial support, visit the site
Introduction
PowerShell for Proxmox VE.
this is a CmdLet for PowerShell to manage Proxmox VE.
🚀 Main features
- Easy to learn
- Set ResponseType json, png, extjs, html, text
- Full class and method generated from documentation (about client)
- Comment any method and parameters
- Parameters indexed eg [n] is structured in array index and value
- Return data Proxmox VE
- Return result class more information PveResponse
- Request
- Response
- Status
- Utility
- ConvertFrom-PveUnixTime
- Wait-PveTaskIsFinish
- Get-PveTaskIsRunning
- Build-PveDocumentation
- Get-PveVm (from id or name)
- Unlock-PveVm (from id or name)
- Start-PveVm (from id or name)
- Stop-PveVm (from id or name)
- Suspend-PveVm (from id or name)
- Resume-PveVm (from id or name)
- Reset-PveVm (from id or name)
- And More
- Method direct access using Invoke-PveRestApi return PveResponse
- Connect-PveCluster accept multiple hosts for HA
- Completely written in PowerShell
- Use native api REST Proxmox VE
- Independent os (Windows, Linux, Macosx)
- Installation from PowerShellGallery or download file
- Not require installation in Proxmox VE
- Execute out side Proxmox VE
- Open Source
- Form Proxmox VE 6.2 support Api Token for user
- Invoke-PveSpice enter Spice VM
- Login with One-time password for Two-factor authentication
📙 Documentation
Tutorial
Tutorial interactive in VSCode notebook
Video
Requirement
Minimum version requirement for Powershell is 6.0
Installation
Install PowerShell in your system.
From PowerShell Gallery
Open PowerShell and install module form gallery
PS /home/frank> Install-Module -Name Corsinvest.ProxmoxVE.Api
Manual
Download folder Corsinvest.ProxmoxVE.Api and copy in path module
# show path module
PS /home/frank> [Environment]::GetEnvironmentVariable("PSModulePath")
Api token
From version 6.2 of Proxmox VE is possible to use Api token. This feature permit execute Api without using user and password. If using Privilege Separation when create api token remember specify in permission. Format USER@REALM!TOKENID=UUID
Connect to cluster
For connection use the function Connect-PveCluster. This function generate a Ticket object that refer a PveTicket class. The first connection saved ticket data in the variable $Global:PveTicketLast. In the various functions, the -PveTicket parameter is the connection reference ticket. If not specified will be used $Global:PveTicketLast.
PveTicket Class
This class contain data after connection and login Connect-PveCluster
class PveTicket {
[string] $HostName = ''
[int] $Port = 8006
[bool] $SkipCertificateCheck = $true
[string] $Ticket = ''
[string] $CSRFPreventionToken = ''
[string] $ApiToken = ''
}
PveResponse Class
This class contain data after execution any command
class PveResponse {
#Contain real response of Proxmox VE
#Is converted in object Json response
[PSCustomObject] $Response
[int] $StatusCode = 200
[string] $ReasonPhrase
[bool] $IsSuccessStatusCode = $true
[string] $RequestResource
[hashtable] $Parameters
[string] $Method
[string] $ResponseType
[bool] ResponseInError() { return $null -ne $this.Response.error }
[PSCustomObject] ToTable() { return $this.Response.data | Format-Table -Property * }
[PSCustomObject] ToData() { return $this.Response.data }
[void] ToCsv([string] $filename) { $this.Response.data | Export-Csv $filename }
[void] ToGridView() { $this.Response.data | Out-GridView -Title "View Result Data" }
}
Usage
Example Connect and get version
#Connection to cluster user and password
PS /home/frank> Connect-PveCluster -HostsAndPorts 192.168.190.191:8006,192.168.190.192 -SkipCertificateCheck
PowerShell credential request
Proxmox VE Username and password, username formatted as user@pam, user@pve, user@yourdomain or user (default domain pam).
User: test
Password for user test: ****
#return Ticket, default set $Global:PveTicketLast
#this is useful when connections to multiple clusters are needed use parameter -SkipRefreshPveTicketLast
HostName : 192.168.190.191
Port : 8006
SkipCertificateCheck : True
Ticket : PVE:test@pam:5EFF3CCA::iXhSNb5NTgNUYznf93mBOhj8pqYvAXoecKBHCXa3coYwBWjsWO/x8TO1gIDX0yz9nfHuvY3alJ0+Ew5AouOTZlZl3NODO9Cp4Hl87qnzhsz4wvoYEzvS1NUOTBekt+yAa68jdbhP
OzhOd8ozEEQIK7Fw2lOSa0qBFUTZRoMtnCnlsjk/Nn3kNEnZrkHXRGm46fA+asprvr0nslLxJgPGh94Xxd6jpNDj+xJnp9u6W3PxiAojM9g7IRurbp7ZCJvAgHbA9FqxibpgjaVm4NCd8LdkLDgCROxgYCjI3eR
gjkDvu1P7lLjK9JxSzqnCWWD739DT3P3bW+Ac3SyVqTf8sw==
CSRFPreventionToken : 5EFF3CCA:Cu0NuFiL6CkhFdha2V+HHigMQPk
#Connection to cluster using Api Token
PS /home/frank> Connect-PveCluster -HostsAndPorts 192.168.190.191:8006,192.168.190.192 -SkipCertificateCheck -ApiToken root@pam!qqqqqq=8a8c1cd4-d373-43f1-b366-05ce4cb8061f
HostName : 192.168.190.191
Port : 8006
SkipCertificateCheck : True
Ticket :
CSRFPreventionToken :
ApiToken : root@pam!qqqqqq=8a8c1cd4-d373-43f1-b366-05ce4cb8061f
#For disable output call Connect-PveCluster > $null
#Get version
PS /home/frank> $ret = Get-PveVersion
#$ret return a class PveResponse
#Show data
PS /home/frank> $ret.Response.data
repoid release keyboard version
------ ------- -------- -------
d0ec33c6 15 it 5.4
#Show data 2
PS /home/frank> $ret.ToTable()
repoid release keyboard version
------ ------- -------- -------
d0ec33c6 15 it 5.4
Get snapshots of vm
PS /home/frank> (Get-PveNodesQemuSnapshot -Node pve1 -Vmid 100).ToTable()
vmstate name parent description snaptime
------- ---- ------ ----------- --------
0 autowin10service200221183059 autowin10service200220183012 cv4pve-autosnap 1582306261
0 autowin10service200220183012 autowin10service200219183012 cv4pve-autosnap 1582219813
0 autowin10service200224183012 autowin10service200223183014 cv4pve-autosnap 1582565413
0 autowin10service200223183014 autowin10service200222183019 cv4pve-autosnap 1582479015
0 autowin10service200215183012 autowin10service200214183012 cv4pve-autosnap 1581787814
0 autowin10service200216183017 autowin10service200215183012 cv4pve-autosnap 1581874219
0 autowin10service200218183010 autowin10service200216183017 cv4pve-autosnap 1582047011
0 autowin10service200219183012 autowin10service200218183010 cv4pve-autosnap 1582133413
0 autowin10service200214183012 cv4pve-autosnap 1581701413
0 autowin10service200222183019 autowin10service200221183059 cv4pve-autosnap 1582392621
current autowin10service200224183012 You are here!
Other method
(Get-PveVm -VmIdOrName 100 | Get-PveNodesQemuSnapshot).ToTable()
vmstate name parent description snaptime
------- ---- ------ ----------- --------
0 autowin10service200221183059 autowin10service200220183012 cv4pve-autosnap 1582306261
0 autowin10service200220183012 autowin10service200219183012 cv4pve-autosnap 1582219813
0 autowin10service200224183012 autowin10service200223183014 cv4pve-autosnap 1582565413
0 autowin10service200223183014 autowin10service200222183019 cv4pve-autosnap 1582479015
0 autowin10service200215183012 autowin10service200214183012 cv4pve-autosnap 1581787814
0 autowin10service200216183017 autowin10service200215183012 cv4pve-autosnap 1581874219
0 autowin10service200218183010 autowin10service200216183017 cv4pve-autosnap 1582047011
0 autowin10service200219183012 autowin10service200218183010 cv4pve-autosnap 1582133413
0 autowin10service200214183012 cv4pve-autosnap 1581701413
0 autowin10service200222183019 autowin10service200221183059 cv4pve-autosnap 1582392621
current autowin10service200224183012 You are here!
Indexed data parameter
if you need to pass indexed parameters e.g. (-ScsiN, -IdeN, -NetN) you must use the following way:
#create variabile
$networkConfig = @{ 1 = [uri]::EscapeDataString("model=virtio,bridge=vmbr0") }
$storageConfig = @{ 1 = 'ssdpool:32' }
$bootableIso = @{ 1 = 'local:iso/ubuntu.iso' }
#use variable
New-PveNodesQemu -Node $node -Vmid 105 -Memory 2048 -ScsiN $storageConfig -IdeN $bootableIso -NetN $networkConfig
The [uri]::EscapeDataString escape value to pass.
Build documentation
For build documentation use command Build-PveDocumentation
This command accept TemplateFile parameter is a template for generate documentation. The default file.
New-PveNodesVzdump
Create backup.
Syntax
New-PveNodesVzdump [[-PveTicket] <PveTicket>] [-All] [[-Bwlimit] <Int32>] [[-Compress] <String>] [[-Dumpdir] <String>] [[-Exclude] <String>] [[-ExcludePath] <Array>] [[-Fleecing] <String>] [[-Ionice] <Int32>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <String>] [[-NotificationMode] <String>] [[-NotificationPolicy] <String>] [[-NotificationTarget] <String>] [[-Performance] <String>] [[-Pigz] <Int32>] [[-Pool] <String>] [-Protected] [[-PruneBackups] <String>] [-Quiet] [-Remove] [[-Script] <String>] [-Stdexcludes] [-Stdout] [-Stop] [[-Stopwait] <Int32>] [[-Storage] <String>] [[-Tmpdir] <String>] [[-Vmid] <String>] [[-Zstd] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Backup all known guest systems on this host. | false | true (ByPropertyName) | False | ||
| Limit I/O bandwidth (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| Compress dump file. Enum: 0,1,gzip,lzo,zstd | false | true (ByPropertyName) | |||
| Store resulting files to specified directory. | false | true (ByPropertyName) | |||
| Exclude specified guest systems (assumes --all) | false | true (ByPropertyName) | |||
| Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. | false | true (ByPropertyName) | |||
| Options for backup fleecing (VM only). | false | true (ByPropertyName) | |||
| Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. | false | true (ByPropertyName) | 0 | ||
| Maximal time to wait for the global lock (minutes). | false | true (ByPropertyName) | 0 | ||
| Deprecated':' use notification targets/matchers instead. Specify when to send a notification mail Enum: always,failure | false | true (ByPropertyName) | |||
| Deprecated':' Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications. | false | true (ByPropertyName) | |||
| Deprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system. | false | true (ByPropertyName) | 0 | ||
| Backup mode. Enum: snapshot,suspend,stop | false | true (ByPropertyName) | |||
| Only run if executed on this node. | false | true (ByPropertyName) | |||
| Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. | false | true (ByPropertyName) | |||
| Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. Enum: auto,legacy-sendmail,notification-system | false | true (ByPropertyName) | |||
| Deprecated':' Do not use Enum: always,failure,never | false | true (ByPropertyName) | |||
| Deprecated':' Do not use | false | true (ByPropertyName) | |||
| Other performance-related settings. | false | true (ByPropertyName) | |||
| Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. | false | true (ByPropertyName) | 0 | ||
| Backup all known guest systems included in the specified pool. | false | true (ByPropertyName) | |||
| If true, mark backup(s) as protected. | false | true (ByPropertyName) | False | ||
| Use these retention options instead of those from the storage configuration. | false | true (ByPropertyName) | |||
| Be quiet. | false | true (ByPropertyName) | False | ||
| Prune older backups according to 'prune-backups'. | false | true (ByPropertyName) | False | ||
| Use specified hook script. | false | true (ByPropertyName) | |||
| Exclude temporary files and logs. | false | true (ByPropertyName) | False | ||
| Write tar to stdout, not to a file. | false | true (ByPropertyName) | False | ||
| Stop running backup jobs on this host. | false | true (ByPropertyName) | False | ||
| Maximal time to wait until a guest system is stopped (minutes). | false | true (ByPropertyName) | 0 | ||
| Store resulting file to this storage. | false | true (ByPropertyName) | |||
| Store temporary files to specified directory. | false | true (ByPropertyName) | |||
| The ID of the guest system you want to backup. | false | true (ByPropertyName) | |||
| Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Build-PveDocumentation
Build documentation for Power Shell command For Proxmox VE
Syntax
Build-PveDocumentation [[-TemplateFile] <String>] [-OutputFile] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Template file for generation documentation | false | false | https://raw.githubusercontent.com/corsinvest/cv4pve-api-powershell/master/help-out-html.ps1 | ||
| Output file | true | false |
Outputs
The output type is the type of the objects that the cmdlet emits.
- System.Void
Connect-PveCluster
Connect to Proxmox VE Cluster.
Syntax
Connect-PveCluster [-HostsAndPorts] <String[]> [[-Credentials] <PSCredential>] [[-ApiToken] <String>] [[-Otp] <String>] [-SkipCertificateCheck] [-SkipRefreshPveTicketLast] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Host and portsFormat 10.1.1.90:8006,10.1.1.91:8006,10.1.1.92:8006. | true | true (ByValue, ByPropertyName) | |||
| Username and password, username formatted as user@pam, user@pve, user@yourdomain or user (default domain pam). | false | false | |||
| Api Token format USER@REALM!TOKENID=UUID | false | false | |||
| One-time password for Two-factor authentication. | false | false | |||
| Skips certificate validation checks. | false | false | False | ||
| Skip refresh PveTicket Last global variable | false | false | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveTicket. Return ticket connection.
Examples
EXAMPLE 1
$PveTicket = Connect-PveCluster -HostsAndPorts 192.168.128.115 -Credentials (Get-Credential -Username 'root').
ConvertFrom-PveUnixTime
Convert Unix Time in DateTime
Syntax
ConvertFrom-PveUnixTime [-Time] <Int64> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Unix Time | true | false | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- DateTime. Return DateTime from Unix Time.
ConvertTo-PveUnixTime
Convert datetime objects to UNIX time.
Convert System.DateTime objects to UNIX time.
Syntax
ConvertTo-PveUnixTime [-Date] <DateTime> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Date time | true | true (ByValue) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- [Int32]. Return Unix Time.
New-PveNodesLxcClone
Create a container clone/copy
Syntax
New-PveNodesLxcClone [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [[-Description] <String>] [-Full] [[-Hostname] <String>] [-Newid] <Int32> [-Node] <String> [[-Pool] <String>] [[-Snapname] <String>] [[-Storage] <String>] [[-Target] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Override I/O bandwidth limit (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| Description for the new CT. | false | true (ByPropertyName) | |||
| Create a full copy of all disks. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default. | false | true (ByPropertyName) | False | ||
| Set a hostname for the new CT. | false | true (ByPropertyName) | |||
| VMID for the clone. | true | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Add the new CT to the specified pool. | false | true (ByPropertyName) | |||
| The name of the snapshot. | false | true (ByPropertyName) | |||
| Target storage for full clone. | false | true (ByPropertyName) | |||
| Target node. Only allowed if the original VM is on shared storage. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuClone
Create a copy of virtual machine/template.
Syntax
New-PveNodesQemuClone [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [[-Description] <String>] [[-Format] <String>] [-Full] [[-Name] <String>] [-Newid] <Int32> [-Node] <String> [[-Pool] <String>] [[-Snapname] <String>] [[-Storage] <String>] [[-Target] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Override I/O bandwidth limit (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| Description for the new VM. | false | true (ByPropertyName) | |||
| Target format for file storage. Only valid for full clone. Enum: raw,qcow2,vmdk | false | true (ByPropertyName) | |||
| Create a full copy of all disks. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default. | false | true (ByPropertyName) | False | ||
| Set a name for the new VM. | false | true (ByPropertyName) | |||
| VMID for the clone. | true | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Add the new VM to the specified pool. | false | true (ByPropertyName) | |||
| The name of the snapshot. | false | true (ByPropertyName) | |||
| Target storage for full clone. | false | true (ByPropertyName) | |||
| Target node. Only allowed if the original VM is on shared storage. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcSnapshot
Snapshot a container.
Syntax
New-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A textual description or comment. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuSnapshot
Snapshot a VM.
Syntax
New-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [-Vmstate] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A textual description or comment. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 | ||
| Save the vmstate | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccess
Directory index.
Syntax
Get-PveAccess [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessAcl
Get Access Control List (ACLs).
Syntax
Get-PveAccessAcl [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessDomains
Authentication domain index.
Syntax
Get-PveAccessDomains [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessDomainsIdx
Get auth server configuration.
Syntax
Get-PveAccessDomainsIdx [[-PveTicket] <PveTicket>] [-Realm] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Authentication domain ID | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessGroups
Group index.
Syntax
Get-PveAccessGroups [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessGroupsIdx
Get group configuration.
Syntax
Get-PveAccessGroupsIdx [[-PveTicket] <PveTicket>] [-Groupid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessOpenid
Directory index.
Syntax
Get-PveAccessOpenid [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessPermissions
Retrieve effective permissions of given user/token.
Syntax
Get-PveAccessPermissions [[-PveTicket] <PveTicket>] [[-Path] <String>] [[-Userid] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only dump this specific path, not the whole tree. | false | true (ByPropertyName) | |||
| User ID or full API token ID | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessRoles
Role index.
Syntax
Get-PveAccessRoles [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessRolesIdx
Get role configuration.
Syntax
Get-PveAccessRolesIdx [[-PveTicket] <PveTicket>] [-Roleid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessTfa
List TFA configurations of users.
Syntax
Get-PveAccessTfa [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessTfaIdx
Fetch a requested TFA entry if present.
Syntax
Get-PveAccessTfaIdx [[-PveTicket] <PveTicket>] [-Id] <String> [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A TFA entry id. | true | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessTicket
Dummy. Useful for formatters which want to provide a login page.
Syntax
Get-PveAccessTicket [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessUsers
User index.
Syntax
Get-PveAccessUsers [[-PveTicket] <PveTicket>] [-Enabled] [-Full] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Optional filter for enable property. | false | true (ByPropertyName) | False | ||
| Include group and token information. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessUsersIdx
Get user configuration.
Syntax
Get-PveAccessUsersIdx [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessUsersTfa
Get user TFA types (Personal and Realm).
Syntax
Get-PveAccessUsersTfa [[-PveTicket] <PveTicket>] [-Multiple] [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Request all entries as an array. | false | true (ByPropertyName) | False | ||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessUsersToken
Get user API tokens.
Syntax
Get-PveAccessUsersToken [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessUsersTokenIdx
Get specific API token information.
Syntax
Get-PveAccessUsersTokenIdx [[-PveTicket] <PveTicket>] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| User-specific token identifier. | true | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveCluster
Cluster index.
Syntax
Get-PveCluster [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcme
ACMEAccount index.
Syntax
Get-PveClusterAcme [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcmeAccount
ACMEAccount index.
Syntax
Get-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcmeAccountIdx
Return existing ACME account information.
Syntax
Get-PveClusterAcmeAccountIdx [[-PveTicket] <PveTicket>] [[-Name] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| ACME account config file name. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcmeChallengeSchema
Get schema of ACME challenge types.
Syntax
Get-PveClusterAcmeChallengeSchema [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcmeDirectories
Get named known ACME directory endpoints.
Syntax
Get-PveClusterAcmeDirectories [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcmeMeta
Retrieve ACME Directory Meta Information
Syntax
Get-PveClusterAcmeMeta [[-PveTicket] <PveTicket>] [[-Directory] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| URL of ACME CA directory endpoint. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcmePlugins
ACME plugin index.
Syntax
Get-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list ACME plugins of a specific type Enum: dns,standalone | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcmePluginsIdx
Get ACME plugin configuration.
Syntax
Get-PveClusterAcmePluginsIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Unique identifier for ACME plugin instance. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcmeTos
Retrieve ACME TermsOfService URL from CA. Deprecated, please use /cluster/acme/meta.
Syntax
Get-PveClusterAcmeTos [[-PveTicket] <PveTicket>] [[-Directory] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| URL of ACME CA directory endpoint. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterBackup
List vzdump backup schedule.
Syntax
Get-PveClusterBackup [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterBackupIdx
Read vzdump backup job definition.
Syntax
Get-PveClusterBackupIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The job ID. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterBackupIncludedVolumes
Returns included guests and the backup status of their disks. Optimized to be used in ExtJS tree views.
Syntax
Get-PveClusterBackupIncludedVolumes [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The job ID. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterBackupInfo
Index for backup info related endpoints
Syntax
Get-PveClusterBackupInfo [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterBackupInfoNotBackedUp
Shows all guests which are not covered by any backup job.
Syntax
Get-PveClusterBackupInfoNotBackedUp [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterCeph
Cluster ceph index.
Syntax
Get-PveClusterCeph [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterCephFlags
get the status of all ceph flags
Syntax
Get-PveClusterCephFlags [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterCephFlagsIdx
Get the status of a specific ceph flag.
Syntax
Get-PveClusterCephFlagsIdx [[-PveTicket] <PveTicket>] [-Flag] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The name of the flag name to get. Enum: nobackfill,nodeep-scrub,nodown,noin,noout,norebalance,norecover,noscrub,notieragent,noup,pause | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterCephMetadata
Get ceph metadata.
Syntax
Get-PveClusterCephMetadata [[-PveTicket] <PveTicket>] [[-Scope] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- Enum: all,versions | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterCephStatus
Get ceph status.
Syntax
Get-PveClusterCephStatus [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterConfig
Directory index.
Syntax
Get-PveClusterConfig [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterConfigApiversion
Return the version of the cluster join API available on this node.
Syntax
Get-PveClusterConfigApiversion [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterConfigJoin
Get information needed to join this cluster over the connected node.
Syntax
Get-PveClusterConfigJoin [[-PveTicket] <PveTicket>] [[-Node] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The node for which the joinee gets the nodeinfo. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterConfigNodes
Corosync node list.
Syntax
Get-PveClusterConfigNodes [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterConfigQdevice
Get QDevice status
Syntax
Get-PveClusterConfigQdevice [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterConfigTotem
Get corosync totem protocol settings.
Syntax
Get-PveClusterConfigTotem [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewall
Directory index.
Syntax
Get-PveClusterFirewall [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallAliases
List aliases
Syntax
Get-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallAliasesIdx
Read alias.
Syntax
Get-PveClusterFirewallAliasesIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Alias name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallGroups
List security groups.
Syntax
Get-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallGroupsIdx
Get single rule data.
Syntax
Get-PveClusterFirewallGroupsIdx [[-PveTicket] <PveTicket>] [-Group] <String> [[-Pos] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Security Group name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallIpset
List IPSets
Syntax
Get-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallIpsetIdx
Read IP or Network settings from IPSet.
Syntax
Get-PveClusterFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallMacros
List available macros
Syntax
Get-PveClusterFirewallMacros [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallOptions
Get Firewall options.
Syntax
Get-PveClusterFirewallOptions [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallRefs
Lists possible IPSet/Alias reference which are allowed in source/dest properties.
Syntax
Get-PveClusterFirewallRefs [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list references of specified type. Enum: alias,ipset | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallRules
List rules.
Syntax
Get-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallRulesIdx
Get single rule data.
Syntax
Get-PveClusterFirewallRulesIdx [[-PveTicket] <PveTicket>] [[-Pos] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterHa
Directory index.
Syntax
Get-PveClusterHa [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterHaGroups
Get HA groups.
Syntax
Get-PveClusterHaGroups [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterHaGroupsIdx
Read ha group configuration.
Syntax
Get-PveClusterHaGroupsIdx [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The HA group identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterHaResources
List HA resources.
Syntax
Get-PveClusterHaResources [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list resources of specific type Enum: ct,vm | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterHaResourcesIdx
Read resource configuration.
Syntax
Get-PveClusterHaResourcesIdx [[-PveTicket] <PveTicket>] [-Sid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100). | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterHaStatus
Directory index.
Syntax
Get-PveClusterHaStatus [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterHaStatusCurrent
Get HA manger status.
Syntax
Get-PveClusterHaStatusCurrent [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterHaStatusManagerStatus
Get full HA manger status, including LRM status.
Syntax
Get-PveClusterHaStatusManagerStatus [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterJobs
Index for jobs related endpoints.
Syntax
Get-PveClusterJobs [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterJobsRealmSync
List configured realm-sync-jobs.
Syntax
Get-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterJobsRealmSyncIdx
Read realm-sync job definition.
Syntax
Get-PveClusterJobsRealmSyncIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterJobsScheduleAnalyze
Returns a list of future schedule runtimes.
Syntax
Get-PveClusterJobsScheduleAnalyze [[-PveTicket] <PveTicket>] [[-Iterations] <Int32>] [-Schedule] <String> [[-Starttime] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Number of event-iteration to simulate and return. | false | true (ByPropertyName) | 0 | ||
| Job schedule. The format is a subset of `systemd` calendar events. | true | true (ByPropertyName) | |||
| UNIX timestamp to start the calculation from. Defaults to the current time. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterLog
Read cluster log
Syntax
Get-PveClusterLog [[-PveTicket] <PveTicket>] [[-Max] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Maximum number of entries. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterMapping
List resource types.
Syntax
Get-PveClusterMapping [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterMappingPci
List PCI Hardware Mapping
Syntax
Get-PveClusterMappingPci [[-PveTicket] <PveTicket>] [[-CheckNode] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| If given, checks the configurations on the given node for correctness, and adds relevant diagnostics for the devices to the response. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterMappingPciIdx
Get PCI Mapping.
Syntax
Get-PveClusterMappingPciIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterMappingUsb
List USB Hardware Mappings
Syntax
Get-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [[-CheckNode] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| If given, checks the configurations on the given node for correctness, and adds relevant errors to the devices. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterMappingUsbIdx
Get USB Mapping.
Syntax
Get-PveClusterMappingUsbIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterMetrics
Metrics index.
Syntax
Get-PveClusterMetrics [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterMetricsServer
List configured metric servers.
Syntax
Get-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterMetricsServerIdx
Read metric server configuration.
Syntax
Get-PveClusterMetricsServerIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNextid
Get next free VMID. Pass a VMID to assert that its free (at time of check).
Syntax
Get-PveClusterNextid [[-PveTicket] <PveTicket>] [[-Vmid] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotifications
Index for notification-related API endpoints.
Syntax
Get-PveClusterNotifications [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsEndpoints
Index for all available endpoint types.
Syntax
Get-PveClusterNotificationsEndpoints [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsEndpointsGotify
Returns a list of all gotify endpoints
Syntax
Get-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsEndpointsGotifyIdx
Return a specific gotify endpoint
Syntax
Get-PveClusterNotificationsEndpointsGotifyIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Name of the endpoint. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsEndpointsSendmail
Returns a list of all sendmail endpoints
Syntax
Get-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsEndpointsSendmailIdx
Return a specific sendmail endpoint
Syntax
Get-PveClusterNotificationsEndpointsSendmailIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsEndpointsSmtp
Returns a list of all smtp endpoints
Syntax
Get-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsEndpointsSmtpIdx
Return a specific smtp endpoint
Syntax
Get-PveClusterNotificationsEndpointsSmtpIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsMatchers
Returns a list of all matchers
Syntax
Get-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsMatchersIdx
Return a specific matcher
Syntax
Get-PveClusterNotificationsMatchersIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsTargets
Returns a list of all entities that can be used as notification targets.
Syntax
Get-PveClusterNotificationsTargets [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterOptions
Get datacenter options. Without 'Sys.Audit' on '/' not all options are returned.
Syntax
Get-PveClusterOptions [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterReplication
List replication jobs.
Syntax
Get-PveClusterReplication [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterReplicationIdx
Read replication job configuration.
Syntax
Get-PveClusterReplicationIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterResources
Resources index (cluster wide).
Syntax
Get-PveClusterResources [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- Enum: vm,storage,node,sdn | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdn
Directory index.
Syntax
Get-PveClusterSdn [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnControllers
SDN controllers index.
Syntax
Get-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [-Pending] [-Running] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Display pending config. | false | true (ByPropertyName) | False | ||
| Display running config. | false | true (ByPropertyName) | False | ||
| Only list sdn controllers of specific type Enum: bgp,evpn,faucet,isis | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnControllersIdx
Read sdn controller configuration.
Syntax
Get-PveClusterSdnControllersIdx [[-PveTicket] <PveTicket>] [-Controller] <String> [-Pending] [-Running] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The SDN controller object identifier. | true | true (ByPropertyName) | |||
| Display pending config. | false | true (ByPropertyName) | False | ||
| Display running config. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnDns
SDN dns index.
Syntax
Get-PveClusterSdnDns [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list sdn dns of specific type Enum: powerdns | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnDnsIdx
Read sdn dns configuration.
Syntax
Get-PveClusterSdnDnsIdx [[-PveTicket] <PveTicket>] [-Dns] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The SDN dns object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnIpams
SDN ipams index.
Syntax
Get-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list sdn ipams of specific type Enum: netbox,phpipam,pve | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnIpamsIdx
Read sdn ipam configuration.
Syntax
Get-PveClusterSdnIpamsIdx [[-PveTicket] <PveTicket>] [-Ipam] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The SDN ipam object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnIpamsStatus
List PVE IPAM Entries
Syntax
Get-PveClusterSdnIpamsStatus [[-PveTicket] <PveTicket>] [-Ipam] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The SDN ipam object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnVnets
SDN vnets index.
Syntax
Get-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [-Pending] [-Running] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Display pending config. | false | true (ByPropertyName) | False | ||
| Display running config. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnVnetsIdx
Read sdn vnet configuration.
Syntax
Get-PveClusterSdnVnetsIdx [[-PveTicket] <PveTicket>] [-Pending] [-Running] [-Vnet] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Display pending config. | false | true (ByPropertyName) | False | ||
| Display running config. | false | true (ByPropertyName) | False | ||
| The SDN vnet object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnVnetsSubnets
SDN subnets index.
Syntax
Get-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [-Pending] [-Running] [-Vnet] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Display pending config. | false | true (ByPropertyName) | False | ||
| Display running config. | false | true (ByPropertyName) | False | ||
| The SDN vnet object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnVnetsSubnetsIdx
Read sdn subnet configuration.
Syntax
Get-PveClusterSdnVnetsSubnetsIdx [[-PveTicket] <PveTicket>] [-Pending] [-Running] [-Subnet] <String> [-Vnet] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Display pending config. | false | true (ByPropertyName) | False | ||
| Display running config. | false | true (ByPropertyName) | False | ||
| The SDN subnet object identifier. | true | true (ByPropertyName) | |||
| The SDN vnet object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnZones
SDN zones index.
Syntax
Get-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-Pending] [-Running] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Display pending config. | false | true (ByPropertyName) | False | ||
| Display running config. | false | true (ByPropertyName) | False | ||
| Only list SDN zones of specific type Enum: evpn,faucet,qinq,simple,vlan,vxlan | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnZonesIdx
Read sdn zone configuration.
Syntax
Get-PveClusterSdnZonesIdx [[-PveTicket] <PveTicket>] [-Pending] [-Running] [-Zone] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Display pending config. | false | true (ByPropertyName) | False | ||
| Display running config. | false | true (ByPropertyName) | False | ||
| The SDN zone object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterStatus
Get cluster status information.
Syntax
Get-PveClusterStatus [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterTasks
List recent tasks (cluster wide).
Syntax
Get-PveClusterTasks [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcConfig
Get container configuration.
Syntax
Get-PveNodesLxcConfig [[-PveTicket] <PveTicket>] [-Current] [-Node] <String> [[-Snapshot] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Get current values (instead of pending values). | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Fetch config values from given snapshot. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcSnapshot
List all snapshots.
Syntax
Get-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcSnapshotConfig
Get snapshot configuration
Syntax
Get-PveNodesLxcSnapshotConfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNode
Get nodes
Syntax
Get-PveNode [[-PveTicket] <PveTicket>] [[-Node] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The Name of the node. | false | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PSCustomObject. Return Node/s data.
Get-PveNodes
Cluster node index.
Syntax
Get-PveNodes [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesAplinfo
Get list of appliances.
Syntax
Get-PveNodesAplinfo [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesApt
Directory index for apt (Advanced Package Tool).
Syntax
Get-PveNodesApt [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesAptChangelog
Get package changelogs.
Syntax
Get-PveNodesAptChangelog [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [[-Version] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Package name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Package version. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesAptRepositories
Get APT repository information.
Syntax
Get-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesAptUpdate
List available updates.
Syntax
Get-PveNodesAptUpdate [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesAptVersions
Get package information for important Proxmox packages.
Syntax
Get-PveNodesAptVersions [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCapabilities
Node capabilities index.
Syntax
Get-PveNodesCapabilities [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCapabilitiesQemu
QEMU capabilities index.
Syntax
Get-PveNodesCapabilitiesQemu [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCapabilitiesQemuCpu
List all custom and default CPU models.
Syntax
Get-PveNodesCapabilitiesQemuCpu [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCapabilitiesQemuMachines
Get available QEMU/KVM machine types.
Syntax
Get-PveNodesCapabilitiesQemuMachines [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCeph
Directory index.
Syntax
Get-PveNodesCeph [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephCfg
Directory index.
Syntax
Get-PveNodesCephCfg [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephCfgDb
Get the Ceph configuration database.
Syntax
Get-PveNodesCephCfgDb [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephCfgRaw
Get the Ceph configuration file.
Syntax
Get-PveNodesCephCfgRaw [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephCfgValue
Get configured values from either the config file or config DB.
Syntax
Get-PveNodesCephCfgValue [[-PveTicket] <PveTicket>] [-ConfigKeys] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| List of <section>':'<config key> items. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephCmdSafety
Heuristical check if it is safe to perform an action.
Syntax
Get-PveNodesCephCmdSafety [[-PveTicket] <PveTicket>] [-Action] <String> [-Id] <String> [-Node] <String> [-Service] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Action to check Enum: stop,destroy | true | true (ByPropertyName) | |||
| ID of the service | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Service type Enum: osd,mon,mds | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephCrush
Get OSD crush map
Syntax
Get-PveNodesCephCrush [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephFs
Directory index.
Syntax
Get-PveNodesCephFs [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephLog
Read ceph log
Syntax
Get-PveNodesCephLog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Start] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephMds
MDS directory index.
Syntax
Get-PveNodesCephMds [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephMgr
MGR directory index.
Syntax
Get-PveNodesCephMgr [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephMon
Get Ceph monitor list.
Syntax
Get-PveNodesCephMon [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephOsd
Get Ceph osd list/tree.
Syntax
Get-PveNodesCephOsd [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephOsdIdx
OSD index.
Syntax
Get-PveNodesCephOsdIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| OSD ID | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephOsdLvInfo
Get OSD volume details
Syntax
Get-PveNodesCephOsdLvInfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| OSD ID | true | true (ByPropertyName) | 0 | ||
| OSD device type Enum: block,db,wal | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephOsdMetadata
Get OSD details
Syntax
Get-PveNodesCephOsdMetadata [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| OSD ID | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephPool
List all pools and their settings (which are settable by the POST/PUT endpoints).
Syntax
Get-PveNodesCephPool [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephPoolIdx
Pool index.
Syntax
Get-PveNodesCephPoolIdx [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The name of the pool. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephPoolStatus
Show the current pool status.
Syntax
Get-PveNodesCephPoolStatus [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [-Verbose_] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The name of the pool. It must be unique. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| If enabled, will display additional data(eg. statistics). | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephRules
List ceph rules.
Syntax
Get-PveNodesCephRules [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephStatus
Get ceph status.
Syntax
Get-PveNodesCephStatus [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCertificates
Node index.
Syntax
Get-PveNodesCertificates [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCertificatesAcme
ACME index.
Syntax
Get-PveNodesCertificatesAcme [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCertificatesInfo
Get information about node's certificates.
Syntax
Get-PveNodesCertificatesInfo [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesConfig
Get node configuration options.
Syntax
Get-PveNodesConfig [[-PveTicket] <PveTicket>] [-Node] <String> [[-Property] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Return only a specific property from the node configuration. Enum: acme,acmedomain0,acmedomain1,acmedomain2,acmedomain3,acmedomain4,acmedomain5,description,startall-onboot-delay,wakeonlan | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDisks
Node index.
Syntax
Get-PveNodesDisks [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDisksDirectory
PVE Managed Directory storages.
Syntax
Get-PveNodesDisksDirectory [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDisksList
List local disks.
Syntax
Get-PveNodesDisksList [[-PveTicket] <PveTicket>] [-IncludePartitions] [-Node] <String> [-Skipsmart] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Also include partitions. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Skip smart checks. | false | true (ByPropertyName) | False | ||
| Only list specific types of disks. Enum: unused,journal_disks | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDisksLvm
List LVM Volume Groups
Syntax
Get-PveNodesDisksLvm [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDisksLvmthin
List LVM thinpools
Syntax
Get-PveNodesDisksLvmthin [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDisksSmart
Get SMART Health of a disk.
Syntax
Get-PveNodesDisksSmart [[-PveTicket] <PveTicket>] [-Disk] <String> [-Healthonly] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Block device name | true | true (ByPropertyName) | |||
| If true returns only the health status | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDisksZfs
List Zpools.
Syntax
Get-PveNodesDisksZfs [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDisksZfsIdx
Get details about a zpool.
Syntax
Get-PveNodesDisksZfsIdx [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDns
Read DNS settings.
Syntax
Get-PveNodesDns [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesFirewall
Directory index.
Syntax
Get-PveNodesFirewall [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesFirewallLog
Read firewall log
Syntax
Get-PveNodesFirewallLog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Start] <Int32>] [[-Until] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Display log since this UNIX epoch. | false | true (ByPropertyName) | 0 | ||
| -- | false | true (ByPropertyName) | 0 | ||
| Display log until this UNIX epoch. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesFirewallOptions
Get host firewall options.
Syntax
Get-PveNodesFirewallOptions [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesFirewallRules
List rules.
Syntax
Get-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesFirewallRulesIdx
Get single rule data.
Syntax
Get-PveNodesFirewallRulesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Pos] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesHardware
Index of hardware types
Syntax
Get-PveNodesHardware [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesHardwarePci
List local PCI devices.
Syntax
Get-PveNodesHardwarePci [[-PveTicket] <PveTicket>] [-Node] <String> [[-PciClassBlacklist] <String>] [-Verbose_] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| A list of blacklisted PCI classes, which will not be returned. Following are filtered by default':' Memory Controller (05), Bridge (06) and Processor (0b). | false | true (ByPropertyName) | |||
| If disabled, does only print the PCI IDs. Otherwise, additional information like vendor and device will be returned. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesHardwarePciIdx
Index of available pci methods
Syntax
Get-PveNodesHardwarePciIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Pciid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesHardwarePciMdev
List mediated device types for given PCI device.
Syntax
Get-PveNodesHardwarePciMdev [[-PveTicket] <PveTicket>] [-Node] <String> [-Pciid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The PCI ID to list the mdev types for. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesHardwareUsb
List local USB devices.
Syntax
Get-PveNodesHardwareUsb [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesHosts
Get the content of /etc/hosts.
Syntax
Get-PveNodesHosts [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesIdx
Node index.
Syntax
Get-PveNodesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesJournal
Read Journal
Syntax
Get-PveNodesJournal [[-PveTicket] <PveTicket>] [[-Endcursor] <String>] [[-Lastentries] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Startcursor] <String>] [[-Until] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| End before the given Cursor. Conflicts with 'until' | false | true (ByPropertyName) | |||
| Limit to the last X lines. Conflicts with a range. | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Display all log since this UNIX epoch. Conflicts with 'startcursor'. | false | true (ByPropertyName) | 0 | ||
| Start after the given Cursor. Conflicts with 'since' | false | true (ByPropertyName) | |||
| Display all log until this UNIX epoch. Conflicts with 'endcursor'. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxc
LXC container index (per node).
Syntax
Get-PveNodesLxc [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcConfig
Get container configuration.
Aliases
- Get-PveLxcConfig
Syntax
Get-PveNodesLxcConfig [[-PveTicket] <PveTicket>] [-Current] [-Node] <String> [[-Snapshot] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Get current values (instead of pending values). | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Fetch config values from given snapshot. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFeature
Check if feature for virtual machine is available.
Syntax
Get-PveNodesLxcFeature [[-PveTicket] <PveTicket>] [-Feature] <String> [-Node] <String> [[-Snapname] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Feature to check. Enum: snapshot,clone,copy | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewall
Directory index.
Syntax
Get-PveNodesLxcFirewall [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallAliases
List aliases
Syntax
Get-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallAliasesIdx
Read alias.
Syntax
Get-PveNodesLxcFirewallAliasesIdx [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Alias name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallIpset
List IPSets
Syntax
Get-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallIpsetIdx
Read IP or Network settings from IPSet.
Syntax
Get-PveNodesLxcFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallLog
Read firewall log
Syntax
Get-PveNodesLxcFirewallLog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Start] <Int32>] [[-Until] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Display log since this UNIX epoch. | false | true (ByPropertyName) | 0 | ||
| -- | false | true (ByPropertyName) | 0 | ||
| Display log until this UNIX epoch. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallOptions
Get VM firewall options.
Syntax
Get-PveNodesLxcFirewallOptions [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallRefs
Lists possible IPSet/Alias reference which are allowed in source/dest properties.
Syntax
Get-PveNodesLxcFirewallRefs [[-PveTicket] <PveTicket>] [-Node] <String> [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Only list references of specified type. Enum: alias,ipset | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallRules
List rules.
Syntax
Get-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallRulesIdx
Get single rule data.
Syntax
Get-PveNodesLxcFirewallRulesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcIdx
Directory index
Syntax
Get-PveNodesLxcIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcInterfaces
Get IP addresses of the specified container interface.
Syntax
Get-PveNodesLxcInterfaces [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcMtunnelwebsocket
Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration.
Syntax
Get-PveNodesLxcMtunnelwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Socket] <String> [-Ticket] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| unix socket to forward to | true | true (ByPropertyName) | |||
| ticket return by initial 'mtunnel' API call, or retrieved via 'ticket' tunnel command | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcPending
Get container configuration, including pending changes.
Syntax
Get-PveNodesLxcPending [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcRrd
Read VM RRD statistics (returns PNG)
Syntax
Get-PveNodesLxcRrd [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Ds] <String> [-Node] <String> [-Timeframe] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The RRD consolidation function Enum: AVERAGE,MAX | false | true (ByPropertyName) | |||
| The list of datasources you want to display. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Specify the time frame you are interested in. Enum: hour,day,week,month,year | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcRrddata
Read VM RRD statistics
Syntax
Get-PveNodesLxcRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Timeframe] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The RRD consolidation function Enum: AVERAGE,MAX | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Specify the time frame you are interested in. Enum: hour,day,week,month,year | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcSnapshot
List all snapshots.
Aliases
- Get-PveLxcSnapshot
Syntax
Get-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcSnapshotConfig
Get snapshot configuration
Aliases
- Get-PveLxcSnapshotConfig
Syntax
Get-PveNodesLxcSnapshotConfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcSnapshotIdx
--
Syntax
Get-PveNodesLxcSnapshotIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcStatus
Directory index
Syntax
Get-PveNodesLxcStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcStatusCurrent
Get virtual machine status.
Syntax
Get-PveNodesLxcStatusCurrent [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcVncwebsocket
Opens a weksocket for VNC traffic.
Syntax
Get-PveNodesLxcVncwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Port] <Int32> [-Vmid] <Int32> [-Vncticket] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Port number returned by previous vncproxy call. | true | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 | ||
| Ticket from previous call to vncproxy. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesNetstat
Read tap/vm network device interface counters
Syntax
Get-PveNodesNetstat [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesNetwork
List available networks
Syntax
Get-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Only list specific interface types. Enum: bridge,bond,eth,alias,vlan,OVSBridge,OVSBond,OVSPort,OVSIntPort,any_bridge,any_local_bridge | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesNetworkIdx
Read network device configuration
Syntax
Get-PveNodesNetworkIdx [[-PveTicket] <PveTicket>] [-Iface] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network interface name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemu
Virtual machine index (per node).
Syntax
Get-PveNodesQemu [[-PveTicket] <PveTicket>] [-Full] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Determine the full status of active VMs. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgent
QEMU Guest Agent command index.
Syntax
Get-PveNodesQemuAgent [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentExecStatus
Gets the status of the given pid started by the guest-agent
Syntax
Get-PveNodesQemuAgentExecStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Pid_] <Int32> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The PID to query | true | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentFileRead
Reads the given file via guest agent. Is limited to 16777216 bytes.
Syntax
Get-PveNodesQemuAgentFileRead [[-PveTicket] <PveTicket>] [-File] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The path to the file | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetFsinfo
Execute get-fsinfo.
Syntax
Get-PveNodesQemuAgentGetFsinfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetHostName
Execute get-host-name.
Syntax
Get-PveNodesQemuAgentGetHostName [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetMemoryBlockInfo
Execute get-memory-block-info.
Syntax
Get-PveNodesQemuAgentGetMemoryBlockInfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetMemoryBlocks
Execute get-memory-blocks.
Syntax
Get-PveNodesQemuAgentGetMemoryBlocks [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetOsinfo
Execute get-osinfo.
Syntax
Get-PveNodesQemuAgentGetOsinfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetTime
Execute get-time.
Syntax
Get-PveNodesQemuAgentGetTime [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetTimezone
Execute get-timezone.
Syntax
Get-PveNodesQemuAgentGetTimezone [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetUsers
Execute get-users.
Syntax
Get-PveNodesQemuAgentGetUsers [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetVcpus
Execute get-vcpus.
Syntax
Get-PveNodesQemuAgentGetVcpus [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentInfo
Execute info.
Syntax
Get-PveNodesQemuAgentInfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentNetworkGetInterfaces
Execute network-get-interfaces.
Syntax
Get-PveNodesQemuAgentNetworkGetInterfaces [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuCloudinit
Get the cloudinit configuration with both current and pending values.
Syntax
Get-PveNodesQemuCloudinit [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuCloudinitDump
Get automatically generated cloudinit config.
Syntax
Get-PveNodesQemuCloudinitDump [[-PveTicket] <PveTicket>] [-Node] <String> [-Type] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Config type. Enum: user,network,meta | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuConfig
Get the virtual machine configuration with pending configuration changes applied. Set the 'current' parameter to get the current configuration instead.
Aliases
- Get-PveQemuConfig
Syntax
Get-PveNodesQemuConfig [[-PveTicket] <PveTicket>] [-Current] [-Node] <String> [[-Snapshot] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Get current values (instead of pending values). | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Fetch config values from given snapshot. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFeature
Check if feature for virtual machine is available.
Syntax
Get-PveNodesQemuFeature [[-PveTicket] <PveTicket>] [-Feature] <String> [-Node] <String> [[-Snapname] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Feature to check. Enum: snapshot,clone,copy | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewall
Directory index.
Syntax
Get-PveNodesQemuFirewall [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallAliases
List aliases
Syntax
Get-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallAliasesIdx
Read alias.
Syntax
Get-PveNodesQemuFirewallAliasesIdx [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Alias name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallIpset
List IPSets
Syntax
Get-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallIpsetIdx
Read IP or Network settings from IPSet.
Syntax
Get-PveNodesQemuFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallLog
Read firewall log
Syntax
Get-PveNodesQemuFirewallLog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Start] <Int32>] [[-Until] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Display log since this UNIX epoch. | false | true (ByPropertyName) | 0 | ||
| -- | false | true (ByPropertyName) | 0 | ||
| Display log until this UNIX epoch. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallOptions
Get VM firewall options.
Syntax
Get-PveNodesQemuFirewallOptions [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallRefs
Lists possible IPSet/Alias reference which are allowed in source/dest properties.
Syntax
Get-PveNodesQemuFirewallRefs [[-PveTicket] <PveTicket>] [-Node] <String> [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Only list references of specified type. Enum: alias,ipset | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallRules
List rules.
Syntax
Get-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallRulesIdx
Get single rule data.
Syntax
Get-PveNodesQemuFirewallRulesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuIdx
Directory index
Syntax
Get-PveNodesQemuIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuMigrate
Get preconditions for migration.
Syntax
Get-PveNodesQemuMigrate [[-PveTicket] <PveTicket>] [-Node] <String> [[-Target] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Target node. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuMtunnelwebsocket
Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration.
Syntax
Get-PveNodesQemuMtunnelwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Socket] <String> [-Ticket] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| unix socket to forward to | true | true (ByPropertyName) | |||
| ticket return by initial 'mtunnel' API call, or retrieved via 'ticket' tunnel command | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuPending
Get the virtual machine configuration with both current and pending values.
Syntax
Get-PveNodesQemuPending [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuRrd
Read VM RRD statistics (returns PNG)
Syntax
Get-PveNodesQemuRrd [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Ds] <String> [-Node] <String> [-Timeframe] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The RRD consolidation function Enum: AVERAGE,MAX | false | true (ByPropertyName) | |||
| The list of datasources you want to display. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Specify the time frame you are interested in. Enum: hour,day,week,month,year | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuRrddata
Read VM RRD statistics
Syntax
Get-PveNodesQemuRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Timeframe] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The RRD consolidation function Enum: AVERAGE,MAX | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Specify the time frame you are interested in. Enum: hour,day,week,month,year | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuSnapshot
List all snapshots.
Aliases
- Get-PveQemuSnapshot
Syntax
Get-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuSnapshotConfig
Get snapshot configuration
Aliases
- Get-PveQemuSnapshotConfig
Syntax
Get-PveNodesQemuSnapshotConfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuSnapshotIdx
--
Syntax
Get-PveNodesQemuSnapshotIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuStatus
Directory index
Syntax
Get-PveNodesQemuStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuStatusCurrent
Get virtual machine status.
Syntax
Get-PveNodesQemuStatusCurrent [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuVncwebsocket
Opens a weksocket for VNC traffic.
Syntax
Get-PveNodesQemuVncwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Port] <Int32> [-Vmid] <Int32> [-Vncticket] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Port number returned by previous vncproxy call. | true | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 | ||
| Ticket from previous call to vncproxy. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQueryUrlMetadata
Query metadata of an URL':' file size, file name and mime type.
Syntax
Get-PveNodesQueryUrlMetadata [[-PveTicket] <PveTicket>] [-Node] <String> [-Url] <String> [-VerifyCertificates] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The URL to query the metadata from. | true | true (ByPropertyName) | |||
| If false, no SSL/TLS certificates will be verified. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesReplication
List status of all replication jobs on this node.
Syntax
Get-PveNodesReplication [[-PveTicket] <PveTicket>] [[-Guest] <Int32>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list replication jobs for this guest. | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesReplicationIdx
Directory index.
Syntax
Get-PveNodesReplicationIdx [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesReplicationLog
Read replication job log.
Syntax
Get-PveNodesReplicationLog [[-PveTicket] <PveTicket>] [-Id] <String> [[-Limit] <Int32>] [-Node] <String> [[-Start] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesReplicationStatus
Get replication job status.
Syntax
Get-PveNodesReplicationStatus [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesReport
Gather various systems information about a node
Syntax
Get-PveNodesReport [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesRrd
Read node RRD statistics (returns PNG)
Syntax
Get-PveNodesRrd [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Ds] <String> [-Node] <String> [-Timeframe] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The RRD consolidation function Enum: AVERAGE,MAX | false | true (ByPropertyName) | |||
| The list of datasources you want to display. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Specify the time frame you are interested in. Enum: hour,day,week,month,year | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesRrddata
Read node RRD statistics
Syntax
Get-PveNodesRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Timeframe] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The RRD consolidation function Enum: AVERAGE,MAX | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Specify the time frame you are interested in. Enum: hour,day,week,month,year | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScan
Index of available scan methods
Syntax
Get-PveNodesScan [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScanCifs
Scan remote CIFS server.
Syntax
Get-PveNodesScanCifs [[-PveTicket] <PveTicket>] [[-Domain] <String>] [-Node] <String> [[-Password] <SecureString>] [-Server] <String> [[-Username] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| SMB domain (Workgroup). | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| User password. | false | true (ByPropertyName) | |||
| The server address (name or IP). | true | true (ByPropertyName) | |||
| User name. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScanGlusterfs
Scan remote GlusterFS server.
Syntax
Get-PveNodesScanGlusterfs [[-PveTicket] <PveTicket>] [-Node] <String> [-Server] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The server address (name or IP). | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScanIscsi
Scan remote iSCSI server.
Syntax
Get-PveNodesScanIscsi [[-PveTicket] <PveTicket>] [-Node] <String> [-Portal] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The iSCSI portal (IP or DNS name with optional port). | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScanLvm
List local LVM volume groups.
Syntax
Get-PveNodesScanLvm [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScanLvmthin
List local LVM Thin Pools.
Syntax
Get-PveNodesScanLvmthin [[-PveTicket] <PveTicket>] [-Node] <String> [-Vg] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScanNfs
Scan remote NFS server.
Syntax
Get-PveNodesScanNfs [[-PveTicket] <PveTicket>] [-Node] <String> [-Server] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The server address (name or IP). | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScanPbs
Scan remote Proxmox Backup Server.
Syntax
Get-PveNodesScanPbs [[-PveTicket] <PveTicket>] [[-Fingerprint] <String>] [-Node] <String> [-Password] <SecureString> [[-Port] <Int32>] [-Server] <String> [-Username] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Certificate SHA 256 fingerprint. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| User password or API token secret. | true | true (ByPropertyName) | |||
| Optional port. | false | true (ByPropertyName) | 0 | ||
| The server address (name or IP). | true | true (ByPropertyName) | |||
| User-name or API token-ID. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScanZfs
Scan zfs pool list on local node.
Syntax
Get-PveNodesScanZfs [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesSdn
SDN index.
Syntax
Get-PveNodesSdn [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesSdnZones
Get status for all zones.
Syntax
Get-PveNodesSdnZones [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesSdnZonesContent
List zone content.
Syntax
Get-PveNodesSdnZonesContent [[-PveTicket] <PveTicket>] [-Node] <String> [-Zone] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The SDN zone object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesSdnZonesIdx
--
Syntax
Get-PveNodesSdnZonesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Zone] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The SDN zone object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesServices
Service list.
Syntax
Get-PveNodesServices [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesServicesIdx
Directory index
Syntax
Get-PveNodesServicesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesServicesState
Read service properties
Syntax
Get-PveNodesServicesState [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStatus
Read node status
Syntax
Get-PveNodesStatus [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStorage
Get status for all datastores.
Syntax
Get-PveNodesStorage [[-PveTicket] <PveTicket>] [[-Content] <String>] [-Enabled] [-Format] [-Node] <String> [[-Storage] <String>] [[-Target] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list stores which support this content type. | false | true (ByPropertyName) | |||
| Only list stores which are enabled (not disabled in config). | false | true (ByPropertyName) | False | ||
| Include information about formats | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Only list status for specified storage | false | true (ByPropertyName) | |||
| If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStorageContent
List storage content.
Syntax
Get-PveNodesStorageContent [[-PveTicket] <PveTicket>] [[-Content] <String>] [-Node] <String> [-Storage] <String> [[-Vmid] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list content of this type. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| Only list images for this VM | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStorageContentIdx
Get volume attributes
Syntax
Get-PveNodesStorageContentIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Storage] <String>] [-Volume] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | false | true (ByPropertyName) | |||
| Volume identifier | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStorageIdx
--
Syntax
Get-PveNodesStorageIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Storage] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStorageImportMetadata
Get the base parameters for creating a guest which imports data from a foreign importable guest, like an ESXi VM
Syntax
Get-PveNodesStorageImportMetadata [[-PveTicket] <PveTicket>] [-Node] <String> [-Storage] <String> [-Volume] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| Volume identifier for the guest archive/entry. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStoragePrunebackups
Get prune information for backups. NOTE':' this is only a preview and might not be what a subsequent prune call does if backups are removed/added in the meantime.
Syntax
Get-PveNodesStoragePrunebackups [[-PveTicket] <PveTicket>] [-Node] <String> [[-PruneBackups] <String>] [-Storage] <String> [[-Type] <String>] [[-Vmid] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Use these retention options instead of those from the storage configuration. | false | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| Either 'qemu' or 'lxc'. Only consider backups for guests of this type. Enum: qemu,lxc | false | true (ByPropertyName) | |||
| Only consider backups for this guest. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStorageRrd
Read storage RRD statistics (returns PNG).
Syntax
Get-PveNodesStorageRrd [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Ds] <String> [-Node] <String> [-Storage] <String> [-Timeframe] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The RRD consolidation function Enum: AVERAGE,MAX | false | true (ByPropertyName) | |||
| The list of datasources you want to display. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| Specify the time frame you are interested in. Enum: hour,day,week,month,year | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStorageRrddata
Read storage RRD statistics.
Syntax
Get-PveNodesStorageRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Storage] <String> [-Timeframe] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The RRD consolidation function Enum: AVERAGE,MAX | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| Specify the time frame you are interested in. Enum: hour,day,week,month,year | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStorageStatus
Read storage status.
Syntax
Get-PveNodesStorageStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Storage] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesSubscription
Read subscription info.
Syntax
Get-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesSyslog
Read system log
Syntax
Get-PveNodesSyslog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Service] <String>] [[-Since] <String>] [[-Start] <Int32>] [[-Until] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Service ID | false | true (ByPropertyName) | |||
| Display all log since this date-time string. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| Display all log until this date-time string. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesTasks
Read task list for one node (finished tasks).
Syntax
Get-PveNodesTasks [[-PveTicket] <PveTicket>] [-Errors] [[-Limit] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Source] <String>] [[-Start] <Int32>] [[-Statusfilter] <String>] [[-Typefilter] <String>] [[-Until] <Int32>] [[-Userfilter] <String>] [[-Vmid] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list tasks with a status of ERROR. | false | true (ByPropertyName) | False | ||
| Only list this amount of tasks. | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Only list tasks since this UNIX epoch. | false | true (ByPropertyName) | 0 | ||
| List archived, active or all tasks. Enum: archive,active,all | false | true (ByPropertyName) | |||
| List tasks beginning from this offset. | false | true (ByPropertyName) | 0 | ||
| List of Task States that should be returned. | false | true (ByPropertyName) | |||
| Only list tasks of this type (e.g., vzstart, vzdump). | false | true (ByPropertyName) | |||
| Only list tasks until this UNIX epoch. | false | true (ByPropertyName) | 0 | ||
| Only list tasks from this user. | false | true (ByPropertyName) | |||
| Only list tasks for this VM. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesTasksIdx
--
Syntax
Get-PveNodesTasksIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesTasksLog
Read task log.
Syntax
Get-PveNodesTasksLog [[-PveTicket] <PveTicket>] [-Download] [[-Limit] <Int32>] [-Node] <String> [[-Start] <Int32>] [-Upid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Whether the tasklog file should be downloaded. This parameter can't be used in conjunction with other parameters | false | true (ByPropertyName) | False | ||
| The amount of lines to read from the tasklog. | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Start at this line when reading the tasklog | false | true (ByPropertyName) | 0 | ||
| The task's unique ID. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesTasksStatus
Read task status.
Aliases
- Get-PveTasksStatus
Syntax
Get-PveNodesTasksStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The task's unique ID. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesTime
Read server time and time zone settings.
Syntax
Get-PveNodesTime [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesVersion
API version details
Syntax
Get-PveNodesVersion [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesVncwebsocket
Opens a websocket for VNC traffic.
Syntax
Get-PveNodesVncwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Port] <Int32> [-Vncticket] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Port number returned by previous vncproxy call. | true | true (ByPropertyName) | 0 | ||
| Ticket from previous call to vncproxy. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesVzdumpDefaults
Get the currently configured vzdump defaults.
Syntax
Get-PveNodesVzdumpDefaults [[-PveTicket] <PveTicket>] [-Node] <String> [[-Storage] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesVzdumpExtractconfig
Extract configuration from vzdump backup archive.
Syntax
Get-PveNodesVzdumpExtractconfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Volume] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Volume identifier | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PvePools
List pools or get pool configuration.
Syntax
Get-PvePools [[-PveTicket] <PveTicket>] [[-Poolid] <String>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| -- Enum: qemu,lxc,storage | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PvePoolsIdx
Get pool configuration (deprecated, no support for nested pools, use 'GET /pools/?poolid={poolid}').
Syntax
Get-PvePoolsIdx [[-PveTicket] <PveTicket>] [-Poolid] <String> [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) | |||
| -- Enum: qemu,lxc,storage | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuConfig
Get the virtual machine configuration with pending configuration changes applied. Set the 'current' parameter to get the current configuration instead.
Syntax
Get-PveNodesQemuConfig [[-PveTicket] <PveTicket>] [-Current] [-Node] <String> [[-Snapshot] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Get current values (instead of pending values). | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Fetch config values from given snapshot. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuSnapshot
List all snapshots.
Syntax
Get-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuSnapshotConfig
Get snapshot configuration
Syntax
Get-PveNodesQemuSnapshotConfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveStorage
Storage index.
Syntax
Get-PveStorage [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list storage of specific type Enum: btrfs,cephfs,cifs,dir,esxi,glusterfs,iscsi,iscsidirect,lvm,lvmthin,nfs,pbs,rbd,zfs,zfspool | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveStorageIdx
Read storage configuration.
Syntax
Get-PveStorageIdx [[-PveTicket] <PveTicket>] [-Storage] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveTaskIsRunning
Get task is running.
Syntax
Get-PveTaskIsRunning [[-PveTicket] <PveTicket>] [-Upid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| Upid task e.g UPID:pve1:00004A1A:0964214C:5EECEF11:vzdump:134:root@pam: | true | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- Bool. Return tas is running.
Get-PveNodesTasksStatus
Read task status.
Syntax
Get-PveNodesTasksStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The task's unique ID. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveVersion
API version details, including some parts of the global datacenter config.
Syntax
Get-PveVersion [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveVm
Get VMs/CTs from id or name.
Syntax
Get-PveVm [[-PveTicket] <PveTicket>] [[-VmIdOrName] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The id or name VM/CT comma separated (eg. 100,101,102,TestDebian)-vmid or -name exclude (e.g. -200,-TestUbuntu)range 100:107,-105,200:204'@pool-???' for all VM/CT in specific pool (e.g. @pool-customer1),'@tag-???' for all VM/CT in specific tags (e.g. @tag-customerA),'@node-???' for all VM/CT in specific node (e.g. @node-pve1, @node-\$(hostname)),'@all-???' for all VM/CT in specific host (e.g. @all-pve1, @all-\$(hostname)),'@all' for all VM/CT in cluster"; | false | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PSCustomObject. Return Vm/s data.
Get-PveVmSnapshot
Get snapshots VM.
Syntax
Get-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The (unique) ID or Name of the VM. | true | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Invoke-PveRestApi
Invoke Proxmox VE Rest API
Syntax
Invoke-PveRestApi [[-PveTicket] <PveTicket>] [-Resource] <String> [[-Method] <String>] [[-ResponseType] <String>] [[-Parameters] <Hashtable>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data | false | true (ByValue, ByPropertyName) | |||
| Resource Request | true | false | |||
| Method request | false | false | Get | ||
| Type request | false | false | json | ||
| Parameters request | false | false |
Outputs
The output type is the type of the objects that the cmdlet emits.
- Return object request
Note
This must be used before any other cmdlets are used
Examples
EXAMPLE 1
$PveTicket = Connect-PveCluster -HostsAndPorts '192.168.128.115' -Credentials (Get-Credential -Username 'root').
(Invoke-PveRestApi -PveTicket $PveTicket -Method Get -Resource '/version').Resonse.data
data----@{version=5.4; release=15; repoid=d0ec33c6; keyboard=it}
Invoke-PveSpice
Enter Spice VM.
Aliases
- Show-PveSpice
Syntax
Invoke-PveSpice [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Viewer] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The (unique) ID or Name of the VM. | true | true (ByValue, ByPropertyName) | |||
| Path of Spice remove viewer.- Linux /usr/bin/remote-viewer- Windows C:\Program Files\VirtViewer v?.?-???\bin\remote-viewer.exe | true | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
IsNumeric
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| None | false | false |
New-PveNodesLxcMigrate
Migrate the container to another node. Creates a new migration task.
Syntax
New-PveNodesLxcMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [-Node] <String> [-Online] [-Restart] [-Target] <String> [[-TargetStorage] <String>] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Override I/O bandwidth limit (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Use online/live migration. | false | true (ByPropertyName) | False | ||
| Use restart migration | false | true (ByPropertyName) | False | ||
| Target node. | true | true (ByPropertyName) | |||
| Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. | false | true (ByPropertyName) | |||
| Timeout in seconds for shutdown for restart migration | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuMigrate
Migrate virtual machine. Creates a new migration task.
Syntax
New-PveNodesQemuMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [-Force] [[-MigrationNetwork] <String>] [[-MigrationType] <String>] [-Node] <String> [-Online] [-Target] <String> [[-Targetstorage] <String>] [-Vmid] <Int32> [-WithLocalDisks] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Override I/O bandwidth limit (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| Allow to migrate VMs which use local devices. Only root may use this option. | false | true (ByPropertyName) | False | ||
| CIDR of the (sub) network that is used for migration. | false | true (ByPropertyName) | |||
| Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. Enum: secure,insecure | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Use online/live migration if VM is running. Ignored if VM is stopped. | false | true (ByPropertyName) | False | ||
| Target node. | true | true (ByPropertyName) | |||
| Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 | ||
| Enable live storage migration for local disk | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessDomains
Add an authentication server.
Syntax
New-PveAccessDomains [[-PveTicket] <PveTicket>] [[-AcrValues] <String>] [-Autocreate] [[-BaseDn] <String>] [[-BindDn] <String>] [[-Capath] <String>] [-CaseSensitive] [[-Cert] <String>] [[-Certkey] <String>] [-CheckConnection] [[-ClientId] <String>] [[-ClientKey] <String>] [[-Comment] <String>] [-Default] [[-Domain] <String>] [[-Filter] <String>] [[-GroupClasses] <String>] [[-GroupDn] <String>] [[-GroupFilter] <String>] [[-GroupNameAttr] <String>] [[-IssuerUrl] <String>] [[-Mode] <String>] [[-Password] <SecureString>] [[-Port] <Int32>] [[-Prompt] <String>] [-Realm] <String> [[-Scopes] <String>] [-Secure] [[-Server1] <String>] [[-Server2] <String>] [[-Sslversion] <String>] [[-SyncDefaultsOptions] <String>] [[-SyncAttributes] <String>] [[-Tfa] <String>] [-Type] <String> [[-UserAttr] <String>] [[-UserClasses] <String>] [[-UsernameClaim] <String>] [-Verify] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. | false | true (ByPropertyName) | |||
| Automatically create users if they do not exist. | false | true (ByPropertyName) | False | ||
| LDAP base domain name | false | true (ByPropertyName) | |||
| LDAP bind domain name | false | true (ByPropertyName) | |||
| Path to the CA certificate store | false | true (ByPropertyName) | |||
| username is case-sensitive | false | true (ByPropertyName) | False | ||
| Path to the client certificate | false | true (ByPropertyName) | |||
| Path to the client certificate key | false | true (ByPropertyName) | |||
| Check bind connection to the server. | false | true (ByPropertyName) | False | ||
| OpenID Client ID | false | true (ByPropertyName) | |||
| OpenID Client Key | false | true (ByPropertyName) | |||
| Description. | false | true (ByPropertyName) | |||
| Use this as default realm | false | true (ByPropertyName) | False | ||
| AD domain name | false | true (ByPropertyName) | |||
| LDAP filter for user sync. | false | true (ByPropertyName) | |||
| The objectclasses for groups. | false | true (ByPropertyName) | |||
| LDAP base domain name for group sync. If not set, the base_dn will be used. | false | true (ByPropertyName) | |||
| LDAP filter for group sync. | false | true (ByPropertyName) | |||
| LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name. | false | true (ByPropertyName) | |||
| OpenID Issuer Url | false | true (ByPropertyName) | |||
| LDAP protocol mode. Enum: ldap,ldaps,ldap+starttls | false | true (ByPropertyName) | |||
| LDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'. | false | true (ByPropertyName) | |||
| Server port. | false | true (ByPropertyName) | 0 | ||
| Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. | false | true (ByPropertyName) | |||
| Authentication domain ID | true | true (ByPropertyName) | |||
| Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. | false | true (ByPropertyName) | |||
| Use secure LDAPS protocol. DEPRECATED':' use 'mode' instead. | false | true (ByPropertyName) | False | ||
| Server IP address (or DNS name) | false | true (ByPropertyName) | |||
| Fallback Server IP address (or DNS name) | false | true (ByPropertyName) | |||
| LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! Enum: tlsv1,tlsv1_1,tlsv1_2,tlsv1_3 | false | true (ByPropertyName) | |||
| The default options for behavior of synchronizations. | false | true (ByPropertyName) | |||
| Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name. | false | true (ByPropertyName) | |||
| Use Two-factor authentication. | false | true (ByPropertyName) | |||
| Realm type. Enum: ad,ldap,openid,pam,pve | true | true (ByPropertyName) | |||
| LDAP user attribute name | false | true (ByPropertyName) | |||
| The objectclasses for users. | false | true (ByPropertyName) | |||
| OpenID claim used to generate the unique username. | false | true (ByPropertyName) | |||
| Verify the server's SSL certificate | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessDomainsSync
Syncs users and/or groups from the configured LDAP to user.cfg. NOTE':' Synced groups will have the name 'name-$realm', so make sure those groups do not exist to prevent overwriting.
Syntax
New-PveAccessDomainsSync [[-PveTicket] <PveTicket>] [-DryRun] [-EnableNew] [-Full] [-Purge] [-Realm] <String> [[-RemoveVanished] <String>] [[-Scope] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| If set, does not write anything. | false | true (ByPropertyName) | False | ||
| Enable newly synced users immediately. | false | true (ByPropertyName) | False | ||
| DEPRECATED':' use 'remove-vanished' instead. If set, uses the LDAP Directory as source of truth, deleting users or groups not returned from the sync and removing all locally modified properties of synced users. If not set, only syncs information which is present in the synced data, and does not delete or modify anything else. | false | true (ByPropertyName) | False | ||
| DEPRECATED':' use 'remove-vanished' instead. Remove ACLs for users or groups which were removed from the config during a sync. | false | true (ByPropertyName) | False | ||
| Authentication domain ID | true | true (ByPropertyName) | |||
| A semicolon-seperated list of things to remove when they or the user vanishes during a sync. The following values are possible':' 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default). | false | true (ByPropertyName) | |||
| Select what to sync. Enum: users,groups,both | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessGroups
Create new group.
Syntax
New-PveAccessGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Groupid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessOpenidAuthUrl
Get the OpenId Authorization Url for the specified realm.
Syntax
New-PveAccessOpenidAuthUrl [[-PveTicket] <PveTicket>] [-Realm] <String> [-RedirectUrl] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Authentication domain ID | true | true (ByPropertyName) | |||
| Redirection Url. The client should set this to the used server url (location.origin). | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessOpenidLogin
Verify OpenID authorization code and create a ticket.
Syntax
New-PveAccessOpenidLogin [[-PveTicket] <PveTicket>] [-Code] <String> [-RedirectUrl] <String> [-State] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| OpenId authorization code. | true | true (ByPropertyName) | |||
| Redirection Url. The client should set this to the used server url (location.origin). | true | true (ByPropertyName) | |||
| OpenId state. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessRoles
Create new role.
Syntax
New-PveAccessRoles [[-PveTicket] <PveTicket>] [[-Privs] <String>] [-Roleid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessTfa
Add a TFA entry for a user.
Syntax
New-PveAccessTfa [[-PveTicket] <PveTicket>] [[-Challenge] <String>] [[-Description] <String>] [[-Password] <SecureString>] [[-Totp] <String>] [-Type] <String> [-Userid] <String> [[-Value] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| When responding to a u2f challenge':' the original challenge string | false | true (ByPropertyName) | |||
| A description to distinguish multiple entries from one another | false | true (ByPropertyName) | |||
| The current password of the user performing the change. | false | true (ByPropertyName) | |||
| A totp URI. | false | true (ByPropertyName) | |||
| TFA Entry Type. Enum: totp,u2f,webauthn,recovery,yubico | true | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) | |||
| The current value for the provided totp URI, or a Webauthn/U2F challenge response | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessTicket
Create or verify authentication ticket.
Syntax
New-PveAccessTicket [[-PveTicket] <PveTicket>] [-NewFormat] [[-Otp] <String>] [-Password] <SecureString> [[-Path] <String>] [[-Privs] <String>] [[-Realm] <String>] [[-TfaChallenge] <String>] [-Username] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| This parameter is now ignored and assumed to be 1. | false | true (ByPropertyName) | False | ||
| One-time password for Two-factor authentication. | false | true (ByPropertyName) | |||
| The secret password. This can also be a valid ticket. | true | true (ByPropertyName) | |||
| Verify ticket, and check if user have access 'privs' on 'path' | false | true (ByPropertyName) | |||
| Verify ticket, and check if user have access 'privs' on 'path' | false | true (ByPropertyName) | |||
| You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>. | false | true (ByPropertyName) | |||
| The signed TFA challenge string the user wants to respond to. | false | true (ByPropertyName) | |||
| User name | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessUsers
Create new user.
Syntax
New-PveAccessUsers [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Email] <String>] [-Enable] [[-Expire] <Int32>] [[-Firstname] <String>] [[-Groups] <String>] [[-Keys] <String>] [[-Lastname] <String>] [[-Password] <SecureString>] [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Enable the account (default). You can set this to '0' to disable the account | false | true (ByPropertyName) | False | ||
| Account expiration date (seconds since epoch). '0' means no expiration date. | false | true (ByPropertyName) | 0 | ||
| -- | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Keys for two factor auth (yubico). | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Initial password. | false | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessUsersToken
Generate a new API token for a specific user. NOTE':' returns API token value, which needs to be stored as it cannot be retrieved afterwards!
Syntax
New-PveAccessUsersToken [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Expire] <Int32>] [-Privsep] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| API token expiration date (seconds since epoch). '0' means no expiration date. | false | true (ByPropertyName) | 0 | ||
| Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. | false | true (ByPropertyName) | False | ||
| User-specific token identifier. | true | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterAcmeAccount
Register a new ACME account with CA.
Syntax
New-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [-Contact] <String> [[-Directory] <String>] [[-EabHmacKey] <String>] [[-EabKid] <String>] [[-Name] <String>] [[-TosUrl] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Contact email addresses. | true | true (ByPropertyName) | |||
| URL of ACME CA directory endpoint. | false | true (ByPropertyName) | |||
| HMAC key for External Account Binding. | false | true (ByPropertyName) | |||
| Key Identifier for External Account Binding. | false | true (ByPropertyName) | |||
| ACME account config file name. | false | true (ByPropertyName) | |||
| URL of CA TermsOfService - setting this indicates agreement. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterAcmePlugins
Add ACME plugin configuration.
Syntax
New-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [[-Api] <String>] [[-Data] <String>] [-Disable] [-Id] <String> [[-Nodes] <String>] [-Type] <String> [[-ValidationDelay] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| API plugin name Enum: 1984hosting,acmedns,acmeproxy,active24,ad,ali,anx,artfiles,arvan,aurora,autodns,aws,azion,azure,bookmyname,bunny,cf,clouddns,cloudns,cn,conoha,constellix,cpanel,curanet,cyon,da,ddnss,desec,df,dgon,dnsexit,dnshome,dnsimple,dnsservices,do,doapi,domeneshop,dp,dpi,dreamhost,duckdns,durabledns,dyn,dynu,dynv6,easydns,edgedns,euserv,exoscale,fornex,freedns,gandi_livedns,gcloud,gcore,gd,geoscaling,googledomains,he,hetzner,hexonet,hostingde,huaweicloud,infoblox,infomaniak,internetbs,inwx,ionos,ipv64,ispconfig,jd,joker,kappernet,kas,kinghost,knot,la,leaseweb,lexicon,linode,linode_v4,loopia,lua,maradns,me,miab,misaka,myapi,mydevil,mydnsjp,mythic_beasts,namecheap,namecom,namesilo,nanelo,nederhost,neodigit,netcup,netlify,nic,njalla,nm,nsd,nsone,nsupdate,nw,oci,one,online,openprovider,openstack,opnsense,ovh,pdns,pleskxml,pointhq,porkbun,rackcorp,rackspace,rage4,rcode0,regru,scaleway,schlundtech,selectel,selfhost,servercow,simply,tele3,tencent,transip,udr,ultra,unoeuro,variomedia,veesp,vercel,vscale,vultr,websupport,world4you,yandex,yc,zilore,zone,zonomi | false | true (ByPropertyName) | |||
| DNS plugin data. (base64 encoded) | false | true (ByPropertyName) | |||
| Flag to disable the config. | false | true (ByPropertyName) | False | ||
| ACME Plugin ID name | true | true (ByPropertyName) | |||
| List of cluster node names. | false | true (ByPropertyName) | |||
| ACME challenge type. Enum: dns,standalone | true | true (ByPropertyName) | |||
| Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterBackup
Create new vzdump backup job.
Syntax
New-PveClusterBackup [[-PveTicket] <PveTicket>] [-All] [[-Bwlimit] <Int32>] [[-Comment] <String>] [[-Compress] <String>] [[-Dow] <String>] [[-Dumpdir] <String>] [-Enabled] [[-Exclude] <String>] [[-ExcludePath] <Array>] [[-Fleecing] <String>] [[-Id] <String>] [[-Ionice] <Int32>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <String>] [[-NotificationMode] <String>] [[-NotificationPolicy] <String>] [[-NotificationTarget] <String>] [[-Performance] <String>] [[-Pigz] <Int32>] [[-Pool] <String>] [-Protected] [[-PruneBackups] <String>] [-Quiet] [-Remove] [-RepeatMissed] [[-Schedule] <String>] [[-Script] <String>] [[-Starttime] <String>] [-Stdexcludes] [-Stop] [[-Stopwait] <Int32>] [[-Storage] <String>] [[-Tmpdir] <String>] [[-Vmid] <String>] [[-Zstd] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Backup all known guest systems on this host. | false | true (ByPropertyName) | False | ||
| Limit I/O bandwidth (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| Description for the Job. | false | true (ByPropertyName) | |||
| Compress dump file. Enum: 0,1,gzip,lzo,zstd | false | true (ByPropertyName) | |||
| Day of week selection. | false | true (ByPropertyName) | |||
| Store resulting files to specified directory. | false | true (ByPropertyName) | |||
| Enable or disable the job. | false | true (ByPropertyName) | False | ||
| Exclude specified guest systems (assumes --all) | false | true (ByPropertyName) | |||
| Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. | false | true (ByPropertyName) | |||
| Options for backup fleecing (VM only). | false | true (ByPropertyName) | |||
| Job ID (will be autogenerated). | false | true (ByPropertyName) | |||
| Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. | false | true (ByPropertyName) | 0 | ||
| Maximal time to wait for the global lock (minutes). | false | true (ByPropertyName) | 0 | ||
| Deprecated':' use notification targets/matchers instead. Specify when to send a notification mail Enum: always,failure | false | true (ByPropertyName) | |||
| Deprecated':' Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications. | false | true (ByPropertyName) | |||
| Deprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system. | false | true (ByPropertyName) | 0 | ||
| Backup mode. Enum: snapshot,suspend,stop | false | true (ByPropertyName) | |||
| Only run if executed on this node. | false | true (ByPropertyName) | |||
| Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. | false | true (ByPropertyName) | |||
| Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. Enum: auto,legacy-sendmail,notification-system | false | true (ByPropertyName) | |||
| Deprecated':' Do not use Enum: always,failure,never | false | true (ByPropertyName) | |||
| Deprecated':' Do not use | false | true (ByPropertyName) | |||
| Other performance-related settings. | false | true (ByPropertyName) | |||
| Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. | false | true (ByPropertyName) | 0 | ||
| Backup all known guest systems included in the specified pool. | false | true (ByPropertyName) | |||
| If true, mark backup(s) as protected. | false | true (ByPropertyName) | False | ||
| Use these retention options instead of those from the storage configuration. | false | true (ByPropertyName) | |||
| Be quiet. | false | true (ByPropertyName) | False | ||
| Prune older backups according to 'prune-backups'. | false | true (ByPropertyName) | False | ||
| If true, the job will be run as soon as possible if it was missed while the scheduler was not running. | false | true (ByPropertyName) | False | ||
| Backup schedule. The format is a subset of `systemd` calendar events. | false | true (ByPropertyName) | |||
| Use specified hook script. | false | true (ByPropertyName) | |||
| Job Start time. | false | true (ByPropertyName) | |||
| Exclude temporary files and logs. | false | true (ByPropertyName) | False | ||
| Stop running backup jobs on this host. | false | true (ByPropertyName) | False | ||
| Maximal time to wait until a guest system is stopped (minutes). | false | true (ByPropertyName) | 0 | ||
| Store resulting file to this storage. | false | true (ByPropertyName) | |||
| Store temporary files to specified directory. | false | true (ByPropertyName) | |||
| The ID of the guest system you want to backup. | false | true (ByPropertyName) | |||
| Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterConfig
Generate new cluster configuration. If no links given, default to local IP address as link0.
Syntax
New-PveClusterConfig [[-PveTicket] <PveTicket>] [-Clustername] <String> [[-LinkN] <Hashtable>] [[-Nodeid] <Int32>] [[-Votes] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The name of the cluster. | true | true (ByPropertyName) | |||
| Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) | false | true (ByPropertyName) | |||
| Node id for this node. | false | true (ByPropertyName) | 0 | ||
| Number of votes for this node. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterConfigJoin
Joins this node into an existing cluster. If no links are given, default to IP resolved by node's hostname on single link (fallback fails for clusters with multiple links).
Syntax
New-PveClusterConfigJoin [[-PveTicket] <PveTicket>] [-Fingerprint] <String> [-Force] [-Hostname] <String> [[-LinkN] <Hashtable>] [[-Nodeid] <Int32>] [-Password] <SecureString> [[-Votes] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Certificate SHA 256 fingerprint. | true | true (ByPropertyName) | |||
| Do not throw error if node already exists. | false | true (ByPropertyName) | False | ||
| Hostname (or IP) of an existing cluster member. | true | true (ByPropertyName) | |||
| Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) | false | true (ByPropertyName) | |||
| Node id for this node. | false | true (ByPropertyName) | 0 | ||
| Superuser (root) password of peer node. | true | true (ByPropertyName) | |||
| Number of votes for this node | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterConfigNodes
Adds a node to the cluster configuration. This call is for internal use.
Syntax
New-PveClusterConfigNodes [[-PveTicket] <PveTicket>] [[-Apiversion] <Int32>] [-Force] [[-LinkN] <Hashtable>] [[-NewNodeIp] <String>] [-Node] <String> [[-Nodeid] <Int32>] [[-Votes] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||