+
+ +

cv4pve-api-powershell

+

PowerShell Gallery Version +download

+

ProxmoxVE Api

+

PowerShell Gallery

+
    ______                _                      __
+   / ____/___  __________(_)___ _   _____  _____/ /_
+  / /   / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/
+ / /___/ /_/ / /  (__  ) / / / / |/ /  __(__  ) /_
+ \____/\____/_/  /____/_/_/ /_/|___/\___/____/\__/
+
+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: 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.

+

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
  • +
  • Enter-PveSpice enter Spice VM
  • +
  • Login with One-time password for Two-factor authentication
  • +
+

📙 Documentation

+

Documentation

+

Tutorial

+

Tutorial interactive in VSCode notebook

+

Requirement

+

Minimum version requirement for Powershell is 6.0

+

Installation

+

Install PowerShell in your system.

+ +

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.

+ +
+
+ +
+

Syntax

+
+
+
+ Build-PveDocumentation [[-TemplateFile] <String>] [-OutputFile] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-TemplateFileTemplate file for generation documentationfalsefalsehttps://raw.githubusercontent.com/corsinvest/cv4pve-api-powershell/master/help-out-html.ps1
-OutputFileOutput filetruefalse
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • System.Void
+
+
+
+ +
+

Syntax

+
+
+
+ Connect-PveCluster [-HostsAndPorts] <String[]> [[-Credentials] <PSCredential>] [[-ApiToken] <String>] [[-Otp] <String>] [-SkipCertificateCheck] [-SkipRefreshPveTicketLast] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-HostsAndPortsHost and portsFormat 10.1.1.90:8006,10.1.1.91:8006,10.1.1.92:8006.truetrue (ByValue, ByPropertyName)
-CredentialsUsername and password, username formatted as user@pam, user@pve, user@yourdomain or user (default domain pam).falsefalse
-ApiTokenApi Token format USER@REALM!TOKENID=UUIDfalsefalse
-OtpOne-time password for Two-factor authentication.falsefalse
-SkipCertificateCheckSkips certificate validation checks.falsefalseFalse
-SkipRefreshPveTicketLastSkip refresh PveTicket Last global variablefalsefalseFalse
+
+
+

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'). +
+
+
+
+
+ +
+

Syntax

+
+
+
+ ConvertFrom-PveUnixTime [-Time] <Int64> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-TimeUnix Timetruefalse0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • DateTime. Return DateTime from Unix Time.
+
+
+
+ +
+

Syntax

+
+
+
+ ConvertTo-PveUnixTime [-Date] <DateTime> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-DateDate timetruetrue (ByValue)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • [Int32]. Return Unix Time.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Show-PveSpice
  • +
+
+
+
+

Syntax

+
+
+
+ Enter-PveSpice [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Viewer] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-VmIdOrNameThe (unique) ID or Name of the VM.truetrue (ByValue, ByPropertyName)
-ViewerPath of Spice remove viewer.- Linux /usr/bin/remote-viewer- Windows C:\Program Files\VirtViewer v?.?-???\bin\remote-viewer.exetruetrue (ByValue, ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccess [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccessAcl [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccessDomains [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccessDomainsIdx [[-PveTicket] <PveTicket>] [-Realm] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-RealmAuthentication domain IDtruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccessGroups [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccessGroupsIdx [[-PveTicket] <PveTicket>] [-Groupid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Groupid--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccessOpenid [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccessPermissions [[-PveTicket] <PveTicket>] [[-Path] <String>] [[-Userid] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-PathOnly dump this specific path, not the whole tree.falsetrue (ByPropertyName)
-UseridUser ID or full API token IDfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccessRoles [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccessRolesIdx [[-PveTicket] <PveTicket>] [-Roleid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Roleid--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccessTfa [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccessTfaIdx [[-PveTicket] <PveTicket>] [-Id] <String> [-Userid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IdA TFA entry id.truetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccessTicket [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccessUsers [[-PveTicket] <PveTicket>] [-Enabled] [-Full] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-EnabledOptional filter for enable property.falsetrue (ByPropertyName)False
-FullInclude group and token information.falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccessUsersIdx [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccessUsersTfa [[-PveTicket] <PveTicket>] [-Multiple] [-Userid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-MultipleRequest all entries as an array.falsetrue (ByPropertyName)False
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccessUsersToken [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveAccessUsersTokenIdx [[-PveTicket] <PveTicket>] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-TokenidUser-specific token identifier.truetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveCluster [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterAcme [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterAcmeAccountIdx [[-PveTicket] <PveTicket>] [[-Name] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NameACME account config file name.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterAcmeChallengeSchema [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterAcmeDirectories [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterAcmeMeta [[-PveTicket] <PveTicket>] [[-Directory] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DirectoryURL of ACME CA directory endpoint.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-TypeOnly list ACME plugins of a specific type Enum: dns,standalonefalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterAcmePluginsIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IdUnique identifier for ACME plugin instance.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterAcmeTos [[-PveTicket] <PveTicket>] [[-Directory] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DirectoryURL of ACME CA directory endpoint.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterBackup [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterBackupIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IdThe job ID.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterBackupIncludedVolumes [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IdThe job ID.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterBackupInfo [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterBackupInfoNotBackedUp [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterCeph [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterCephFlags [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterCephFlagsIdx [[-PveTicket] <PveTicket>] [-Flag] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-FlagThe name of the flag name to get. Enum: nobackfill,nodeep-scrub,nodown,noin,noout,norebalance,norecover,noscrub,notieragent,noup,pausetruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterCephMetadata [[-PveTicket] <PveTicket>] [[-Scope] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Scope-- Enum: all,versionsfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterCephStatus [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterConfig [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterConfigApiversion [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterConfigJoin [[-PveTicket] <PveTicket>] [[-Node] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe node for which the joinee gets the nodeinfo.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterConfigNodes [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterConfigQdevice [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterConfigTotem [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterFirewall [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterFirewallAliasesIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NameAlias name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterFirewallGroupsIdx [[-PveTicket] <PveTicket>] [-Group] <String> [[-Pos] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-GroupSecurity Group name.truetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-NameIP set name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterFirewallMacros [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterFirewallOptions [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterFirewallRefs [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-TypeOnly list references of specified type. Enum: alias,ipsetfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterFirewallRulesIdx [[-PveTicket] <PveTicket>] [[-Pos] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterHa [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterHaGroups [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterHaGroupsIdx [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-GroupThe HA group identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterHaResources [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-TypeOnly list resources of specific type Enum: ct,vmfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterHaResourcesIdx [[-PveTicket] <PveTicket>] [-Sid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-SidHA 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).truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterHaStatus [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterHaStatusCurrent [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterHaStatusManagerStatus [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterJobs [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterJobsRealmSyncIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Id--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterJobsScheduleAnalyze [[-PveTicket] <PveTicket>] [[-Iterations] <Int32>] [-Schedule] <String> [[-Starttime] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IterationsNumber of event-iteration to simulate and return.falsetrue (ByPropertyName)0
-ScheduleJob schedule. The format is a subset of `systemd` calendar events.truetrue (ByPropertyName)
-StarttimeUNIX timestamp to start the calculation from. Defaults to the current time.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterLog [[-PveTicket] <PveTicket>] [[-Max] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-MaxMaximum number of entries.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterMapping [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterMappingPci [[-PveTicket] <PveTicket>] [[-CheckNode] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CheckNodeIf given, checks the configurations on the given node for correctness, and adds relevant diagnostics for the devices to the response.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterMappingPciIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Id--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [[-CheckNode] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CheckNodeIf given, checks the configurations on the given node for correctness, and adds relevant errors to the devices.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterMappingUsbIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Id--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterMetrics [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterMetricsServerIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Id--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterNextid [[-PveTicket] <PveTicket>] [[-Vmid] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterNotifications [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterNotificationsEndpoints [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterNotificationsEndpointsGotifyIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NameName of the endpoint.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterNotificationsEndpointsSendmailIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Name--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterNotificationsEndpointsSmtpIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Name--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterNotificationsMatchersIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Name--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterNotificationsTargets [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterOptions [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterReplication [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterReplicationIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IdReplication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterResources [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Type-- Enum: vm,storage,node,sdnfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterSdn [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [-Pending] [-Running] [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-PendingDisplay pending config.falsetrue (ByPropertyName)False
-RunningDisplay running config.falsetrue (ByPropertyName)False
-TypeOnly list sdn controllers of specific type Enum: bgp,evpn,faucet,isisfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterSdnControllersIdx [[-PveTicket] <PveTicket>] [-Controller] <String> [-Pending] [-Running] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ControllerThe SDN controller object identifier.truetrue (ByPropertyName)
-PendingDisplay pending config.falsetrue (ByPropertyName)False
-RunningDisplay running config.falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterSdnDns [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-TypeOnly list sdn dns of specific type Enum: powerdnsfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterSdnDnsIdx [[-PveTicket] <PveTicket>] [-Dns] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DnsThe SDN dns object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-TypeOnly list sdn ipams of specific type Enum: netbox,phpipam,pvefalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterSdnIpamsIdx [[-PveTicket] <PveTicket>] [-Ipam] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IpamThe SDN ipam object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterSdnIpamsStatus [[-PveTicket] <PveTicket>] [-Ipam] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IpamThe SDN ipam object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [-Pending] [-Running] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-PendingDisplay pending config.falsetrue (ByPropertyName)False
-RunningDisplay running config.falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterSdnVnetsIdx [[-PveTicket] <PveTicket>] [-Pending] [-Running] [-Vnet] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-PendingDisplay pending config.falsetrue (ByPropertyName)False
-RunningDisplay running config.falsetrue (ByPropertyName)False
-VnetThe SDN vnet object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [-Pending] [-Running] [-Vnet] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-PendingDisplay pending config.falsetrue (ByPropertyName)False
-RunningDisplay running config.falsetrue (ByPropertyName)False
-VnetThe SDN vnet object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterSdnVnetsSubnetsIdx [[-PveTicket] <PveTicket>] [-Pending] [-Running] [-Subnet] <String> [-Vnet] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-PendingDisplay pending config.falsetrue (ByPropertyName)False
-RunningDisplay running config.falsetrue (ByPropertyName)False
-SubnetThe SDN subnet object identifier.truetrue (ByPropertyName)
-VnetThe SDN vnet object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-Pending] [-Running] [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-PendingDisplay pending config.falsetrue (ByPropertyName)False
-RunningDisplay running config.falsetrue (ByPropertyName)False
-TypeOnly list SDN zones of specific type Enum: evpn,faucet,qinq,simple,vlan,vxlanfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterSdnZonesIdx [[-PveTicket] <PveTicket>] [-Pending] [-Running] [-Zone] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-PendingDisplay pending config.falsetrue (ByPropertyName)False
-RunningDisplay running config.falsetrue (ByPropertyName)False
-ZoneThe SDN zone object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterStatus [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveClusterTasks [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNode [[-PveTicket] <PveTicket>] [[-Node] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-NodeThe Name of the node.falsetrue (ByValue, ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PSCustomObject. Return Vm Data.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodes [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesAplinfo [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesApt [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesAptChangelog [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [[-Version] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NamePackage name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VersionPackage version.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesAptUpdate [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesAptVersions [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCapabilities [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCapabilitiesQemu [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCapabilitiesQemuCpu [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCapabilitiesQemuMachines [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCeph [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephCfg [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephCfgDb [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephCfgRaw [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephCfgValue [[-PveTicket] <PveTicket>] [-ConfigKeys] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ConfigKeysList of <section>':'<config key> items.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephCmdSafety [[-PveTicket] <PveTicket>] [-Action] <String> [-Id] <String> [-Node] <String> [-Service] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ActionAction to check Enum: stop,destroytruetrue (ByPropertyName)
-IdID of the servicetruetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ServiceService type Enum: osd,mon,mdstruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephCrush [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephFs [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephLog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Start] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Limit--falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-Start--falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephMds [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephMgr [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephMon [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephOsd [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephOsdIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-OsdidOSD IDtruetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephOsdLvInfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-OsdidOSD IDtruetrue (ByPropertyName)0
-TypeOSD device type Enum: block,db,walfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephOsdMetadata [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-OsdidOSD IDtruetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephPool [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephPoolIdx [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NameThe name of the pool.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephPoolStatus [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [-Verbose_] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NameThe name of the pool. It must be unique.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-Verbose_If enabled, will display additional data(eg. statistics).falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephRules [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCephStatus [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCertificates [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCertificatesAcme [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesCertificatesInfo [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesConfig [[-PveTicket] <PveTicket>] [-Node] <String> [[-Property] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PropertyReturn only a specific property from the node configuration. Enum: acme,acmedomain0,acmedomain1,acmedomain2,acmedomain3,acmedomain4,acmedomain5,description,startall-onboot-delay,wakeonlanfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesDisks [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesDisksDirectory [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesDisksList [[-PveTicket] <PveTicket>] [-IncludePartitions] [-Node] <String> [-Skipsmart] [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IncludePartitionsAlso include partitions.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-SkipsmartSkip smart checks.falsetrue (ByPropertyName)False
-TypeOnly list specific types of disks. Enum: unused,journal_disksfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesDisksLvm [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesDisksLvmthin [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesDisksSmart [[-PveTicket] <PveTicket>] [-Disk] <String> [-Healthonly] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DiskBlock device nametruetrue (ByPropertyName)
-HealthonlyIf true returns only the health statusfalsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesDisksZfs [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesDisksZfsIdx [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NameThe storage identifier.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesDns [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesFirewall [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesFirewallLog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Start] <Int32>] [[-Until] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Limit--falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-SinceDisplay log since this UNIX epoch.falsetrue (ByPropertyName)0
-Start--falsetrue (ByPropertyName)0
-UntilDisplay log until this UNIX epoch.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesFirewallOptions [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesFirewallRulesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Pos] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesHardware [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesHardwarePci [[-PveTicket] <PveTicket>] [-Node] <String> [[-PciClassBlacklist] <String>] [-Verbose_] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PciClassBlacklistA list of blacklisted PCI classes, which will not be returned. Following are filtered by default':' Memory Controller (05), Bridge (06) and Processor (0b).falsetrue (ByPropertyName)
-Verbose_If disabled, does only print the PCI IDs. Otherwise, additional information like vendor and device will be returned.falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesHardwarePciIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Pciid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-Pciid--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesHardwarePciMdev [[-PveTicket] <PveTicket>] [-Node] <String> [-Pciid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PciidThe PCI ID to list the mdev types for.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesHardwareUsb [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesHosts [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesJournal [[-PveTicket] <PveTicket>] [[-Endcursor] <String>] [[-Lastentries] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Startcursor] <String>] [[-Until] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-EndcursorEnd before the given Cursor. Conflicts with 'until'falsetrue (ByPropertyName)
-LastentriesLimit to the last X lines. Conflicts with a range.falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-SinceDisplay all log since this UNIX epoch. Conflicts with 'startcursor'.falsetrue (ByPropertyName)0
-StartcursorStart after the given Cursor. Conflicts with 'since'falsetrue (ByPropertyName)
-UntilDisplay all log until this UNIX epoch. Conflicts with 'endcursor'.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxc [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcConfig [[-PveTicket] <PveTicket>] [-Current] [-Node] <String> [[-Snapshot] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CurrentGet current values (instead of pending values).falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapshotFetch config values from given snapshot.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcFeature [[-PveTicket] <PveTicket>] [-Feature] <String> [-Node] <String> [[-Snapname] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-FeatureFeature to check. Enum: snapshot,clone,copytruetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcFirewall [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcFirewallAliasesIdx [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NameAlias name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-NameIP set name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcFirewallLog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Start] <Int32>] [[-Until] <Int32>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Limit--falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-SinceDisplay log since this UNIX epoch.falsetrue (ByPropertyName)0
-Start--falsetrue (ByPropertyName)0
-UntilDisplay log until this UNIX epoch.falsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcFirewallOptions [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcFirewallRefs [[-PveTicket] <PveTicket>] [-Node] <String> [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-TypeOnly list references of specified type. Enum: alias,ipsetfalsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcFirewallRulesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcInterfaces [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcMtunnelwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Socket] <String> [-Ticket] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-Socketunix socket to forward totruetrue (ByPropertyName)
-Ticketticket return by initial 'mtunnel' API call, or retrieved via 'ticket' tunnel commandtruetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcPending [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcRrd [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Ds] <String> [-Node] <String> [-Timeframe] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CfThe RRD consolidation function Enum: AVERAGE,MAXfalsetrue (ByPropertyName)
-DsThe list of datasources you want to display.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-TimeframeSpecify the time frame you are interested in. Enum: hour,day,week,month,yeartruetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Timeframe] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CfThe RRD consolidation function Enum: AVERAGE,MAXfalsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-TimeframeSpecify the time frame you are interested in. Enum: hour,day,week,month,yeartruetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcSnapshotConfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcSnapshotIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcStatusCurrent [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesLxcVncwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Port] <Int32> [-Vmid] <Int32> [-Vncticket] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PortPort number returned by previous vncproxy call.truetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-VncticketTicket from previous call to vncproxy.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesNetstat [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-TypeOnly list specific interface types. Enum: bridge,bond,eth,alias,vlan,OVSBridge,OVSBond,OVSPort,OVSIntPort,any_bridge,any_local_bridgefalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesNetworkIdx [[-PveTicket] <PveTicket>] [-Iface] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IfaceNetwork interface name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemu [[-PveTicket] <PveTicket>] [-Full] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-FullDetermine the full status of active VMs.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuAgent [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuAgentExecStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Pid_] <Int32> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-Pid_The PID to querytruetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuAgentFileRead [[-PveTicket] <PveTicket>] [-File] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-FileThe path to the filetruetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuAgentGetFsinfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuAgentGetHostName [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuAgentGetMemoryBlockInfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuAgentGetMemoryBlocks [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuAgentGetOsinfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuAgentGetTime [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuAgentGetTimezone [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuAgentGetUsers [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuAgentGetVcpus [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuAgentInfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuAgentNetworkGetInterfaces [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuCloudinit [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuCloudinitDump [[-PveTicket] <PveTicket>] [-Node] <String> [-Type] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-TypeConfig type. Enum: user,network,metatruetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuConfig [[-PveTicket] <PveTicket>] [-Current] [-Node] <String> [[-Snapshot] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CurrentGet current values (instead of pending values).falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapshotFetch config values from given snapshot.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuFeature [[-PveTicket] <PveTicket>] [-Feature] <String> [-Node] <String> [[-Snapname] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-FeatureFeature to check. Enum: snapshot,clone,copytruetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuFirewall [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuFirewallAliasesIdx [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NameAlias name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-NameIP set name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuFirewallLog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Start] <Int32>] [[-Until] <Int32>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Limit--falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-SinceDisplay log since this UNIX epoch.falsetrue (ByPropertyName)0
-Start--falsetrue (ByPropertyName)0
-UntilDisplay log until this UNIX epoch.falsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuFirewallOptions [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuFirewallRefs [[-PveTicket] <PveTicket>] [-Node] <String> [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-TypeOnly list references of specified type. Enum: alias,ipsetfalsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuFirewallRulesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuMigrate [[-PveTicket] <PveTicket>] [-Node] <String> [[-Target] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-TargetTarget node.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuMtunnelwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Socket] <String> [-Ticket] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-Socketunix socket to forward totruetrue (ByPropertyName)
-Ticketticket return by initial 'mtunnel' API call, or retrieved via 'ticket' tunnel commandtruetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuPending [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuRrd [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Ds] <String> [-Node] <String> [-Timeframe] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CfThe RRD consolidation function Enum: AVERAGE,MAXfalsetrue (ByPropertyName)
-DsThe list of datasources you want to display.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-TimeframeSpecify the time frame you are interested in. Enum: hour,day,week,month,yeartruetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Timeframe] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CfThe RRD consolidation function Enum: AVERAGE,MAXfalsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-TimeframeSpecify the time frame you are interested in. Enum: hour,day,week,month,yeartruetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuSnapshotConfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuSnapshotIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuStatusCurrent [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQemuVncwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Port] <Int32> [-Vmid] <Int32> [-Vncticket] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PortPort number returned by previous vncproxy call.truetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-VncticketTicket from previous call to vncproxy.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesQueryUrlMetadata [[-PveTicket] <PveTicket>] [-Node] <String> [-Url] <String> [-VerifyCertificates] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-UrlThe URL to query the metadata from.truetrue (ByPropertyName)
-VerifyCertificatesIf false, no SSL/TLS certificates will be verified.falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesReplication [[-PveTicket] <PveTicket>] [[-Guest] <Int32>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-GuestOnly list replication jobs for this guest.falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesReplicationIdx [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IdReplication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesReplicationLog [[-PveTicket] <PveTicket>] [-Id] <String> [[-Limit] <Int32>] [-Node] <String> [[-Start] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IdReplication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.truetrue (ByPropertyName)
-Limit--falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-Start--falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesReplicationStatus [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IdReplication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesReport [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesRrd [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Ds] <String> [-Node] <String> [-Timeframe] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CfThe RRD consolidation function Enum: AVERAGE,MAXfalsetrue (ByPropertyName)
-DsThe list of datasources you want to display.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-TimeframeSpecify the time frame you are interested in. Enum: hour,day,week,month,yeartruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Timeframe] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CfThe RRD consolidation function Enum: AVERAGE,MAXfalsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-TimeframeSpecify the time frame you are interested in. Enum: hour,day,week,month,yeartruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesScan [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesScanCifs [[-PveTicket] <PveTicket>] [[-Domain] <String>] [-Node] <String> [[-Password] <SecureString>] [-Server] <String> [[-Username] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DomainSMB domain (Workgroup).falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PasswordUser password.falsetrue (ByPropertyName)
-ServerThe server address (name or IP).truetrue (ByPropertyName)
-UsernameUser name.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesScanGlusterfs [[-PveTicket] <PveTicket>] [-Node] <String> [-Server] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ServerThe server address (name or IP).truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesScanIscsi [[-PveTicket] <PveTicket>] [-Node] <String> [-Portal] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PortalThe iSCSI portal (IP or DNS name with optional port).truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesScanLvm [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesScanLvmthin [[-PveTicket] <PveTicket>] [-Node] <String> [-Vg] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-Vg--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesScanNfs [[-PveTicket] <PveTicket>] [-Node] <String> [-Server] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ServerThe server address (name or IP).truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesScanPbs [[-PveTicket] <PveTicket>] [[-Fingerprint] <String>] [-Node] <String> [-Password] <SecureString> [[-Port] <Int32>] [-Server] <String> [-Username] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-FingerprintCertificate SHA 256 fingerprint.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PasswordUser password or API token secret.truetrue (ByPropertyName)
-PortOptional port.falsetrue (ByPropertyName)0
-ServerThe server address (name or IP).truetrue (ByPropertyName)
-UsernameUser-name or API token-ID.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesScanZfs [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesSdn [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesSdnZones [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesSdnZonesContent [[-PveTicket] <PveTicket>] [-Node] <String> [-Zone] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ZoneThe SDN zone object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesSdnZonesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Zone] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ZoneThe SDN zone object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesServices [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesServicesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ServiceService 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-timesyncdtruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesServicesState [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ServiceService 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-timesyncdtruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesStatus [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesStorage [[-PveTicket] <PveTicket>] [[-Content] <String>] [-Enabled] [-Format] [-Node] <String> [[-Storage] <String>] [[-Target] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ContentOnly list stores which support this content type.falsetrue (ByPropertyName)
-EnabledOnly list stores which are enabled (not disabled in config).falsetrue (ByPropertyName)False
-FormatInclude information about formatsfalsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-StorageOnly list status for specified storagefalsetrue (ByPropertyName)
-TargetIf target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesStorageContent [[-PveTicket] <PveTicket>] [[-Content] <String>] [-Node] <String> [-Storage] <String> [[-Vmid] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ContentOnly list content of this type.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-StorageThe storage identifier.truetrue (ByPropertyName)
-VmidOnly list images for this VMfalsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesStorageContentIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Storage] <String>] [-Volume] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-StorageThe storage identifier.falsetrue (ByPropertyName)
-VolumeVolume identifiertruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesStorageIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Storage] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-StorageThe storage identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesStoragePrunebackups [[-PveTicket] <PveTicket>] [-Node] <String> [[-PruneBackups] <String>] [-Storage] <String> [[-Type] <String>] [[-Vmid] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PruneBackupsUse these retention options instead of those from the storage configuration.falsetrue (ByPropertyName)
-StorageThe storage identifier.truetrue (ByPropertyName)
-TypeEither 'qemu' or 'lxc'. Only consider backups for guests of this type. Enum: qemu,lxcfalsetrue (ByPropertyName)
-VmidOnly consider backups for this guest.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesStorageRrd [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Ds] <String> [-Node] <String> [-Storage] <String> [-Timeframe] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CfThe RRD consolidation function Enum: AVERAGE,MAXfalsetrue (ByPropertyName)
-DsThe list of datasources you want to display.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-StorageThe storage identifier.truetrue (ByPropertyName)
-TimeframeSpecify the time frame you are interested in. Enum: hour,day,week,month,yeartruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesStorageRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Storage] <String> [-Timeframe] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CfThe RRD consolidation function Enum: AVERAGE,MAXfalsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-StorageThe storage identifier.truetrue (ByPropertyName)
-TimeframeSpecify the time frame you are interested in. Enum: hour,day,week,month,yeartruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesStorageStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Storage] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-StorageThe storage identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesSyslog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Service] <String>] [[-Since] <String>] [[-Start] <Int32>] [[-Until] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Limit--falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-ServiceService IDfalsetrue (ByPropertyName)
-SinceDisplay all log since this date-time string.falsetrue (ByPropertyName)
-Start--falsetrue (ByPropertyName)0
-UntilDisplay all log until this date-time string.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ErrorsOnly list tasks with a status of ERROR.falsetrue (ByPropertyName)False
-LimitOnly list this amount of tasks.falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-SinceOnly list tasks since this UNIX epoch.falsetrue (ByPropertyName)0
-SourceList archived, active or all tasks. Enum: archive,active,allfalsetrue (ByPropertyName)
-StartList tasks beginning from this offset.falsetrue (ByPropertyName)0
-StatusfilterList of Task States that should be returned.falsetrue (ByPropertyName)
-TypefilterOnly list tasks of this type (e.g., vzstart, vzdump).falsetrue (ByPropertyName)
-UntilOnly list tasks until this UNIX epoch.falsetrue (ByPropertyName)0
-UserfilterOnly list tasks from this user.falsetrue (ByPropertyName)
-VmidOnly list tasks for this VM.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesTasksIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-Upid--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesTasksLog [[-PveTicket] <PveTicket>] [-Download] [[-Limit] <Int32>] [-Node] <String> [[-Start] <Int32>] [-Upid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DownloadWhether the tasklog file should be downloaded. This parameter can't be used in conjunction with other parametersfalsetrue (ByPropertyName)False
-LimitThe amount of lines to read from the tasklog.falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-StartStart at this line when reading the tasklogfalsetrue (ByPropertyName)0
-UpidThe task's unique ID.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Get-PveTasksStatus
  • +
+
+
+
+

Syntax

+
+
+
+ Get-PveNodesTasksStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-UpidThe task's unique ID.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesTime [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesVersion [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesVncwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Port] <Int32> [-Vncticket] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PortPort number returned by previous vncproxy call.truetrue (ByPropertyName)0
-VncticketTicket from previous call to vncproxy.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesVzdumpDefaults [[-PveTicket] <PveTicket>] [-Node] <String> [[-Storage] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-StorageThe storage identifier.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveNodesVzdumpExtractconfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Volume] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VolumeVolume identifiertruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PvePools [[-PveTicket] <PveTicket>] [[-Poolid] <String>] [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Poolid--falsetrue (ByPropertyName)
-Type-- Enum: qemu,lxc,storagefalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PvePoolsIdx [[-PveTicket] <PveTicket>] [-Poolid] <String> [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Poolid--truetrue (ByPropertyName)
-Type-- Enum: qemu,lxc,storagefalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveStorage [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-TypeOnly list storage of specific type Enum: btrfs,cephfs,cifs,dir,glusterfs,iscsi,iscsidirect,lvm,lvmthin,nfs,pbs,rbd,zfs,zfspoolfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveStorageIdx [[-PveTicket] <PveTicket>] [-Storage] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-StorageThe storage identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveTaskIsRunning [[-PveTicket] <PveTicket>] [-Upid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-UpidUpid task e.g UPID:pve1:00004A1A:0964214C:5EECEF11:vzdump:134:root@pam:truetrue (ByValue, ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • Bool. Return tas is running.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveVersion [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveVm [[-PveTicket] <PveTicket>] [[-VmIdOrName] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-VmIdOrNameThe 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";falsetrue (ByValue, ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PSCustomObject. Return Vm Data.
+
+
+
+ +
+

Syntax

+
+
+
+ Get-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-VmIdOrNameThe (unique) ID or Name of the VM.truetrue (ByValue, ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Invoke-PveRestApi [[-PveTicket] <PveTicket>] [-Resource] <String> [[-Method] <String>] [[-ResponseType] <String>] [[-Parameters] <Hashtable>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket datafalsetrue (ByValue, ByPropertyName)
-ResourceResource Requesttruefalse
-MethodMethod requestfalsefalseGet
-ResponseTypeType requestfalsefalsejson
-ParametersParameters requestfalsefalse
+
+
+

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}
+
+
+
+
+ +
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-xNonefalsefalse
+
+
+
+ +
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AcrValuesSpecifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request.falsetrue (ByPropertyName)
-AutocreateAutomatically create users if they do not exist.falsetrue (ByPropertyName)False
-BaseDnLDAP base domain namefalsetrue (ByPropertyName)
-BindDnLDAP bind domain namefalsetrue (ByPropertyName)
-CapathPath to the CA certificate storefalsetrue (ByPropertyName)
-CaseSensitiveusername is case-sensitivefalsetrue (ByPropertyName)False
-CertPath to the client certificatefalsetrue (ByPropertyName)
-CertkeyPath to the client certificate keyfalsetrue (ByPropertyName)
-CheckConnectionCheck bind connection to the server.falsetrue (ByPropertyName)False
-ClientIdOpenID Client IDfalsetrue (ByPropertyName)
-ClientKeyOpenID Client Keyfalsetrue (ByPropertyName)
-CommentDescription.falsetrue (ByPropertyName)
-DefaultUse this as default realmfalsetrue (ByPropertyName)False
-DomainAD domain namefalsetrue (ByPropertyName)
-FilterLDAP filter for user sync.falsetrue (ByPropertyName)
-GroupClassesThe objectclasses for groups.falsetrue (ByPropertyName)
-GroupDnLDAP base domain name for group sync. If not set, the base_dn will be used.falsetrue (ByPropertyName)
-GroupFilterLDAP filter for group sync.falsetrue (ByPropertyName)
-GroupNameAttrLDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name.falsetrue (ByPropertyName)
-IssuerUrlOpenID Issuer Urlfalsetrue (ByPropertyName)
-ModeLDAP protocol mode. Enum: ldap,ldaps,ldap+starttlsfalsetrue (ByPropertyName)
-PasswordLDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'.falsetrue (ByPropertyName)
-PortServer port.falsetrue (ByPropertyName)0
-PromptSpecifies whether the Authorization Server prompts the End-User for reauthentication and consent.falsetrue (ByPropertyName)
-RealmAuthentication domain IDtruetrue (ByPropertyName)
-ScopesSpecifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'.falsetrue (ByPropertyName)
-SecureUse secure LDAPS protocol. DEPRECATED':' use 'mode' instead.falsetrue (ByPropertyName)False
-Server1Server IP address (or DNS name)falsetrue (ByPropertyName)
-Server2Fallback Server IP address (or DNS name)falsetrue (ByPropertyName)
-SslversionLDAPS TLS/SSL version. It's not recommended to use version older than 1.2! Enum: tlsv1,tlsv1_1,tlsv1_2,tlsv1_3falsetrue (ByPropertyName)
-SyncDefaultsOptionsThe default options for behavior of synchronizations.falsetrue (ByPropertyName)
-SyncAttributesComma 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.falsetrue (ByPropertyName)
-TfaUse Two-factor authentication.falsetrue (ByPropertyName)
-TypeRealm type. Enum: ad,ldap,openid,pam,pvetruetrue (ByPropertyName)
-UserAttrLDAP user attribute namefalsetrue (ByPropertyName)
-UserClassesThe objectclasses for users.falsetrue (ByPropertyName)
-UsernameClaimOpenID claim used to generate the unique username.falsetrue (ByPropertyName)
-VerifyVerify the server's SSL certificatefalsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveAccessDomainsSync [[-PveTicket] <PveTicket>] [-DryRun] [-EnableNew] [-Full] [-Purge] [-Realm] <String> [[-RemoveVanished] <String>] [[-Scope] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DryRunIf set, does not write anything.falsetrue (ByPropertyName)False
-EnableNewEnable newly synced users immediately.falsetrue (ByPropertyName)False
-FullDEPRECATED':' 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.falsetrue (ByPropertyName)False
-PurgeDEPRECATED':' use 'remove-vanished' instead. Remove ACLs for users or groups which were removed from the config during a sync.falsetrue (ByPropertyName)False
-RealmAuthentication domain IDtruetrue (ByPropertyName)
-RemoveVanishedA 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).falsetrue (ByPropertyName)
-ScopeSelect what to sync. Enum: users,groups,bothfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveAccessGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Groupid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-Groupid--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveAccessOpenidAuthUrl [[-PveTicket] <PveTicket>] [-Realm] <String> [-RedirectUrl] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-RealmAuthentication domain IDtruetrue (ByPropertyName)
-RedirectUrlRedirection Url. The client should set this to the used server url (location.origin).truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveAccessOpenidLogin [[-PveTicket] <PveTicket>] [-Code] <String> [-RedirectUrl] <String> [-State] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CodeOpenId authorization code.truetrue (ByPropertyName)
-RedirectUrlRedirection Url. The client should set this to the used server url (location.origin).truetrue (ByPropertyName)
-StateOpenId state.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveAccessRoles [[-PveTicket] <PveTicket>] [[-Privs] <String>] [-Roleid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Privs--falsetrue (ByPropertyName)
-Roleid--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveAccessTfa [[-PveTicket] <PveTicket>] [[-Challenge] <String>] [[-Description] <String>] [[-Password] <SecureString>] [[-Totp] <String>] [-Type] <String> [-Userid] <String> [[-Value] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ChallengeWhen responding to a u2f challenge':' the original challenge stringfalsetrue (ByPropertyName)
-DescriptionA description to distinguish multiple entries from one anotherfalsetrue (ByPropertyName)
-PasswordThe current password.falsetrue (ByPropertyName)
-TotpA totp URI.falsetrue (ByPropertyName)
-TypeTFA Entry Type. Enum: totp,u2f,webauthn,recovery,yubicotruetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
-ValueThe current value for the provided totp URI, or a Webauthn/U2F challenge responsefalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveAccessTicket [[-PveTicket] <PveTicket>] [-NewFormat] [[-Otp] <String>] [-Password] <SecureString> [[-Path] <String>] [[-Privs] <String>] [[-Realm] <String>] [[-TfaChallenge] <String>] [-Username] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NewFormatThis parameter is now ignored and assumed to be 1.falsetrue (ByPropertyName)False
-OtpOne-time password for Two-factor authentication.falsetrue (ByPropertyName)
-PasswordThe secret password. This can also be a valid ticket.truetrue (ByPropertyName)
-PathVerify ticket, and check if user have access 'privs' on 'path'falsetrue (ByPropertyName)
-PrivsVerify ticket, and check if user have access 'privs' on 'path'falsetrue (ByPropertyName)
-RealmYou can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.falsetrue (ByPropertyName)
-TfaChallengeThe signed TFA challenge string the user wants to respond to.falsetrue (ByPropertyName)
-UsernameUser nametruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-Email--falsetrue (ByPropertyName)
-EnableEnable the account (default). You can set this to '0' to disable the accountfalsetrue (ByPropertyName)False
-ExpireAccount expiration date (seconds since epoch). '0' means no expiration date.falsetrue (ByPropertyName)0
-Firstname--falsetrue (ByPropertyName)
-Groups--falsetrue (ByPropertyName)
-KeysKeys for two factor auth (yubico).falsetrue (ByPropertyName)
-Lastname--falsetrue (ByPropertyName)
-PasswordInitial password.falsetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveAccessUsersToken [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Expire] <Int32>] [-Privsep] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-ExpireAPI token expiration date (seconds since epoch). '0' means no expiration date.falsetrue (ByPropertyName)0
-PrivsepRestrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.falsetrue (ByPropertyName)False
-TokenidUser-specific token identifier.truetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [-Contact] <String> [[-Directory] <String>] [[-EabHmacKey] <String>] [[-EabKid] <String>] [[-Name] <String>] [[-TosUrl] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ContactContact email addresses.truetrue (ByPropertyName)
-DirectoryURL of ACME CA directory endpoint.falsetrue (ByPropertyName)
-EabHmacKeyHMAC key for External Account Binding.falsetrue (ByPropertyName)
-EabKidKey Identifier for External Account Binding.falsetrue (ByPropertyName)
-NameACME account config file name.falsetrue (ByPropertyName)
-TosUrlURL of CA TermsOfService - setting this indicates agreement.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [[-Api] <String>] [[-Data] <String>] [-Disable] [-Id] <String> [[-Nodes] <String>] [-Type] <String> [[-ValidationDelay] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ApiAPI 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,zonomifalsetrue (ByPropertyName)
-DataDNS plugin data. (base64 encoded)falsetrue (ByPropertyName)
-DisableFlag to disable the config.falsetrue (ByPropertyName)False
-IdACME Plugin ID nametruetrue (ByPropertyName)
-NodesList of cluster node names.falsetrue (ByPropertyName)
-TypeACME challenge type. Enum: dns,standalonetruetrue (ByPropertyName)
-ValidationDelayExtra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterBackup [[-PveTicket] <PveTicket>] [-All] [[-Bwlimit] <Int32>] [[-Comment] <String>] [[-Compress] <String>] [[-Dow] <String>] [[-Dumpdir] <String>] [-Enabled] [[-Exclude] <String>] [[-ExcludePath] <Array>] [[-Id] <String>] [[-Ionice] <Int32>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AllBackup all known guest systems on this host.falsetrue (ByPropertyName)False
-BwlimitLimit I/O bandwidth (in KiB/s).falsetrue (ByPropertyName)0
-CommentDescription for the Job.falsetrue (ByPropertyName)
-CompressCompress dump file. Enum: 0,1,gzip,lzo,zstdfalsetrue (ByPropertyName)
-DowDay of week selection.falsetrue (ByPropertyName)
-DumpdirStore resulting files to specified directory.falsetrue (ByPropertyName)
-EnabledEnable or disable the job.falsetrue (ByPropertyName)False
-ExcludeExclude specified guest systems (assumes --all)falsetrue (ByPropertyName)
-ExcludePathExclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.falsetrue (ByPropertyName)
-IdJob ID (will be autogenerated).falsetrue (ByPropertyName)
-IoniceSet 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.falsetrue (ByPropertyName)0
-LockwaitMaximal time to wait for the global lock (minutes).falsetrue (ByPropertyName)0
-MailnotificationDeprecated':' use 'notification-policy' instead. Enum: always,failurefalsetrue (ByPropertyName)
-MailtoComma-separated list of email addresses or users that should receive email notifications. Has no effect if the 'notification-target' option is set at the same time.falsetrue (ByPropertyName)
-MaxfilesDeprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system.falsetrue (ByPropertyName)0
-ModeBackup mode. Enum: snapshot,suspend,stopfalsetrue (ByPropertyName)
-NodeOnly run if executed on this node.falsetrue (ByPropertyName)
-NotesTemplateTemplate 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.falsetrue (ByPropertyName)
-NotificationPolicySpecify when to send a notification Enum: always,failure,neverfalsetrue (ByPropertyName)
-NotificationTargetDetermine the target to which notifications should be sent. Can either be a notification endpoint or a notification group. This option takes precedence over 'mailto', meaning that if both are set, the 'mailto' option will be ignored.falsetrue (ByPropertyName)
-PerformanceOther performance-related settings.falsetrue (ByPropertyName)
-PigzUse pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.falsetrue (ByPropertyName)0
-PoolBackup all known guest systems included in the specified pool.falsetrue (ByPropertyName)
-ProtectedIf true, mark backup(s) as protected.falsetrue (ByPropertyName)False
-PruneBackupsUse these retention options instead of those from the storage configuration.falsetrue (ByPropertyName)
-QuietBe quiet.falsetrue (ByPropertyName)False
-RemovePrune older backups according to 'prune-backups'.falsetrue (ByPropertyName)False
-RepeatMissedIf true, the job will be run as soon as possible if it was missed while the scheduler was not running.falsetrue (ByPropertyName)False
-ScheduleBackup schedule. The format is a subset of `systemd` calendar events.falsetrue (ByPropertyName)
-ScriptUse specified hook script.falsetrue (ByPropertyName)
-StarttimeJob Start time.falsetrue (ByPropertyName)
-StdexcludesExclude temporary files and logs.falsetrue (ByPropertyName)False
-StopStop running backup jobs on this host.falsetrue (ByPropertyName)False
-StopwaitMaximal time to wait until a guest system is stopped (minutes).falsetrue (ByPropertyName)0
-StorageStore resulting file to this storage.falsetrue (ByPropertyName)
-TmpdirStore temporary files to specified directory.falsetrue (ByPropertyName)
-VmidThe ID of the guest system you want to backup.falsetrue (ByPropertyName)
-ZstdZstd threads. N=0 uses half of the available cores, N>0 uses N as thread count.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterConfig [[-PveTicket] <PveTicket>] [-Clustername] <String> [[-LinkN] <Hashtable>] [[-Nodeid] <Int32>] [[-Votes] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ClusternameThe name of the cluster.truetrue (ByPropertyName)
-LinkNAddress and priority information of a single corosync link. (up to 8 links supported; link0..link7)falsetrue (ByPropertyName)
-NodeidNode id for this node.falsetrue (ByPropertyName)0
-VotesNumber of votes for this node.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterConfigJoin [[-PveTicket] <PveTicket>] [-Fingerprint] <String> [-Force] [-Hostname] <String> [[-LinkN] <Hashtable>] [[-Nodeid] <Int32>] [-Password] <SecureString> [[-Votes] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-FingerprintCertificate SHA 256 fingerprint.truetrue (ByPropertyName)
-ForceDo not throw error if node already exists.falsetrue (ByPropertyName)False
-HostnameHostname (or IP) of an existing cluster member.truetrue (ByPropertyName)
-LinkNAddress and priority information of a single corosync link. (up to 8 links supported; link0..link7)falsetrue (ByPropertyName)
-NodeidNode id for this node.falsetrue (ByPropertyName)0
-PasswordSuperuser (root) password of peer node.truetrue (ByPropertyName)
-VotesNumber of votes for this nodefalsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterConfigNodes [[-PveTicket] <PveTicket>] [[-Apiversion] <Int32>] [-Force] [[-LinkN] <Hashtable>] [[-NewNodeIp] <String>] [-Node] <String> [[-Nodeid] <Int32>] [[-Votes] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ApiversionThe JOIN_API_VERSION of the new node.falsetrue (ByPropertyName)0
-ForceDo not throw error if node already exists.falsetrue (ByPropertyName)False
-LinkNAddress and priority information of a single corosync link. (up to 8 links supported; link0..link7)falsetrue (ByPropertyName)
-NewNodeIpIP Address of node to add. Used as fallback if no links are given.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-NodeidNode id for this node.falsetrue (ByPropertyName)0
-VotesNumber of votes for this nodefalsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-NameAlias name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Digest] <String>] [-Group] <String> [[-Rename] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-GroupSecurity Group name.truetrue (ByPropertyName)
-RenameRename/update an existing security group. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing group.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterFirewallGroupsIdx [[-PveTicket] <PveTicket>] [-Action] <String> [[-Comment] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [-Group] <String> [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [-Type] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ActionRule action ('ACCEPT', 'DROP', 'REJECT') or security group name.truetrue (ByPropertyName)
-CommentDescriptive comment.falsetrue (ByPropertyName)
-DestRestrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DportRestrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-EnableFlag to enable/disable a rule.falsetrue (ByPropertyName)0
-GroupSecurity Group name.truetrue (ByPropertyName)
-IcmpTypeSpecify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.falsetrue (ByPropertyName)
-IfaceNetwork interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.falsetrue (ByPropertyName)
-LogLog level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-MacroUse predefined standard macro.falsetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
-ProtoIP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.falsetrue (ByPropertyName)
-SourceRestrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-SportRestrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-TypeRule type. Enum: in,out,grouptruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [[-Rename] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NameIP set name.truetrue (ByPropertyName)
-RenameRename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Nomatch] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-NameIP set name.truetrue (ByPropertyName)
-Nomatch--falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [-Action] <String> [[-Comment] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [-Type] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ActionRule action ('ACCEPT', 'DROP', 'REJECT') or security group name.truetrue (ByPropertyName)
-CommentDescriptive comment.falsetrue (ByPropertyName)
-DestRestrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DportRestrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-EnableFlag to enable/disable a rule.falsetrue (ByPropertyName)0
-IcmpTypeSpecify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.falsetrue (ByPropertyName)
-IfaceNetwork interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.falsetrue (ByPropertyName)
-LogLog level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-MacroUse predefined standard macro.falsetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
-ProtoIP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.falsetrue (ByPropertyName)
-SourceRestrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-SportRestrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-TypeRule type. Enum: in,out,grouptruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterHaGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Group] <String> [-Nodes] <String> [-Nofailback] [-Restricted] [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CommentDescription.falsetrue (ByPropertyName)
-GroupThe HA group identifier.truetrue (ByPropertyName)
-NodesList of cluster node names with optional priority.truetrue (ByPropertyName)
-NofailbackThe CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.falsetrue (ByPropertyName)False
-RestrictedResources bound to restricted groups may only run on nodes defined by the group.falsetrue (ByPropertyName)False
-TypeGroup type. Enum: groupfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterHaResources [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Group] <String>] [[-MaxRelocate] <Int32>] [[-MaxRestart] <Int32>] [-Sid] <String> [[-State] <String>] [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CommentDescription.falsetrue (ByPropertyName)
-GroupThe HA group identifier.falsetrue (ByPropertyName)
-MaxRelocateMaximal number of service relocate tries when a service failes to start.falsetrue (ByPropertyName)0
-MaxRestartMaximal number of tries to restart the service on a node after its start failed.falsetrue (ByPropertyName)0
-SidHA 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).truetrue (ByPropertyName)
-StateRequested resource state. Enum: started,stopped,enabled,disabled,ignoredfalsetrue (ByPropertyName)
-TypeResource type. Enum: ct,vmfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterHaResourcesMigrate [[-PveTicket] <PveTicket>] [-Node] <String> [-Sid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeTarget node.truetrue (ByPropertyName)
-SidHA 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).truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterHaResourcesRelocate [[-PveTicket] <PveTicket>] [-Node] <String> [-Sid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeTarget node.truetrue (ByPropertyName)
-SidHA 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).truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-EnableNew] [-Enabled] [-Id] <String> [[-Realm] <String>] [[-RemoveVanished] <String>] [-Schedule] <String> [[-Scope] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CommentDescription for the Job.falsetrue (ByPropertyName)
-EnableNewEnable newly synced users immediately.falsetrue (ByPropertyName)False
-EnabledDetermines if the job is enabled.falsetrue (ByPropertyName)False
-IdThe ID of the job.truetrue (ByPropertyName)
-RealmAuthentication domain IDfalsetrue (ByPropertyName)
-RemoveVanishedA 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).falsetrue (ByPropertyName)
-ScheduleBackup schedule. The format is a subset of `systemd` calendar events.truetrue (ByPropertyName)
-ScopeSelect what to sync. Enum: users,groups,bothfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterMappingPci [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Id] <String> [-Map] <Array> [-Mdev] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DescriptionDescription of the logical PCI device.falsetrue (ByPropertyName)
-IdThe ID of the logical PCI mapping.truetrue (ByPropertyName)
-MapA list of maps for the cluster nodes.truetrue (ByPropertyName)
-Mdev--falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Id] <String> [-Map] <Array> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DescriptionDescription of the logical USB device.falsetrue (ByPropertyName)
-IdThe ID of the logical USB mapping.truetrue (ByPropertyName)
-MapA list of maps for the cluster nodes.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [[-ApiPathPrefix] <String>] [[-Bucket] <String>] [-Disable] [-Id] <String> [[-Influxdbproto] <String>] [[-MaxBodySize] <Int32>] [[-Mtu] <Int32>] [[-Organization] <String>] [[-Path] <String>] [-Port] <Int32> [[-Proto] <String>] [-Server] <String> [[-Timeout] <Int32>] [[-Token] <String>] [-Type] <String> [-VerifyCertificate] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ApiPathPrefixAn API path prefix inserted between '<host>':'<port>/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy.falsetrue (ByPropertyName)
-BucketThe InfluxDB bucket/db. Only necessary when using the http v2 api.falsetrue (ByPropertyName)
-DisableFlag to disable the plugin.falsetrue (ByPropertyName)False
-IdThe ID of the entry.truetrue (ByPropertyName)
-Influxdbproto-- Enum: udp,http,httpsfalsetrue (ByPropertyName)
-MaxBodySizeInfluxDB max-body-size in bytes. Requests are batched up to this size.falsetrue (ByPropertyName)0
-MtuMTU for metrics transmission over UDPfalsetrue (ByPropertyName)0
-OrganizationThe InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api.falsetrue (ByPropertyName)
-Pathroot graphite path (ex':' proxmox.mycluster.mykey)falsetrue (ByPropertyName)
-Portserver network porttruetrue (ByPropertyName)0
-ProtoProtocol to send graphite data. TCP or UDP (default) Enum: udp,tcpfalsetrue (ByPropertyName)
-Serverserver dns name or IP addresstruetrue (ByPropertyName)
-Timeoutgraphite TCP socket timeout (default=1)falsetrue (ByPropertyName)0
-TokenThe InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user':'password' instead.falsetrue (ByPropertyName)
-TypePlugin type. Enum: graphite,influxdbtruetrue (ByPropertyName)
-VerifyCertificateSet to 0 to disable certificate verification for https endpoints.falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Disable] [-Name] <String> [-Server] <String> [-Token] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CommentCommentfalsetrue (ByPropertyName)
-DisableDisable this targetfalsetrue (ByPropertyName)False
-NameThe name of the endpoint.truetrue (ByPropertyName)
-ServerServer URLtruetrue (ByPropertyName)
-TokenSecret tokentruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [[-Author] <String>] [[-Comment] <String>] [-Disable] [[-FromAddress] <String>] [[-Mailto] <Array>] [[-MailtoUser] <Array>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AuthorAuthor of the mailfalsetrue (ByPropertyName)
-CommentCommentfalsetrue (ByPropertyName)
-DisableDisable this targetfalsetrue (ByPropertyName)False
-FromAddress`From` address for the mailfalsetrue (ByPropertyName)
-MailtoList of email recipientsfalsetrue (ByPropertyName)
-MailtoUserList of usersfalsetrue (ByPropertyName)
-NameThe name of the endpoint.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [[-Author] <String>] [[-Comment] <String>] [-Disable] [-FromAddress] <String> [[-Mailto] <Array>] [[-MailtoUser] <Array>] [[-Mode] <String>] [-Name] <String> [[-Password] <SecureString>] [[-Port] <Int32>] [-Server] <String> [[-Username] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AuthorAuthor of the mail. Defaults to 'Proxmox VE'.falsetrue (ByPropertyName)
-CommentCommentfalsetrue (ByPropertyName)
-DisableDisable this targetfalsetrue (ByPropertyName)False
-FromAddress`From` address for the mailtruetrue (ByPropertyName)
-MailtoList of email recipientsfalsetrue (ByPropertyName)
-MailtoUserList of usersfalsetrue (ByPropertyName)
-ModeDetermine which encryption method shall be used for the connection. Enum: insecure,starttls,tlsfalsetrue (ByPropertyName)
-NameThe name of the endpoint.truetrue (ByPropertyName)
-PasswordPassword for SMTP authenticationfalsetrue (ByPropertyName)
-PortThe port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections.falsetrue (ByPropertyName)0
-ServerThe address of the SMTP server.truetrue (ByPropertyName)
-UsernameUsername for SMTP authenticationfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Disable] [-InvertMatch] [[-MatchCalendar] <Array>] [[-MatchField] <Array>] [[-MatchSeverity] <Array>] [[-Mode] <String>] [-Name] <String> [[-Target] <Array>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CommentCommentfalsetrue (ByPropertyName)
-DisableDisable this matcherfalsetrue (ByPropertyName)False
-InvertMatchInvert match of the whole matcherfalsetrue (ByPropertyName)False
-MatchCalendarMatch notification timestampfalsetrue (ByPropertyName)
-MatchFieldMetadata fields to match (regex or exact match). Must be in the form (regex|exact)':'<field>=<value>falsetrue (ByPropertyName)
-MatchSeverityNotification severities to matchfalsetrue (ByPropertyName)
-ModeChoose between 'all' and 'any' for when multiple properties are specified Enum: all,anyfalsetrue (ByPropertyName)
-NameName of the matcher.truetrue (ByPropertyName)
-TargetTargets to notify on matchfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterReplication [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Disable] [-Id] <String> [[-Rate] <Single>] [[-RemoveJob] <String>] [[-Schedule] <String>] [[-Source] <String>] [-Target] <String> [-Type] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CommentDescription.falsetrue (ByPropertyName)
-DisableFlag to disable/deactivate the entry.falsetrue (ByPropertyName)False
-IdReplication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.truetrue (ByPropertyName)
-RateRate limit in mbps (megabytes per second) as floating point number.falsetrue (ByPropertyName)0
-RemoveJobMark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. Enum: local,fullfalsetrue (ByPropertyName)
-ScheduleStorage replication schedule. The format is a subset of `systemd` calendar events.falsetrue (ByPropertyName)
-SourceFor internal use, to detect if the guest was stolen.falsetrue (ByPropertyName)
-TargetTarget node.truetrue (ByPropertyName)
-TypeSection type. Enum: localtruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [[-Asn] <Int32>] [-BgpMultipathAsPathRelax] [-Controller] <String> [-Ebgp] [[-EbgpMultihop] <Int32>] [[-IsisDomain] <String>] [[-IsisIfaces] <String>] [[-IsisNet] <String>] [[-Loopback] <String>] [[-Node] <String>] [[-Peers] <String>] [-Type] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Asnautonomous system numberfalsetrue (ByPropertyName)0
-BgpMultipathAsPathRelax--falsetrue (ByPropertyName)False
-ControllerThe SDN controller object identifier.truetrue (ByPropertyName)
-EbgpEnable ebgp. (remote-as external)falsetrue (ByPropertyName)False
-EbgpMultihop--falsetrue (ByPropertyName)0
-IsisDomainISIS domain.falsetrue (ByPropertyName)
-IsisIfacesISIS interface.falsetrue (ByPropertyName)
-IsisNetISIS network entity title.falsetrue (ByPropertyName)
-Loopbacksource loopback interface.falsetrue (ByPropertyName)
-NodeThe cluster node name.falsetrue (ByPropertyName)
-Peerspeers address list.falsetrue (ByPropertyName)
-TypePlugin type. Enum: bgp,evpn,faucet,isistruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterSdnDns [[-PveTicket] <PveTicket>] [-Dns] <String> [-Key] <String> [[-Reversemaskv6] <Int32>] [[-Reversev6mask] <Int32>] [[-Ttl] <Int32>] [-Type] <String> [-Url] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DnsThe SDN dns object identifier.truetrue (ByPropertyName)
-Key--truetrue (ByPropertyName)
-Reversemaskv6--falsetrue (ByPropertyName)0
-Reversev6mask--falsetrue (ByPropertyName)0
-Ttl--falsetrue (ByPropertyName)0
-TypePlugin type. Enum: powerdnstruetrue (ByPropertyName)
-Url--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [-Ipam] <String> [[-Section] <Int32>] [[-Token] <String>] [-Type] <String> [[-Url] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IpamThe SDN ipam object identifier.truetrue (ByPropertyName)
-Section--falsetrue (ByPropertyName)0
-Token--falsetrue (ByPropertyName)
-TypePlugin type. Enum: netbox,phpipam,pvetruetrue (ByPropertyName)
-Url--falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [[-Alias] <String>] [[-Tag] <Int32>] [[-Type] <String>] [-Vlanaware] [-Vnet] <String> [-Zone] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Aliasalias name of the vnetfalsetrue (ByPropertyName)
-Tagvlan or vxlan idfalsetrue (ByPropertyName)0
-TypeType Enum: vnetfalsetrue (ByPropertyName)
-VlanawareAllow vm VLANs to pass through this vnet.falsetrue (ByPropertyName)False
-VnetThe SDN vnet object identifier.truetrue (ByPropertyName)
-Zonezone idtruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IpThe IP address to associate with the given MAC addresstruetrue (ByPropertyName)
-MacUnicast MAC address.falsetrue (ByPropertyName)
-VnetThe SDN vnet object identifier.truetrue (ByPropertyName)
-ZoneThe SDN zone object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [[-DhcpDnsServer] <String>] [[-DhcpRange] <Array>] [[-Dnszoneprefix] <String>] [[-Gateway] <String>] [-Snat] [-Subnet] <String> [-Type] <String> [-Vnet] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DhcpDnsServerIP address for the DNS serverfalsetrue (ByPropertyName)
-DhcpRangeA list of DHCP ranges for this subnetfalsetrue (ByPropertyName)
-Dnszoneprefixdns domain zone prefix ex':' 'adm' -> <hostname>.adm.mydomain.comfalsetrue (ByPropertyName)
-GatewaySubnet Gateway':' Will be assign on vnet for layer3 zonesfalsetrue (ByPropertyName)
-Snatenable masquerade for this subnet if pve-firewallfalsetrue (ByPropertyName)False
-SubnetThe SDN subnet object identifier.truetrue (ByPropertyName)
-Type-- Enum: subnettruetrue (ByPropertyName)
-Vnetassociated vnettruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-AdvertiseSubnets] [[-Bridge] <String>] [-BridgeDisableMacLearning] [[-Controller] <String>] [[-Dhcp] <String>] [-DisableArpNdSuppression] [[-Dns] <String>] [[-Dnszone] <String>] [[-DpId] <Int32>] [[-Exitnodes] <String>] [-ExitnodesLocalRouting] [[-ExitnodesPrimary] <String>] [[-Ipam] <String>] [[-Mac] <String>] [[-Mtu] <Int32>] [[-Nodes] <String>] [[-Peers] <String>] [[-Reversedns] <String>] [[-RtImport] <String>] [[-Tag] <Int32>] [-Type] <String> [[-VlanProtocol] <String>] [[-VrfVxlan] <Int32>] [[-VxlanPort] <Int32>] [-Zone] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AdvertiseSubnetsAdvertise evpn subnets if you have silent hostsfalsetrue (ByPropertyName)False
-Bridge--falsetrue (ByPropertyName)
-BridgeDisableMacLearningDisable auto mac learning.falsetrue (ByPropertyName)False
-ControllerFrr router namefalsetrue (ByPropertyName)
-DhcpType of the DHCP backend for this zone Enum: dnsmasqfalsetrue (ByPropertyName)
-DisableArpNdSuppressionDisable ipv4 arp && ipv6 neighbour discovery suppressionfalsetrue (ByPropertyName)False
-Dnsdns api serverfalsetrue (ByPropertyName)
-Dnszonedns domain zone ex':' mydomain.comfalsetrue (ByPropertyName)
-DpIdFaucet dataplane idfalsetrue (ByPropertyName)0
-ExitnodesList of cluster node names.falsetrue (ByPropertyName)
-ExitnodesLocalRoutingAllow exitnodes to connect to evpn guestsfalsetrue (ByPropertyName)False
-ExitnodesPrimaryForce traffic to this exitnode first.falsetrue (ByPropertyName)
-Ipamuse a specific ipamfalsetrue (ByPropertyName)
-MacAnycast logical router mac addressfalsetrue (ByPropertyName)
-MtuMTUfalsetrue (ByPropertyName)0
-NodesList of cluster node names.falsetrue (ByPropertyName)
-Peerspeers address list.falsetrue (ByPropertyName)
-Reversednsreverse dns api serverfalsetrue (ByPropertyName)
-RtImportRoute-Target importfalsetrue (ByPropertyName)
-TagService-VLAN Tagfalsetrue (ByPropertyName)0
-TypePlugin type. Enum: evpn,faucet,qinq,simple,vlan,vxlantruetrue (ByPropertyName)
-VlanProtocol-- Enum: 802.1q,802.1adfalsetrue (ByPropertyName)
-VrfVxlanl3vni.falsetrue (ByPropertyName)0
-VxlanPortVxlan tunnel udp port (default 4789).falsetrue (ByPropertyName)0
-ZoneThe SDN zone object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesAplinfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Storage] <String> [-Template] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-StorageThe storage where the template will be storedtruetrue (ByPropertyName)
-TemplateThe template which will downloadedtruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Enabled] [-Index] <Int32> [-Node] <String> [-Path] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DigestDigest to detect modifications.falsetrue (ByPropertyName)
-EnabledWhether the repository should be enabled or not.falsetrue (ByPropertyName)False
-IndexIndex within the file (starting from 0).truetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-PathPath to the containing file.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Update-PveNode
  • +
+
+
+
+

Syntax

+
+
+
+ New-PveNodesAptUpdate [[-PveTicket] <PveTicket>] [-Node] <String> [-Notify] [-Quiet] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-NotifySend notification about new packages.falsetrue (ByPropertyName)False
-QuietOnly produces output suitable for logging, omitting progress indicators.falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesCephFs [[-PveTicket] <PveTicket>] [-AddStorage] [[-Name] <String>] [-Node] <String> [[-PgNum] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AddStorageConfigure the created CephFS as storage for this cluster.falsetrue (ByPropertyName)False
-NameThe ceph filesystem name.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PgNumNumber of placement groups for the backing data pool. The metadata pool will use a quarter of this.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesCephInit [[-PveTicket] <PveTicket>] [[-ClusterNetwork] <String>] [-DisableCephx] [[-MinSize] <Int32>] [[-Network] <String>] [-Node] <String> [[-PgBits] <Int32>] [[-Size] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ClusterNetworkDeclare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over itfalsetrue (ByPropertyName)
-DisableCephxDisable cephx authentication.WARNING':' cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private!falsetrue (ByPropertyName)False
-MinSizeMinimum number of available replicas per object to allow I/Ofalsetrue (ByPropertyName)0
-NetworkUse specific network for all ceph related trafficfalsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PgBitsPlacement group bits, used to specify the default number of placement groups.Depreacted. This setting was deprecated in recent Ceph versions.falsetrue (ByPropertyName)0
-SizeTargeted number of replicas per objectfalsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesCephMds [[-PveTicket] <PveTicket>] [-Hotstandby] [[-Name] <String>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-HotstandbyDetermines whether a ceph-mds daemon should poll and replay the log of an active MDS. Faster switch on MDS failure, but needs more idle resources.falsetrue (ByPropertyName)False
-NameThe ID for the mds, when omitted the same as the nodenamefalsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesCephMgr [[-PveTicket] <PveTicket>] [[-Id] <String>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IdThe ID for the manager, when omitted the same as the nodenamefalsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesCephMon [[-PveTicket] <PveTicket>] [[-MonAddress] <String>] [[-Monid] <String>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-MonAddressOverwrites autodetected monitor IP address(es). Must be in the public network(s) of Ceph.falsetrue (ByPropertyName)
-MonidThe ID for the monitor, when omitted the same as the nodenamefalsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesCephOsd [[-PveTicket] <PveTicket>] [[-CrushDeviceClass] <String>] [[-DbDev] <String>] [[-DbDevSize] <Single>] [-Dev] <String> [-Encrypted] [-Node] <String> [[-OsdsPerDevice] <Int32>] [[-WalDev] <String>] [[-WalDevSize] <Single>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CrushDeviceClassSet the device class of the OSD in crush.falsetrue (ByPropertyName)
-DbDevBlock device name for block.db.falsetrue (ByPropertyName)
-DbDevSizeSize in GiB for block.db.falsetrue (ByPropertyName)0
-DevBlock device name.truetrue (ByPropertyName)
-EncryptedEnables encryption of the OSD.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-OsdsPerDeviceOSD services per physical device. Only useful for fast NVMe devices" ." to utilize their performance better.falsetrue (ByPropertyName)0
-WalDevBlock device name for block.wal.falsetrue (ByPropertyName)
-WalDevSizeSize in GiB for block.wal.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesCephOsdIn [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-OsdidOSD IDtruetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesCephOsdOut [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-OsdidOSD IDtruetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesCephOsdScrub [[-PveTicket] <PveTicket>] [-Deep] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DeepIf set, instructs a deep scrub instead of a normal one.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-OsdidOSD IDtruetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesCephPool [[-PveTicket] <PveTicket>] [-AddStorages] [[-Application] <String>] [[-CrushRule] <String>] [[-ErasureCoding] <String>] [[-MinSize] <Int32>] [-Name] <String> [-Node] <String> [[-PgAutoscaleMode] <String>] [[-PgNum] <Int32>] [[-PgNumMin] <Int32>] [[-Size] <Int32>] [[-TargetSize] <String>] [[-TargetSizeRatio] <Single>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AddStoragesConfigure VM and CT storage using the new pool.falsetrue (ByPropertyName)False
-ApplicationThe application of the pool. Enum: rbd,cephfs,rgwfalsetrue (ByPropertyName)
-CrushRuleThe rule to use for mapping object placement in the cluster.falsetrue (ByPropertyName)
-ErasureCodingCreate an erasure coded pool for RBD with an accompaning replicated pool for metadata storage. With EC, the common ceph options 'size', 'min_size' and 'crush_rule' parameters will be applied to the metadata pool.falsetrue (ByPropertyName)
-MinSizeMinimum number of replicas per objectfalsetrue (ByPropertyName)0
-NameThe name of the pool. It must be unique.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PgAutoscaleModeThe automatic PG scaling mode of the pool. Enum: on,off,warnfalsetrue (ByPropertyName)
-PgNumNumber of placement groups.falsetrue (ByPropertyName)0
-PgNumMinMinimal number of placement groups.falsetrue (ByPropertyName)0
-SizeNumber of replicas per objectfalsetrue (ByPropertyName)0
-TargetSizeThe estimated target size of the pool for the PG autoscaler.falsetrue (ByPropertyName)
-TargetSizeRatioThe estimated target ratio of the pool for the PG autoscaler.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesCephRestart [[-PveTicket] <PveTicket>] [-Node] <String> [[-Service] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ServiceCeph service name.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesCephStart [[-PveTicket] <PveTicket>] [-Node] <String> [[-Service] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ServiceCeph service name.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesCephStop [[-PveTicket] <PveTicket>] [-Node] <String> [[-Service] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ServiceCeph service name.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesCertificatesAcmeCertificate [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ForceOverwrite existing custom certificate.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesCertificatesCustom [[-PveTicket] <PveTicket>] [-Certificates] <String> [-Force] [[-Key] <String>] [-Node] <String> [-Restart] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CertificatesPEM encoded certificate (chain).truetrue (ByPropertyName)
-ForceOverwrite existing custom or ACME certificate files.falsetrue (ByPropertyName)False
-KeyPEM encoded private key.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-RestartRestart pveproxy.falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesDisksDirectory [[-PveTicket] <PveTicket>] [-AddStorage] [-Device] <String> [[-Filesystem] <String>] [-Name] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AddStorageConfigure storage using the directory.falsetrue (ByPropertyName)False
-DeviceThe block device you want to create the filesystem on.truetrue (ByPropertyName)
-FilesystemThe desired filesystem. Enum: ext4,xfsfalsetrue (ByPropertyName)
-NameThe storage identifier.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesDisksInitgpt [[-PveTicket] <PveTicket>] [-Disk] <String> [-Node] <String> [[-Uuid] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DiskBlock device nametruetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-UuidUUID for the GPT tablefalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesDisksLvm [[-PveTicket] <PveTicket>] [-AddStorage] [-Device] <String> [-Name] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AddStorageConfigure storage using the Volume Groupfalsetrue (ByPropertyName)False
-DeviceThe block device you want to create the volume group ontruetrue (ByPropertyName)
-NameThe storage identifier.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesDisksLvmthin [[-PveTicket] <PveTicket>] [-AddStorage] [-Device] <String> [-Name] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AddStorageConfigure storage using the thinpool.falsetrue (ByPropertyName)False
-DeviceThe block device you want to create the thinpool on.truetrue (ByPropertyName)
-NameThe storage identifier.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesDisksZfs [[-PveTicket] <PveTicket>] [-AddStorage] [[-Ashift] <Int32>] [[-Compression] <String>] [-Devices] <String> [[-DraidConfig] <String>] [-Name] <String> [-Node] <String> [-Raidlevel] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AddStorageConfigure storage using the zpool.falsetrue (ByPropertyName)False
-AshiftPool sector size exponent.falsetrue (ByPropertyName)0
-CompressionThe compression algorithm to use. Enum: on,off,gzip,lz4,lzjb,zle,zstdfalsetrue (ByPropertyName)
-DevicesThe block devices you want to create the zpool on.truetrue (ByPropertyName)
-DraidConfig--falsetrue (ByPropertyName)
-NameThe storage identifier.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-RaidlevelThe RAID level to use. Enum: single,mirror,raid10,raidz,raidz2,raidz3,draid,draid2,draid3truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesExecute [[-PveTicket] <PveTicket>] [-Commands] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CommandsJSON encoded array of commands.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [-Action] <String> [[-Comment] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [-Type] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ActionRule action ('ACCEPT', 'DROP', 'REJECT') or security group name.truetrue (ByPropertyName)
-CommentDescriptive comment.falsetrue (ByPropertyName)
-DestRestrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DportRestrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-EnableFlag to enable/disable a rule.falsetrue (ByPropertyName)0
-IcmpTypeSpecify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.falsetrue (ByPropertyName)
-IfaceNetwork interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.falsetrue (ByPropertyName)
-LogLog level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-MacroUse predefined standard macro.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
-ProtoIP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.falsetrue (ByPropertyName)
-SourceRestrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-SportRestrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-TypeRule type. Enum: in,out,grouptruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesHosts [[-PveTicket] <PveTicket>] [-Data] <String> [[-Digest] <String>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DataThe target content of /etc/hosts.truetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesLxc [[-PveTicket] <PveTicket>] [[-Arch] <String>] [[-Bwlimit] <Single>] [[-Cmode] <String>] [-Console] [[-Cores] <Int32>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [-Debug_] [[-Description] <String>] [[-DevN] <Hashtable>] [[-Features] <String>] [-Force] [[-Hookscript] <String>] [[-Hostname] <String>] [-IgnoreUnpackErrors] [[-Lock] <String>] [[-Memory] <Int32>] [[-MpN] <Hashtable>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Onboot] [-Ostemplate] <String> [[-Ostype] <String>] [[-Password] <SecureString>] [[-Pool] <String>] [-Protection] [-Restore] [[-Rootfs] <String>] [[-Searchdomain] <String>] [[-SshPublicKeys] <String>] [-Start] [[-Startup] <String>] [[-Storage] <String>] [[-Swap] <Int32>] [[-Tags] <String>] [-Template] [[-Timezone] <String>] [[-Tty] <Int32>] [-Unique] [-Unprivileged] [[-UnusedN] <Hashtable>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ArchOS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64falsetrue (ByPropertyName)
-BwlimitOverride I/O bandwidth limit (in KiB/s).falsetrue (ByPropertyName)0
-CmodeConsole mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). Enum: shell,console,ttyfalsetrue (ByPropertyName)
-ConsoleAttach a console device (/dev/console) to the container.falsetrue (ByPropertyName)False
-CoresThe number of cores assigned to the container. A container can use all available cores by default.falsetrue (ByPropertyName)0
-CpulimitLimit of CPU usage.NOTE':' If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.falsetrue (ByPropertyName)0
-CpuunitsCPU weight for a container, will be clamped to \[1, 10000] in cgroup v2.falsetrue (ByPropertyName)0
-Debug_Try to be more verbose. For now this only enables debug log-level on start.falsetrue (ByPropertyName)False
-DescriptionDescription for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.falsetrue (ByPropertyName)
-DevNDevice to pass through to the containerfalsetrue (ByPropertyName)
-FeaturesAllow containers access to advanced features.falsetrue (ByPropertyName)
-ForceAllow to overwrite existing container.falsetrue (ByPropertyName)False
-HookscriptScript that will be exectued during various steps in the containers lifetime.falsetrue (ByPropertyName)
-HostnameSet a host name for the container.falsetrue (ByPropertyName)
-IgnoreUnpackErrorsIgnore errors when extracting the template.falsetrue (ByPropertyName)False
-LockLock/unlock the container. Enum: backup,create,destroyed,disk,fstrim,migrate,mounted,rollback,snapshot,snapshot-deletefalsetrue (ByPropertyName)
-MemoryAmount of RAM for the container in MB.falsetrue (ByPropertyName)0
-MpNUse volume as container mount point. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume.falsetrue (ByPropertyName)
-NameserverSets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.falsetrue (ByPropertyName)
-NetNSpecifies network interfaces for the container.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-OnbootSpecifies whether a container will be started during system bootup.falsetrue (ByPropertyName)False
-OstemplateThe OS template or backup file.truetrue (ByPropertyName)
-OstypeOS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. Enum: debian,devuan,ubuntu,centos,fedora,opensuse,archlinux,alpine,gentoo,nixos,unmanagedfalsetrue (ByPropertyName)
-PasswordSets root password inside container.falsetrue (ByPropertyName)
-PoolAdd the VM to the specified pool.falsetrue (ByPropertyName)
-ProtectionSets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.falsetrue (ByPropertyName)False
-RestoreMark this as restore task.falsetrue (ByPropertyName)False
-RootfsUse volume as container root.falsetrue (ByPropertyName)
-SearchdomainSets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.falsetrue (ByPropertyName)
-SshPublicKeysSetup public SSH keys (one key per line, OpenSSH format).falsetrue (ByPropertyName)
-StartStart the CT after its creation finished successfully.falsetrue (ByPropertyName)False
-StartupStartup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.falsetrue (ByPropertyName)
-StorageDefault Storage.falsetrue (ByPropertyName)
-SwapAmount of SWAP for the container in MB.falsetrue (ByPropertyName)0
-TagsTags of the Container. This is only meta information.falsetrue (ByPropertyName)
-TemplateEnable/disable Template.falsetrue (ByPropertyName)False
-TimezoneTime zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tabfalsetrue (ByPropertyName)
-TtySpecify the number of tty available to the containerfalsetrue (ByPropertyName)0
-UniqueAssign a unique random ethernet address.falsetrue (ByPropertyName)False
-UnprivilegedMakes the container run as unprivileged user. (Should not be modified manually.)falsetrue (ByPropertyName)False
-UnusedNReference to unused volumes. This is used internally, and should not be modified manually.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Copy-PveLxc
  • +
+
+
+
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-BwlimitOverride I/O bandwidth limit (in KiB/s).falsetrue (ByPropertyName)0
-DescriptionDescription for the new CT.falsetrue (ByPropertyName)
-FullCreate 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.falsetrue (ByPropertyName)False
-HostnameSet a hostname for the new CT.falsetrue (ByPropertyName)
-NewidVMID for the clone.truetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-PoolAdd the new CT to the specified pool.falsetrue (ByPropertyName)
-SnapnameThe name of the snapshot.falsetrue (ByPropertyName)
-StorageTarget storage for full clone.falsetrue (ByPropertyName)
-TargetTarget node. Only allowed if the original VM is on shared storage.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-NameAlias name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NameIP set name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-RenameRename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesLxcFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-NameIP set name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-Nomatch--falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [-Action] <String> [[-Comment] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [-Type] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ActionRule action ('ACCEPT', 'DROP', 'REJECT') or security group name.truetrue (ByPropertyName)
-CommentDescriptive comment.falsetrue (ByPropertyName)
-DestRestrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DportRestrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-EnableFlag to enable/disable a rule.falsetrue (ByPropertyName)0
-IcmpTypeSpecify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.falsetrue (ByPropertyName)
-IfaceNetwork interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.falsetrue (ByPropertyName)
-LogLog level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-MacroUse predefined standard macro.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
-ProtoIP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.falsetrue (ByPropertyName)
-SourceRestrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-SportRestrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-TypeRule type. Enum: in,out,grouptruetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Move-PveLxc
  • +
+
+
+
+

Syntax

+
+
+
+ New-PveNodesLxcMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [-Node] <String> [-Online] [-Restart] [-Target] <String> [[-TargetStorage] <String>] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-BwlimitOverride I/O bandwidth limit (in KiB/s).falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-OnlineUse online/live migration.falsetrue (ByPropertyName)False
-RestartUse restart migrationfalsetrue (ByPropertyName)False
-TargetTarget node.truetrue (ByPropertyName)
-TargetStorageMapping 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.falsetrue (ByPropertyName)
-TimeoutTimeout in seconds for shutdown for restart migrationfalsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesLxcMoveVolume [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [-Delete] [[-Digest] <String>] [-Node] <String> [[-Storage] <String>] [[-TargetDigest] <String>] [[-TargetVmid] <Int32>] [[-TargetVolume] <String>] [-Vmid] <Int32> [-Volume] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-BwlimitOverride I/O bandwidth limit (in KiB/s).falsetrue (ByPropertyName)0
-DeleteDelete the original volume after successful copy. By default the original is kept as an unused volume entry.falsetrue (ByPropertyName)False
-DigestPrevent changes if current configuration file has different SHA1 " . "digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-StorageTarget Storage.falsetrue (ByPropertyName)
-TargetDigestPrevent changes if current configuration file of the target " . "container has a different SHA1 digest. This can be used to prevent " . "concurrent modifications.falsetrue (ByPropertyName)
-TargetVmidThe (unique) ID of the VM.falsetrue (ByPropertyName)0
-TargetVolumeThe config key the volume will be moved to. Default is the source volume key. Enum: rootfs,mp0,mp1,mp2,mp3,mp4,mp5,mp6,mp7,mp8,mp9,mp10,mp11,mp12,mp13,mp14,mp15,mp16,mp17,mp18,mp19,mp20,mp21,mp22,mp23,mp24,mp25,mp26,mp27,mp28,mp29,mp30,mp31,mp32,mp33,mp34,mp35,mp36,mp37,mp38,mp39,mp40,mp41,mp42,mp43,mp44,mp45,mp46,mp47,mp48,mp49,mp50,mp51,mp52,mp53,mp54,mp55,mp56,mp57,mp58,mp59,mp60,mp61,mp62,mp63,mp64,mp65,mp66,mp67,mp68,mp69,mp70,mp71,mp72,mp73,mp74,mp75,mp76,mp77,mp78,mp79,mp80,mp81,mp82,mp83,mp84,mp85,mp86,mp87,mp88,mp89,mp90,mp91,mp92,mp93,mp94,mp95,mp96,mp97,mp98,mp99,mp100,mp101,mp102,mp103,mp104,mp105,mp106,mp107,mp108,mp109,mp110,mp111,mp112,mp113,mp114,mp115,mp116,mp117,mp118,mp119,mp120,mp121,mp122,mp123,mp124,mp125,mp126,mp127,mp128,mp129,mp130,mp131,mp132,mp133,mp134,mp135,mp136,mp137,mp138,mp139,mp140,mp141,mp142,mp143,mp144,mp145,mp146,mp147,mp148,mp149,mp150,mp151,mp152,mp153,mp154,mp155,mp156,mp157,mp158,mp159,mp160,mp161,mp162,mp163,mp164,mp165,mp166,mp167,mp168,mp169,mp170,mp171,mp172,mp173,mp174,mp175,mp176,mp177,mp178,mp179,mp180,mp181,mp182,mp183,mp184,mp185,mp186,mp187,mp188,mp189,mp190,mp191,mp192,mp193,mp194,mp195,mp196,mp197,mp198,mp199,mp200,mp201,mp202,mp203,mp204,mp205,mp206,mp207,mp208,mp209,mp210,mp211,mp212,mp213,mp214,mp215,mp216,mp217,mp218,mp219,mp220,mp221,mp222,mp223,mp224,mp225,mp226,mp227,mp228,mp229,mp230,mp231,mp232,mp233,mp234,mp235,mp236,mp237,mp238,mp239,mp240,mp241,mp242,mp243,mp244,mp245,mp246,mp247,mp248,mp249,mp250,mp251,mp252,mp253,mp254,mp255,unused0,unused1,unused2,unused3,unused4,unused5,unused6,unused7,unused8,unused9,unused10,unused11,unused12,unused13,unused14,unused15,unused16,unused17,unused18,unused19,unused20,unused21,unused22,unused23,unused24,unused25,unused26,unused27,unused28,unused29,unused30,unused31,unused32,unused33,unused34,unused35,unused36,unused37,unused38,unused39,unused40,unused41,unused42,unused43,unused44,unused45,unused46,unused47,unused48,unused49,unused50,unused51,unused52,unused53,unused54,unused55,unused56,unused57,unused58,unused59,unused60,unused61,unused62,unused63,unused64,unused65,unused66,unused67,unused68,unused69,unused70,unused71,unused72,unused73,unused74,unused75,unused76,unused77,unused78,unused79,unused80,unused81,unused82,unused83,unused84,unused85,unused86,unused87,unused88,unused89,unused90,unused91,unused92,unused93,unused94,unused95,unused96,unused97,unused98,unused99,unused100,unused101,unused102,unused103,unused104,unused105,unused106,unused107,unused108,unused109,unused110,unused111,unused112,unused113,unused114,unused115,unused116,unused117,unused118,unused119,unused120,unused121,unused122,unused123,unused124,unused125,unused126,unused127,unused128,unused129,unused130,unused131,unused132,unused133,unused134,unused135,unused136,unused137,unused138,unused139,unused140,unused141,unused142,unused143,unused144,unused145,unused146,unused147,unused148,unused149,unused150,unused151,unused152,unused153,unused154,unused155,unused156,unused157,unused158,unused159,unused160,unused161,unused162,unused163,unused164,unused165,unused166,unused167,unused168,unused169,unused170,unused171,unused172,unused173,unused174,unused175,unused176,unused177,unused178,unused179,unused180,unused181,unused182,unused183,unused184,unused185,unused186,unused187,unused188,unused189,unused190,unused191,unused192,unused193,unused194,unused195,unused196,unused197,unused198,unused199,unused200,unused201,unused202,unused203,unused204,unused205,unused206,unused207,unused208,unused209,unused210,unused211,unused212,unused213,unused214,unused215,unused216,unused217,unused218,unused219,unused220,unused221,unused222,unused223,unused224,unused225,unused226,unused227,unused228,unused229,unused230,unused231,unused232,unused233,unused234,unused235,unused236,unused237,unused238,unused239,unused240,unused241,unused242,unused243,unused244,unused245,unused246,unused247,unused248,unused249,unused250,unused251,unused252,unused253,unused254,unused255falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-VolumeVolume which will be moved. Enum: rootfs,mp0,mp1,mp2,mp3,mp4,mp5,mp6,mp7,mp8,mp9,mp10,mp11,mp12,mp13,mp14,mp15,mp16,mp17,mp18,mp19,mp20,mp21,mp22,mp23,mp24,mp25,mp26,mp27,mp28,mp29,mp30,mp31,mp32,mp33,mp34,mp35,mp36,mp37,mp38,mp39,mp40,mp41,mp42,mp43,mp44,mp45,mp46,mp47,mp48,mp49,mp50,mp51,mp52,mp53,mp54,mp55,mp56,mp57,mp58,mp59,mp60,mp61,mp62,mp63,mp64,mp65,mp66,mp67,mp68,mp69,mp70,mp71,mp72,mp73,mp74,mp75,mp76,mp77,mp78,mp79,mp80,mp81,mp82,mp83,mp84,mp85,mp86,mp87,mp88,mp89,mp90,mp91,mp92,mp93,mp94,mp95,mp96,mp97,mp98,mp99,mp100,mp101,mp102,mp103,mp104,mp105,mp106,mp107,mp108,mp109,mp110,mp111,mp112,mp113,mp114,mp115,mp116,mp117,mp118,mp119,mp120,mp121,mp122,mp123,mp124,mp125,mp126,mp127,mp128,mp129,mp130,mp131,mp132,mp133,mp134,mp135,mp136,mp137,mp138,mp139,mp140,mp141,mp142,mp143,mp144,mp145,mp146,mp147,mp148,mp149,mp150,mp151,mp152,mp153,mp154,mp155,mp156,mp157,mp158,mp159,mp160,mp161,mp162,mp163,mp164,mp165,mp166,mp167,mp168,mp169,mp170,mp171,mp172,mp173,mp174,mp175,mp176,mp177,mp178,mp179,mp180,mp181,mp182,mp183,mp184,mp185,mp186,mp187,mp188,mp189,mp190,mp191,mp192,mp193,mp194,mp195,mp196,mp197,mp198,mp199,mp200,mp201,mp202,mp203,mp204,mp205,mp206,mp207,mp208,mp209,mp210,mp211,mp212,mp213,mp214,mp215,mp216,mp217,mp218,mp219,mp220,mp221,mp222,mp223,mp224,mp225,mp226,mp227,mp228,mp229,mp230,mp231,mp232,mp233,mp234,mp235,mp236,mp237,mp238,mp239,mp240,mp241,mp242,mp243,mp244,mp245,mp246,mp247,mp248,mp249,mp250,mp251,mp252,mp253,mp254,mp255,unused0,unused1,unused2,unused3,unused4,unused5,unused6,unused7,unused8,unused9,unused10,unused11,unused12,unused13,unused14,unused15,unused16,unused17,unused18,unused19,unused20,unused21,unused22,unused23,unused24,unused25,unused26,unused27,unused28,unused29,unused30,unused31,unused32,unused33,unused34,unused35,unused36,unused37,unused38,unused39,unused40,unused41,unused42,unused43,unused44,unused45,unused46,unused47,unused48,unused49,unused50,unused51,unused52,unused53,unused54,unused55,unused56,unused57,unused58,unused59,unused60,unused61,unused62,unused63,unused64,unused65,unused66,unused67,unused68,unused69,unused70,unused71,unused72,unused73,unused74,unused75,unused76,unused77,unused78,unused79,unused80,unused81,unused82,unused83,unused84,unused85,unused86,unused87,unused88,unused89,unused90,unused91,unused92,unused93,unused94,unused95,unused96,unused97,unused98,unused99,unused100,unused101,unused102,unused103,unused104,unused105,unused106,unused107,unused108,unused109,unused110,unused111,unused112,unused113,unused114,unused115,unused116,unused117,unused118,unused119,unused120,unused121,unused122,unused123,unused124,unused125,unused126,unused127,unused128,unused129,unused130,unused131,unused132,unused133,unused134,unused135,unused136,unused137,unused138,unused139,unused140,unused141,unused142,unused143,unused144,unused145,unused146,unused147,unused148,unused149,unused150,unused151,unused152,unused153,unused154,unused155,unused156,unused157,unused158,unused159,unused160,unused161,unused162,unused163,unused164,unused165,unused166,unused167,unused168,unused169,unused170,unused171,unused172,unused173,unused174,unused175,unused176,unused177,unused178,unused179,unused180,unused181,unused182,unused183,unused184,unused185,unused186,unused187,unused188,unused189,unused190,unused191,unused192,unused193,unused194,unused195,unused196,unused197,unused198,unused199,unused200,unused201,unused202,unused203,unused204,unused205,unused206,unused207,unused208,unused209,unused210,unused211,unused212,unused213,unused214,unused215,unused216,unused217,unused218,unused219,unused220,unused221,unused222,unused223,unused224,unused225,unused226,unused227,unused228,unused229,unused230,unused231,unused232,unused233,unused234,unused235,unused236,unused237,unused238,unused239,unused240,unused241,unused242,unused243,unused244,unused245,unused246,unused247,unused248,unused249,unused250,unused251,unused252,unused253,unused254,unused255truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesLxcMtunnel [[-PveTicket] <PveTicket>] [[-Bridges] <String>] [-Node] <String> [[-Storages] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-BridgesList of network bridges to check availability. Will be checked again for actually used bridges during migration.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-StoragesList of storages to check permission and availability. Will be checked again for all actually used storages during migration.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesLxcRemoteMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [-Delete] [-Node] <String> [-Online] [-Restart] [-TargetBridge] <String> [-TargetEndpoint] <String> [-TargetStorage] <String> [[-TargetVmid] <Int32>] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-BwlimitOverride I/O bandwidth limit (in KiB/s).falsetrue (ByPropertyName)0
-DeleteDelete the original CT and related data after successful migration. By default the original CT is kept on the source cluster in a stopped state.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-OnlineUse online/live migration.falsetrue (ByPropertyName)False
-RestartUse restart migrationfalsetrue (ByPropertyName)False
-TargetBridgeMapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself.truetrue (ByPropertyName)
-TargetEndpointRemote target endpointtruetrue (ByPropertyName)
-TargetStorageMapping 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.truetrue (ByPropertyName)
-TargetVmidThe (unique) ID of the VM.falsetrue (ByPropertyName)0
-TimeoutTimeout in seconds for shutdown for restart migrationfalsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DescriptionA textual description or comment.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesLxcSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-StartWhether the container should get started after rolling back successfullyfalsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesLxcSpiceproxy [[-PveTicket] <PveTicket>] [-Node] <String> [[-Proxy] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ProxySPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Restart-PveLxc
  • +
+
+
+
+

Syntax

+
+
+
+ New-PveNodesLxcStatusReboot [[-PveTicket] <PveTicket>] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-TimeoutWait maximal timeout seconds for the shutdown.falsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Resume-PveLxc
  • +
+
+
+
+

Syntax

+
+
+
+ New-PveNodesLxcStatusResume [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesLxcStatusShutdown [[-PveTicket] <PveTicket>] [-Forcestop] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ForcestopMake sure the Container stops.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-TimeoutWait maximal timeout seconds.falsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Start-PveLxc
  • +
+
+
+
+

Syntax

+
+
+
+ New-PveNodesLxcStatusStart [[-PveTicket] <PveTicket>] [-Debug_] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Debug_If set, enables very verbose debug log-level on start.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-SkiplockIgnore locks - only root is allowed to use this option.falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Stop-PveLxc
  • +
+
+
+
+

Syntax

+
+
+
+ New-PveNodesLxcStatusStop [[-PveTicket] <PveTicket>] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SkiplockIgnore locks - only root is allowed to use this option.falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Suspend-PveLxc
  • +
+
+
+
+

Syntax

+
+
+
+ New-PveNodesLxcStatusSuspend [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesLxcTemplate [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesLxcTermproxy [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesLxcVncproxy [[-PveTicket] <PveTicket>] [[-Height] <Int32>] [-Node] <String> [-Vmid] <Int32> [-Websocket] [[-Width] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Heightsets the height of the console in pixels.falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-Websocketuse websocket instead of standard VNC.falsetrue (ByPropertyName)False
-Widthsets the width of the console in pixels.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesMigrateall [[-PveTicket] <PveTicket>] [[-Maxworkers] <Int32>] [-Node] <String> [-Target] <String> [[-Vms] <String>] [-WithLocalDisks] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-MaxworkersMaximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg. One of both must be set!falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-TargetTarget node.truetrue (ByPropertyName)
-VmsOnly consider Guests with these IDs.falsetrue (ByPropertyName)
-WithLocalDisksEnable live storage migration for local diskfalsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesNetwork [[-PveTicket] <PveTicket>] [[-Address] <String>] [[-Address6] <String>] [-Autostart] [[-BondPrimary] <String>] [[-BondMode] <String>] [[-BondXmitHashPolicy] <String>] [[-BridgePorts] <String>] [-BridgeVlanAware] [[-Cidr] <String>] [[-Cidr6] <String>] [[-Comments] <String>] [[-Comments6] <String>] [[-Gateway] <String>] [[-Gateway6] <String>] [-Iface] <String> [[-Mtu] <Int32>] [[-Netmask] <String>] [[-Netmask6] <Int32>] [-Node] <String> [[-OvsBonds] <String>] [[-OvsBridge] <String>] [[-OvsOptions] <String>] [[-OvsPorts] <String>] [[-OvsTag] <Int32>] [[-Slaves] <String>] [-Type] <String> [[-VlanId] <Int32>] [[-VlanRawDevice] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AddressIP address.falsetrue (ByPropertyName)
-Address6IP address.falsetrue (ByPropertyName)
-AutostartAutomatically start interface on boot.falsetrue (ByPropertyName)False
-BondPrimarySpecify the primary interface for active-backup bond.falsetrue (ByPropertyName)
-BondModeBonding mode. Enum: balance-rr,active-backup,balance-xor,broadcast,802.3ad,balance-tlb,balance-alb,balance-slb,lacp-balance-slb,lacp-balance-tcpfalsetrue (ByPropertyName)
-BondXmitHashPolicySelects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. Enum: layer2,layer2+3,layer3+4falsetrue (ByPropertyName)
-BridgePortsSpecify the interfaces you want to add to your bridge.falsetrue (ByPropertyName)
-BridgeVlanAwareEnable bridge vlan support.falsetrue (ByPropertyName)False
-CidrIPv4 CIDR.falsetrue (ByPropertyName)
-Cidr6IPv6 CIDR.falsetrue (ByPropertyName)
-CommentsCommentsfalsetrue (ByPropertyName)
-Comments6Commentsfalsetrue (ByPropertyName)
-GatewayDefault gateway address.falsetrue (ByPropertyName)
-Gateway6Default ipv6 gateway address.falsetrue (ByPropertyName)
-IfaceNetwork interface name.truetrue (ByPropertyName)
-MtuMTU.falsetrue (ByPropertyName)0
-NetmaskNetwork mask.falsetrue (ByPropertyName)
-Netmask6Network mask.falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-OvsBondsSpecify the interfaces used by the bonding device.falsetrue (ByPropertyName)
-OvsBridgeThe OVS bridge associated with a OVS port. This is required when you create an OVS port.falsetrue (ByPropertyName)
-OvsOptionsOVS interface options.falsetrue (ByPropertyName)
-OvsPortsSpecify the interfaces you want to add to your bridge.falsetrue (ByPropertyName)
-OvsTagSpecify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)falsetrue (ByPropertyName)0
-SlavesSpecify the interfaces used by the bonding device.falsetrue (ByPropertyName)
-TypeNetwork interface type Enum: bridge,bond,eth,alias,vlan,OVSBridge,OVSBond,OVSPort,OVSIntPort,unknowntruetrue (ByPropertyName)
-VlanIdvlan-id for a custom named vlan interface (ifupdown2 only).falsetrue (ByPropertyName)0
-VlanRawDeviceSpecify the raw interface for the vlan interface.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • New-PveQemu
  • +
+
+
+
+

Syntax

+
+
+
+ New-PveNodesQemu [[-PveTicket] <PveTicket>] [-Acpi] [[-Affinity] <String>] [[-Agent] <String>] [[-Arch] <String>] [[-Archive] <String>] [[-Args_] <String>] [[-Audio0] <String>] [-Autostart] [[-Balloon] <Int32>] [[-Bios] <String>] [[-Boot] <String>] [[-Bootdisk] <String>] [[-Bwlimit] <Int32>] [[-Cdrom] <String>] [[-Cicustom] <String>] [[-Cipassword] <SecureString>] [[-Citype] <String>] [-Ciupgrade] [[-Ciuser] <String>] [[-Cores] <Int32>] [[-Cpu] <String>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [[-Description] <String>] [[-Efidisk0] <String>] [-Force] [-Freeze] [[-Hookscript] <String>] [[-HostpciN] <Hashtable>] [[-Hotplug] <String>] [[-Hugepages] <String>] [[-IdeN] <Hashtable>] [[-IpconfigN] <Hashtable>] [[-Ivshmem] <String>] [-Keephugepages] [[-Keyboard] <String>] [-Kvm] [-LiveRestore] [-Localtime] [[-Lock] <String>] [[-Machine] <String>] [[-Memory] <String>] [[-MigrateDowntime] <Single>] [[-MigrateSpeed] <Int32>] [[-Name] <String>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Numa] [[-NumaN] <Hashtable>] [-Onboot] [[-Ostype] <String>] [[-ParallelN] <Hashtable>] [[-Pool] <String>] [-Protection] [-Reboot] [[-Rng0] <String>] [[-SataN] <Hashtable>] [[-ScsiN] <Hashtable>] [[-Scsihw] <String>] [[-Searchdomain] <String>] [[-SerialN] <Hashtable>] [[-Shares] <Int32>] [[-Smbios1] <String>] [[-Smp] <Int32>] [[-Sockets] <Int32>] [[-SpiceEnhancements] <String>] [[-Sshkeys] <String>] [-Start] [[-Startdate] <String>] [[-Startup] <String>] [[-Storage] <String>] [-Tablet] [[-Tags] <String>] [-Tdf] [-Template] [[-Tpmstate0] <String>] [-Unique] [[-UnusedN] <Hashtable>] [[-UsbN] <Hashtable>] [[-Vcpus] <Int32>] [[-Vga] <String>] [[-VirtioN] <Hashtable>] [[-Vmgenid] <String>] [-Vmid] <Int32> [[-Vmstatestorage] <String>] [[-Watchdog] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AcpiEnable/disable ACPI.falsetrue (ByPropertyName)False
-AffinityList of host cores used to execute guest processes, for example':' 0,5,8-11falsetrue (ByPropertyName)
-AgentEnable/disable communication with the QEMU Guest Agent and its properties.falsetrue (ByPropertyName)
-ArchVirtual processor architecture. Defaults to the host. Enum: x86_64,aarch64falsetrue (ByPropertyName)
-ArchiveThe backup archive. Either the file system path to a .tar or .vma file (use '-' to pipe data from stdin) or a proxmox storage backup volume identifier.falsetrue (ByPropertyName)
-Args_Arbitrary arguments passed to kvm.falsetrue (ByPropertyName)
-Audio0Configure a audio device, useful in combination with QXL/Spice.falsetrue (ByPropertyName)
-AutostartAutomatic restart after crash (currently ignored).falsetrue (ByPropertyName)False
-BalloonAmount of target RAM for the VM in MiB. Using zero disables the ballon driver.falsetrue (ByPropertyName)0
-BiosSelect BIOS implementation. Enum: seabios,ovmffalsetrue (ByPropertyName)
-BootSpecify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.falsetrue (ByPropertyName)
-BootdiskEnable booting from specified disk. Deprecated':' Use 'boot':' order=foo;bar' instead.falsetrue (ByPropertyName)
-BwlimitOverride I/O bandwidth limit (in KiB/s).falsetrue (ByPropertyName)0
-CdromThis is an alias for option -ide2falsetrue (ByPropertyName)
-Cicustomcloud-init':' Specify custom files to replace the automatically generated ones at start.falsetrue (ByPropertyName)
-Cipasswordcloud-init':' Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.falsetrue (ByPropertyName)
-CitypeSpecifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. Enum: configdrive2,nocloud,opennebulafalsetrue (ByPropertyName)
-Ciupgradecloud-init':' do an automatic package upgrade after the first boot.falsetrue (ByPropertyName)False
-Ciusercloud-init':' User name to change ssh keys and password for instead of the image's configured default user.falsetrue (ByPropertyName)
-CoresThe number of cores per socket.falsetrue (ByPropertyName)0
-CpuEmulated CPU type.falsetrue (ByPropertyName)
-CpulimitLimit of CPU usage.falsetrue (ByPropertyName)0
-CpuunitsCPU weight for a VM, will be clamped to \[1, 10000] in cgroup v2.falsetrue (ByPropertyName)0
-DescriptionDescription for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.falsetrue (ByPropertyName)
-Efidisk0Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-ForceAllow to overwrite existing VM.falsetrue (ByPropertyName)False
-FreezeFreeze CPU at startup (use 'c' monitor command to start execution).falsetrue (ByPropertyName)False
-HookscriptScript that will be executed during various steps in the vms lifetime.falsetrue (ByPropertyName)
-HostpciNMap host PCI devices into guest.falsetrue (ByPropertyName)
-HotplugSelectively enable hotplug features. This is a comma separated list of hotplug features':' 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.falsetrue (ByPropertyName)
-HugepagesEnable/disable hugepages memory. Enum: any,2,1024falsetrue (ByPropertyName)
-IdeNUse volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-IpconfigNcloud-init':' Specify IP addresses and gateways for the corresponding interface.IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicitgateway should be provided.For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requirescloud-init 19.4 or newer.If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to usingdhcp on IPv4.falsetrue (ByPropertyName)
-IvshmemInter-VM shared memory. Useful for direct communication between VMs, or to the host.falsetrue (ByPropertyName)
-KeephugepagesUse together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.falsetrue (ByPropertyName)False
-KeyboardKeyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. Enum: de,de-ch,da,en-gb,en-us,es,fi,fr,fr-be,fr-ca,fr-ch,hu,is,it,ja,lt,mk,nl,no,pl,pt,pt-br,sv,sl,trfalsetrue (ByPropertyName)
-KvmEnable/disable KVM hardware virtualization.falsetrue (ByPropertyName)False
-LiveRestoreStart the VM immediately from the backup and restore in background. PBS only.falsetrue (ByPropertyName)False
-LocaltimeSet the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.falsetrue (ByPropertyName)False
-LockLock/unlock the VM. Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspendedfalsetrue (ByPropertyName)
-MachineSpecifies the QEMU machine type.falsetrue (ByPropertyName)
-MemoryMemory properties.falsetrue (ByPropertyName)
-MigrateDowntimeSet maximum tolerated downtime (in seconds) for migrations.falsetrue (ByPropertyName)0
-MigrateSpeedSet maximum speed (in MB/s) for migrations. Value 0 is no limit.falsetrue (ByPropertyName)0
-NameSet a name for the VM. Only used on the configuration web interface.falsetrue (ByPropertyName)
-Nameservercloud-init':' Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.falsetrue (ByPropertyName)
-NetNSpecify network devices.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-NumaEnable/disable NUMA.falsetrue (ByPropertyName)False
-NumaNNUMA topology.falsetrue (ByPropertyName)
-OnbootSpecifies whether a VM will be started during system bootup.falsetrue (ByPropertyName)False
-OstypeSpecify guest operating system. Enum: other,wxp,w2k,w2k3,w2k8,wvista,win7,win8,win10,win11,l24,l26,solarisfalsetrue (ByPropertyName)
-ParallelNMap host parallel devices (n is 0 to 2).falsetrue (ByPropertyName)
-PoolAdd the VM to the specified pool.falsetrue (ByPropertyName)
-ProtectionSets the protection flag of the VM. This will disable the remove VM and remove disk operations.falsetrue (ByPropertyName)False
-RebootAllow reboot. If set to '0' the VM exit on reboot.falsetrue (ByPropertyName)False
-Rng0Configure a VirtIO-based Random Number Generator.falsetrue (ByPropertyName)
-SataNUse volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-ScsiNUse volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-ScsihwSCSI controller model Enum: lsi,lsi53c810,virtio-scsi-pci,virtio-scsi-single,megasas,pvscsifalsetrue (ByPropertyName)
-Searchdomaincloud-init':' Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.falsetrue (ByPropertyName)
-SerialNCreate a serial device inside the VM (n is 0 to 3)falsetrue (ByPropertyName)
-SharesAmount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.falsetrue (ByPropertyName)0
-Smbios1Specify SMBIOS type 1 fields.falsetrue (ByPropertyName)
-SmpThe number of CPUs. Please use option -sockets instead.falsetrue (ByPropertyName)0
-SocketsThe number of CPU sockets.falsetrue (ByPropertyName)0
-SpiceEnhancementsConfigure additional enhancements for SPICE.falsetrue (ByPropertyName)
-Sshkeyscloud-init':' Setup public SSH keys (one key per line, OpenSSH format).falsetrue (ByPropertyName)
-StartStart VM after it was created successfully.falsetrue (ByPropertyName)False
-StartdateSet the initial date of the real time clock. Valid format for date are':''now' or '2006-06-17T16':'01':'21' or '2006-06-17'.falsetrue (ByPropertyName)
-StartupStartup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.falsetrue (ByPropertyName)
-StorageDefault storage.falsetrue (ByPropertyName)
-TabletEnable/disable the USB tablet device.falsetrue (ByPropertyName)False
-TagsTags of the VM. This is only meta information.falsetrue (ByPropertyName)
-TdfEnable/disable time drift fix.falsetrue (ByPropertyName)False
-TemplateEnable/disable Template.falsetrue (ByPropertyName)False
-Tpmstate0Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-UniqueAssign a unique random ethernet address.falsetrue (ByPropertyName)False
-UnusedNReference to unused volumes. This is used internally, and should not be modified manually.falsetrue (ByPropertyName)
-UsbNConfigure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14).falsetrue (ByPropertyName)
-VcpusNumber of hotplugged vcpus.falsetrue (ByPropertyName)0
-VgaConfigure the VGA hardware.falsetrue (ByPropertyName)
-VirtioNUse volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-VmgenidSet VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-VmstatestorageDefault storage for VM state volumes/files.falsetrue (ByPropertyName)
-WatchdogCreate a virtual hardware watchdog device.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuAgent [[-PveTicket] <PveTicket>] [-Command] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CommandThe QGA command. Enum: fsfreeze-freeze,fsfreeze-status,fsfreeze-thaw,fstrim,get-fsinfo,get-host-name,get-memory-block-info,get-memory-blocks,get-osinfo,get-time,get-timezone,get-users,get-vcpus,info,network-get-interfaces,ping,shutdown,suspend-disk,suspend-hybrid,suspend-ramtruetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuAgentExec [[-PveTicket] <PveTicket>] [-Command] <Array> [[-InputData] <String>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CommandThe command as a list of program + arguments.truetrue (ByPropertyName)
-InputDataData to pass as 'input-data' to the guest. Usually treated as STDIN to 'command'.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuAgentFileWrite [[-PveTicket] <PveTicket>] [-Content] <String> [-Encode] [-File] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ContentThe content to write into the file.truetrue (ByPropertyName)
-EncodeIf set, the content will be encoded as base64 (required by QEMU).Otherwise the content needs to be encoded beforehand - defaults to true.falsetrue (ByPropertyName)False
-FileThe path to the file.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuAgentFsfreezeFreeze [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuAgentFsfreezeStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuAgentFsfreezeThaw [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuAgentFstrim [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuAgentPing [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuAgentSetUserPassword [[-PveTicket] <PveTicket>] [-Crypted] [-Node] <String> [-Password] <SecureString> [-Username] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Cryptedset to 1 if the password has already been passed through crypt()falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-PasswordThe new password.truetrue (ByPropertyName)
-UsernameThe user to set the password for.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuAgentShutdown [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuAgentSuspendDisk [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuAgentSuspendHybrid [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuAgentSuspendRam [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Copy-PveQemu
  • +
+
+
+
+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-BwlimitOverride I/O bandwidth limit (in KiB/s).falsetrue (ByPropertyName)0
-DescriptionDescription for the new VM.falsetrue (ByPropertyName)
-FormatTarget format for file storage. Only valid for full clone. Enum: raw,qcow2,vmdkfalsetrue (ByPropertyName)
-FullCreate 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.falsetrue (ByPropertyName)False
-NameSet a name for the new VM.falsetrue (ByPropertyName)
-NewidVMID for the clone.truetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-PoolAdd the new VM to the specified pool.falsetrue (ByPropertyName)
-SnapnameThe name of the snapshot.falsetrue (ByPropertyName)
-StorageTarget storage for full clone.falsetrue (ByPropertyName)
-TargetTarget node. Only allowed if the original VM is on shared storage.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuConfig [[-PveTicket] <PveTicket>] [-Acpi] [[-Affinity] <String>] [[-Agent] <String>] [[-Arch] <String>] [[-Args_] <String>] [[-Audio0] <String>] [-Autostart] [[-BackgroundDelay] <Int32>] [[-Balloon] <Int32>] [[-Bios] <String>] [[-Boot] <String>] [[-Bootdisk] <String>] [[-Cdrom] <String>] [[-Cicustom] <String>] [[-Cipassword] <SecureString>] [[-Citype] <String>] [-Ciupgrade] [[-Ciuser] <String>] [[-Cores] <Int32>] [[-Cpu] <String>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [[-Efidisk0] <String>] [-Force] [-Freeze] [[-Hookscript] <String>] [[-HostpciN] <Hashtable>] [[-Hotplug] <String>] [[-Hugepages] <String>] [[-IdeN] <Hashtable>] [[-IpconfigN] <Hashtable>] [[-Ivshmem] <String>] [-Keephugepages] [[-Keyboard] <String>] [-Kvm] [-Localtime] [[-Lock] <String>] [[-Machine] <String>] [[-Memory] <String>] [[-MigrateDowntime] <Single>] [[-MigrateSpeed] <Int32>] [[-Name] <String>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Numa] [[-NumaN] <Hashtable>] [-Onboot] [[-Ostype] <String>] [[-ParallelN] <Hashtable>] [-Protection] [-Reboot] [[-Revert] <String>] [[-Rng0] <String>] [[-SataN] <Hashtable>] [[-ScsiN] <Hashtable>] [[-Scsihw] <String>] [[-Searchdomain] <String>] [[-SerialN] <Hashtable>] [[-Shares] <Int32>] [-Skiplock] [[-Smbios1] <String>] [[-Smp] <Int32>] [[-Sockets] <Int32>] [[-SpiceEnhancements] <String>] [[-Sshkeys] <String>] [[-Startdate] <String>] [[-Startup] <String>] [-Tablet] [[-Tags] <String>] [-Tdf] [-Template] [[-Tpmstate0] <String>] [[-UnusedN] <Hashtable>] [[-UsbN] <Hashtable>] [[-Vcpus] <Int32>] [[-Vga] <String>] [[-VirtioN] <Hashtable>] [[-Vmgenid] <String>] [-Vmid] <Int32> [[-Vmstatestorage] <String>] [[-Watchdog] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AcpiEnable/disable ACPI.falsetrue (ByPropertyName)False
-AffinityList of host cores used to execute guest processes, for example':' 0,5,8-11falsetrue (ByPropertyName)
-AgentEnable/disable communication with the QEMU Guest Agent and its properties.falsetrue (ByPropertyName)
-ArchVirtual processor architecture. Defaults to the host. Enum: x86_64,aarch64falsetrue (ByPropertyName)
-Args_Arbitrary arguments passed to kvm.falsetrue (ByPropertyName)
-Audio0Configure a audio device, useful in combination with QXL/Spice.falsetrue (ByPropertyName)
-AutostartAutomatic restart after crash (currently ignored).falsetrue (ByPropertyName)False
-BackgroundDelayTime to wait for the task to finish. We return 'null' if the task finish within that time.falsetrue (ByPropertyName)0
-BalloonAmount of target RAM for the VM in MiB. Using zero disables the ballon driver.falsetrue (ByPropertyName)0
-BiosSelect BIOS implementation. Enum: seabios,ovmffalsetrue (ByPropertyName)
-BootSpecify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.falsetrue (ByPropertyName)
-BootdiskEnable booting from specified disk. Deprecated':' Use 'boot':' order=foo;bar' instead.falsetrue (ByPropertyName)
-CdromThis is an alias for option -ide2falsetrue (ByPropertyName)
-Cicustomcloud-init':' Specify custom files to replace the automatically generated ones at start.falsetrue (ByPropertyName)
-Cipasswordcloud-init':' Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.falsetrue (ByPropertyName)
-CitypeSpecifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. Enum: configdrive2,nocloud,opennebulafalsetrue (ByPropertyName)
-Ciupgradecloud-init':' do an automatic package upgrade after the first boot.falsetrue (ByPropertyName)False
-Ciusercloud-init':' User name to change ssh keys and password for instead of the image's configured default user.falsetrue (ByPropertyName)
-CoresThe number of cores per socket.falsetrue (ByPropertyName)0
-CpuEmulated CPU type.falsetrue (ByPropertyName)
-CpulimitLimit of CPU usage.falsetrue (ByPropertyName)0
-CpuunitsCPU weight for a VM, will be clamped to \[1, 10000] in cgroup v2.falsetrue (ByPropertyName)0
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DescriptionDescription for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-Efidisk0Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-ForceForce physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused\[n]', which contains the volume ID. Unlink of unused\[n] always cause physical removal.falsetrue (ByPropertyName)False
-FreezeFreeze CPU at startup (use 'c' monitor command to start execution).falsetrue (ByPropertyName)False
-HookscriptScript that will be executed during various steps in the vms lifetime.falsetrue (ByPropertyName)
-HostpciNMap host PCI devices into guest.falsetrue (ByPropertyName)
-HotplugSelectively enable hotplug features. This is a comma separated list of hotplug features':' 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.falsetrue (ByPropertyName)
-HugepagesEnable/disable hugepages memory. Enum: any,2,1024falsetrue (ByPropertyName)
-IdeNUse volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-IpconfigNcloud-init':' Specify IP addresses and gateways for the corresponding interface.IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicitgateway should be provided.For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requirescloud-init 19.4 or newer.If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to usingdhcp on IPv4.falsetrue (ByPropertyName)
-IvshmemInter-VM shared memory. Useful for direct communication between VMs, or to the host.falsetrue (ByPropertyName)
-KeephugepagesUse together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.falsetrue (ByPropertyName)False
-KeyboardKeyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. Enum: de,de-ch,da,en-gb,en-us,es,fi,fr,fr-be,fr-ca,fr-ch,hu,is,it,ja,lt,mk,nl,no,pl,pt,pt-br,sv,sl,trfalsetrue (ByPropertyName)
-KvmEnable/disable KVM hardware virtualization.falsetrue (ByPropertyName)False
-LocaltimeSet the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.falsetrue (ByPropertyName)False
-LockLock/unlock the VM. Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspendedfalsetrue (ByPropertyName)
-MachineSpecifies the QEMU machine type.falsetrue (ByPropertyName)
-MemoryMemory properties.falsetrue (ByPropertyName)
-MigrateDowntimeSet maximum tolerated downtime (in seconds) for migrations.falsetrue (ByPropertyName)0
-MigrateSpeedSet maximum speed (in MB/s) for migrations. Value 0 is no limit.falsetrue (ByPropertyName)0
-NameSet a name for the VM. Only used on the configuration web interface.falsetrue (ByPropertyName)
-Nameservercloud-init':' Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.falsetrue (ByPropertyName)
-NetNSpecify network devices.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-NumaEnable/disable NUMA.falsetrue (ByPropertyName)False
-NumaNNUMA topology.falsetrue (ByPropertyName)
-OnbootSpecifies whether a VM will be started during system bootup.falsetrue (ByPropertyName)False
-OstypeSpecify guest operating system. Enum: other,wxp,w2k,w2k3,w2k8,wvista,win7,win8,win10,win11,l24,l26,solarisfalsetrue (ByPropertyName)
-ParallelNMap host parallel devices (n is 0 to 2).falsetrue (ByPropertyName)
-ProtectionSets the protection flag of the VM. This will disable the remove VM and remove disk operations.falsetrue (ByPropertyName)False
-RebootAllow reboot. If set to '0' the VM exit on reboot.falsetrue (ByPropertyName)False
-RevertRevert a pending change.falsetrue (ByPropertyName)
-Rng0Configure a VirtIO-based Random Number Generator.falsetrue (ByPropertyName)
-SataNUse volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-ScsiNUse volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-ScsihwSCSI controller model Enum: lsi,lsi53c810,virtio-scsi-pci,virtio-scsi-single,megasas,pvscsifalsetrue (ByPropertyName)
-Searchdomaincloud-init':' Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.falsetrue (ByPropertyName)
-SerialNCreate a serial device inside the VM (n is 0 to 3)falsetrue (ByPropertyName)
-SharesAmount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.falsetrue (ByPropertyName)0
-SkiplockIgnore locks - only root is allowed to use this option.falsetrue (ByPropertyName)False
-Smbios1Specify SMBIOS type 1 fields.falsetrue (ByPropertyName)
-SmpThe number of CPUs. Please use option -sockets instead.falsetrue (ByPropertyName)0
-SocketsThe number of CPU sockets.falsetrue (ByPropertyName)0
-SpiceEnhancementsConfigure additional enhancements for SPICE.falsetrue (ByPropertyName)
-Sshkeyscloud-init':' Setup public SSH keys (one key per line, OpenSSH format).falsetrue (ByPropertyName)
-StartdateSet the initial date of the real time clock. Valid format for date are':''now' or '2006-06-17T16':'01':'21' or '2006-06-17'.falsetrue (ByPropertyName)
-StartupStartup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.falsetrue (ByPropertyName)
-TabletEnable/disable the USB tablet device.falsetrue (ByPropertyName)False
-TagsTags of the VM. This is only meta information.falsetrue (ByPropertyName)
-TdfEnable/disable time drift fix.falsetrue (ByPropertyName)False
-TemplateEnable/disable Template.falsetrue (ByPropertyName)False
-Tpmstate0Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-UnusedNReference to unused volumes. This is used internally, and should not be modified manually.falsetrue (ByPropertyName)
-UsbNConfigure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14).falsetrue (ByPropertyName)
-VcpusNumber of hotplugged vcpus.falsetrue (ByPropertyName)0
-VgaConfigure the VGA hardware.falsetrue (ByPropertyName)
-VirtioNUse volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-VmgenidSet VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-VmstatestorageDefault storage for VM state volumes/files.falsetrue (ByPropertyName)
-WatchdogCreate a virtual hardware watchdog device.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-NameAlias name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NameIP set name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-RenameRename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-NameIP set name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-Nomatch--falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [-Action] <String> [[-Comment] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [-Type] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ActionRule action ('ACCEPT', 'DROP', 'REJECT') or security group name.truetrue (ByPropertyName)
-CommentDescriptive comment.falsetrue (ByPropertyName)
-DestRestrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DportRestrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-EnableFlag to enable/disable a rule.falsetrue (ByPropertyName)0
-IcmpTypeSpecify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.falsetrue (ByPropertyName)
-IfaceNetwork interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.falsetrue (ByPropertyName)
-LogLog level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-MacroUse predefined standard macro.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
-ProtoIP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.falsetrue (ByPropertyName)
-SourceRestrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-SportRestrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-TypeRule type. Enum: in,out,grouptruetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Move-PveQemu
  • +
+
+
+
+

Syntax

+
+
+
+ New-PveNodesQemuMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [-Force] [[-MigrationNetwork] <String>] [[-MigrationType] <String>] [-Node] <String> [-Online] [-Target] <String> [[-Targetstorage] <String>] [-Vmid] <Int32> [-WithLocalDisks] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-BwlimitOverride I/O bandwidth limit (in KiB/s).falsetrue (ByPropertyName)0
-ForceAllow to migrate VMs which use local devices. Only root may use this option.falsetrue (ByPropertyName)False
-MigrationNetworkCIDR of the (sub) network that is used for migration.falsetrue (ByPropertyName)
-MigrationTypeMigration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. Enum: secure,insecurefalsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-OnlineUse online/live migration if VM is running. Ignored if VM is stopped.falsetrue (ByPropertyName)False
-TargetTarget node.truetrue (ByPropertyName)
-TargetstorageMapping 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.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-WithLocalDisksEnable live storage migration for local diskfalsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuMonitor [[-PveTicket] <PveTicket>] [-Command] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CommandThe monitor command.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuMoveDisk [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [-Delete] [[-Digest] <String>] [-Disk] <String> [[-Format] <String>] [-Node] <String> [[-Storage] <String>] [[-TargetDigest] <String>] [[-TargetDisk] <String>] [[-TargetVmid] <Int32>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-BwlimitOverride I/O bandwidth limit (in KiB/s).falsetrue (ByPropertyName)0
-DeleteDelete the original disk after successful copy. By default the original disk is kept as unused disk.falsetrue (ByPropertyName)False
-DigestPrevent changes if current configuration file has different SHA1" ." digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DiskThe disk you want to move. Enum: ide0,ide1,ide2,ide3,scsi0,scsi1,scsi2,scsi3,scsi4,scsi5,scsi6,scsi7,scsi8,scsi9,scsi10,scsi11,scsi12,scsi13,scsi14,scsi15,scsi16,scsi17,scsi18,scsi19,scsi20,scsi21,scsi22,scsi23,scsi24,scsi25,scsi26,scsi27,scsi28,scsi29,scsi30,virtio0,virtio1,virtio2,virtio3,virtio4,virtio5,virtio6,virtio7,virtio8,virtio9,virtio10,virtio11,virtio12,virtio13,virtio14,virtio15,sata0,sata1,sata2,sata3,sata4,sata5,efidisk0,tpmstate0,unused0,unused1,unused2,unused3,unused4,unused5,unused6,unused7,unused8,unused9,unused10,unused11,unused12,unused13,unused14,unused15,unused16,unused17,unused18,unused19,unused20,unused21,unused22,unused23,unused24,unused25,unused26,unused27,unused28,unused29,unused30,unused31,unused32,unused33,unused34,unused35,unused36,unused37,unused38,unused39,unused40,unused41,unused42,unused43,unused44,unused45,unused46,unused47,unused48,unused49,unused50,unused51,unused52,unused53,unused54,unused55,unused56,unused57,unused58,unused59,unused60,unused61,unused62,unused63,unused64,unused65,unused66,unused67,unused68,unused69,unused70,unused71,unused72,unused73,unused74,unused75,unused76,unused77,unused78,unused79,unused80,unused81,unused82,unused83,unused84,unused85,unused86,unused87,unused88,unused89,unused90,unused91,unused92,unused93,unused94,unused95,unused96,unused97,unused98,unused99,unused100,unused101,unused102,unused103,unused104,unused105,unused106,unused107,unused108,unused109,unused110,unused111,unused112,unused113,unused114,unused115,unused116,unused117,unused118,unused119,unused120,unused121,unused122,unused123,unused124,unused125,unused126,unused127,unused128,unused129,unused130,unused131,unused132,unused133,unused134,unused135,unused136,unused137,unused138,unused139,unused140,unused141,unused142,unused143,unused144,unused145,unused146,unused147,unused148,unused149,unused150,unused151,unused152,unused153,unused154,unused155,unused156,unused157,unused158,unused159,unused160,unused161,unused162,unused163,unused164,unused165,unused166,unused167,unused168,unused169,unused170,unused171,unused172,unused173,unused174,unused175,unused176,unused177,unused178,unused179,unused180,unused181,unused182,unused183,unused184,unused185,unused186,unused187,unused188,unused189,unused190,unused191,unused192,unused193,unused194,unused195,unused196,unused197,unused198,unused199,unused200,unused201,unused202,unused203,unused204,unused205,unused206,unused207,unused208,unused209,unused210,unused211,unused212,unused213,unused214,unused215,unused216,unused217,unused218,unused219,unused220,unused221,unused222,unused223,unused224,unused225,unused226,unused227,unused228,unused229,unused230,unused231,unused232,unused233,unused234,unused235,unused236,unused237,unused238,unused239,unused240,unused241,unused242,unused243,unused244,unused245,unused246,unused247,unused248,unused249,unused250,unused251,unused252,unused253,unused254,unused255truetrue (ByPropertyName)
-FormatTarget Format. Enum: raw,qcow2,vmdkfalsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-StorageTarget storage.falsetrue (ByPropertyName)
-TargetDigestPrevent changes if the current config file of the target VM has a" ." different SHA1 digest. This can be used to detect concurrent modifications.falsetrue (ByPropertyName)
-TargetDiskThe config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key. Enum: ide0,ide1,ide2,ide3,scsi0,scsi1,scsi2,scsi3,scsi4,scsi5,scsi6,scsi7,scsi8,scsi9,scsi10,scsi11,scsi12,scsi13,scsi14,scsi15,scsi16,scsi17,scsi18,scsi19,scsi20,scsi21,scsi22,scsi23,scsi24,scsi25,scsi26,scsi27,scsi28,scsi29,scsi30,virtio0,virtio1,virtio2,virtio3,virtio4,virtio5,virtio6,virtio7,virtio8,virtio9,virtio10,virtio11,virtio12,virtio13,virtio14,virtio15,sata0,sata1,sata2,sata3,sata4,sata5,efidisk0,tpmstate0,unused0,unused1,unused2,unused3,unused4,unused5,unused6,unused7,unused8,unused9,unused10,unused11,unused12,unused13,unused14,unused15,unused16,unused17,unused18,unused19,unused20,unused21,unused22,unused23,unused24,unused25,unused26,unused27,unused28,unused29,unused30,unused31,unused32,unused33,unused34,unused35,unused36,unused37,unused38,unused39,unused40,unused41,unused42,unused43,unused44,unused45,unused46,unused47,unused48,unused49,unused50,unused51,unused52,unused53,unused54,unused55,unused56,unused57,unused58,unused59,unused60,unused61,unused62,unused63,unused64,unused65,unused66,unused67,unused68,unused69,unused70,unused71,unused72,unused73,unused74,unused75,unused76,unused77,unused78,unused79,unused80,unused81,unused82,unused83,unused84,unused85,unused86,unused87,unused88,unused89,unused90,unused91,unused92,unused93,unused94,unused95,unused96,unused97,unused98,unused99,unused100,unused101,unused102,unused103,unused104,unused105,unused106,unused107,unused108,unused109,unused110,unused111,unused112,unused113,unused114,unused115,unused116,unused117,unused118,unused119,unused120,unused121,unused122,unused123,unused124,unused125,unused126,unused127,unused128,unused129,unused130,unused131,unused132,unused133,unused134,unused135,unused136,unused137,unused138,unused139,unused140,unused141,unused142,unused143,unused144,unused145,unused146,unused147,unused148,unused149,unused150,unused151,unused152,unused153,unused154,unused155,unused156,unused157,unused158,unused159,unused160,unused161,unused162,unused163,unused164,unused165,unused166,unused167,unused168,unused169,unused170,unused171,unused172,unused173,unused174,unused175,unused176,unused177,unused178,unused179,unused180,unused181,unused182,unused183,unused184,unused185,unused186,unused187,unused188,unused189,unused190,unused191,unused192,unused193,unused194,unused195,unused196,unused197,unused198,unused199,unused200,unused201,unused202,unused203,unused204,unused205,unused206,unused207,unused208,unused209,unused210,unused211,unused212,unused213,unused214,unused215,unused216,unused217,unused218,unused219,unused220,unused221,unused222,unused223,unused224,unused225,unused226,unused227,unused228,unused229,unused230,unused231,unused232,unused233,unused234,unused235,unused236,unused237,unused238,unused239,unused240,unused241,unused242,unused243,unused244,unused245,unused246,unused247,unused248,unused249,unused250,unused251,unused252,unused253,unused254,unused255falsetrue (ByPropertyName)
-TargetVmidThe (unique) ID of the VM.falsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuMtunnel [[-PveTicket] <PveTicket>] [[-Bridges] <String>] [-Node] <String> [[-Storages] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-BridgesList of network bridges to check availability. Will be checked again for actually used bridges during migration.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-StoragesList of storages to check permission and availability. Will be checked again for all actually used storages during migration.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuRemoteMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [-Delete] [-Node] <String> [-Online] [-TargetBridge] <String> [-TargetEndpoint] <String> [-TargetStorage] <String> [[-TargetVmid] <Int32>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-BwlimitOverride I/O bandwidth limit (in KiB/s).falsetrue (ByPropertyName)0
-DeleteDelete the original VM and related data after successful migration. By default the original VM is kept on the source cluster in a stopped state.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-OnlineUse online/live migration if VM is running. Ignored if VM is stopped.falsetrue (ByPropertyName)False
-TargetBridgeMapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself.truetrue (ByPropertyName)
-TargetEndpointRemote target endpointtruetrue (ByPropertyName)
-TargetStorageMapping 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.truetrue (ByPropertyName)
-TargetVmidThe (unique) ID of the VM.falsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [-Vmstate] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DescriptionA textual description or comment.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-VmstateSave the vmstatefalsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-StartWhether the VM should get started after rolling back successfully. (Note':' VMs will be automatically started if the snapshot includes RAM.)falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuSpiceproxy [[-PveTicket] <PveTicket>] [-Node] <String> [[-Proxy] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ProxySPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Restart-PveQemu
  • +
+
+
+
+

Syntax

+
+
+
+ New-PveNodesQemuStatusReboot [[-PveTicket] <PveTicket>] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-TimeoutWait maximal timeout seconds for the shutdown.falsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Reset-PveQemu
  • +
+
+
+
+

Syntax

+
+
+
+ New-PveNodesQemuStatusReset [[-PveTicket] <PveTicket>] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SkiplockIgnore locks - only root is allowed to use this option.falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Resume-PveQemu
  • +
+
+
+
+

Syntax

+
+
+
+ New-PveNodesQemuStatusResume [[-PveTicket] <PveTicket>] [-Nocheck] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Nocheck--falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-SkiplockIgnore locks - only root is allowed to use this option.falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuStatusShutdown [[-PveTicket] <PveTicket>] [-Forcestop] [-Keepactive] [-Node] <String> [-Skiplock] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ForcestopMake sure the VM stops.falsetrue (ByPropertyName)False
-KeepactiveDo not deactivate storage volumes.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-SkiplockIgnore locks - only root is allowed to use this option.falsetrue (ByPropertyName)False
-TimeoutWait maximal timeout seconds.falsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Start-PveQemu
  • +
+
+
+
+

Syntax

+
+
+
+ New-PveNodesQemuStatusStart [[-PveTicket] <PveTicket>] [[-ForceCpu] <String>] [[-Machine] <String>] [[-Migratedfrom] <String>] [[-MigrationNetwork] <String>] [[-MigrationType] <String>] [-Node] <String> [-Skiplock] [[-Stateuri] <String>] [[-Targetstorage] <String>] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ForceCpuOverride QEMU's -cpu argument with the given string.falsetrue (ByPropertyName)
-MachineSpecifies the QEMU machine type.falsetrue (ByPropertyName)
-MigratedfromThe cluster node name.falsetrue (ByPropertyName)
-MigrationNetworkCIDR of the (sub) network that is used for migration.falsetrue (ByPropertyName)
-MigrationTypeMigration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. Enum: secure,insecurefalsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SkiplockIgnore locks - only root is allowed to use this option.falsetrue (ByPropertyName)False
-StateuriSome command save/restore state from this location.falsetrue (ByPropertyName)
-TargetstorageMapping 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.falsetrue (ByPropertyName)
-TimeoutWait maximal timeout seconds.falsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuStatusStop [[-PveTicket] <PveTicket>] [-Keepactive] [[-Migratedfrom] <String>] [-Node] <String> [-Skiplock] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-KeepactiveDo not deactivate storage volumes.falsetrue (ByPropertyName)False
-MigratedfromThe cluster node name.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SkiplockIgnore locks - only root is allowed to use this option.falsetrue (ByPropertyName)False
-TimeoutWait maximal timeout seconds.falsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Suspend-PveQemu
  • +
+
+
+
+

Syntax

+
+
+
+ New-PveNodesQemuStatusSuspend [[-PveTicket] <PveTicket>] [-Node] <String> [-Skiplock] [[-Statestorage] <String>] [-Todisk] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SkiplockIgnore locks - only root is allowed to use this option.falsetrue (ByPropertyName)False
-StatestorageThe storage for the VM statefalsetrue (ByPropertyName)
-TodiskIf set, suspends the VM to disk. Will be resumed on next VM start.falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuTemplate [[-PveTicket] <PveTicket>] [[-Disk] <String>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DiskIf you want to convert only 1 disk to base image. Enum: ide0,ide1,ide2,ide3,scsi0,scsi1,scsi2,scsi3,scsi4,scsi5,scsi6,scsi7,scsi8,scsi9,scsi10,scsi11,scsi12,scsi13,scsi14,scsi15,scsi16,scsi17,scsi18,scsi19,scsi20,scsi21,scsi22,scsi23,scsi24,scsi25,scsi26,scsi27,scsi28,scsi29,scsi30,virtio0,virtio1,virtio2,virtio3,virtio4,virtio5,virtio6,virtio7,virtio8,virtio9,virtio10,virtio11,virtio12,virtio13,virtio14,virtio15,sata0,sata1,sata2,sata3,sata4,sata5,efidisk0,tpmstate0falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuTermproxy [[-PveTicket] <PveTicket>] [-Node] <String> [[-Serial] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-Serialopens a serial terminal (defaults to display) Enum: serial0,serial1,serial2,serial3falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesQemuVncproxy [[-PveTicket] <PveTicket>] [-GeneratePassword] [-Node] <String> [-Vmid] <Int32> [-Websocket] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-GeneratePasswordGenerates a random password to be used as ticket instead of the API ticket.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-WebsocketPrepare for websocket upgrade (only required when using serial terminal, otherwise upgrade is always possible).falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesReplicationScheduleNow [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IdReplication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesServicesReload [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ServiceService 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-timesyncdtruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesServicesRestart [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ServiceService 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-timesyncdtruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesServicesStart [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ServiceService 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-timesyncdtruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesServicesStop [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ServiceService 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-timesyncdtruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

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

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CmdRun specific command or default to login (requires 'root@pam') Enum: ceph_install,login,upgradefalsetrue (ByPropertyName)
-CmdOptsAdd parameters to a command. Encoded as null terminated strings.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-ProxySPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesStartall [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [[-Vms] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ForceIssue start command even if virtual guest have 'onboot' not set or set to off.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmsOnly consider guests from this comma separated list of VMIDs.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesStatus [[-PveTicket] <PveTicket>] [-Command] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CommandSpecify the command. Enum: reboot,shutdowntruetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesStopall [[-PveTicket] <PveTicket>] [-ForceStop] [-Node] <String> [[-Timeout] <Int32>] [[-Vms] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ForceStopForce a hard-stop after the timeout.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-TimeoutTimeout for each guest shutdown task. Depending on `force-stop`, the shutdown gets then simply aborted or a hard-stop is forced.falsetrue (ByPropertyName)0
-VmsOnly consider Guests with these IDs.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesStorageContent [[-PveTicket] <PveTicket>] [-Filename] <String> [[-Format] <String>] [-Node] <String> [-Size] <String> [-Storage] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-FilenameThe name of the file to create.truetrue (ByPropertyName)
-Format-- Enum: raw,qcow2,subvolfalsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SizeSize in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)truetrue (ByPropertyName)
-StorageThe storage identifier.truetrue (ByPropertyName)
-VmidSpecify owner VMtruetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesStorageContentIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Storage] <String>] [-Target] <String> [[-TargetNode] <String>] [-Volume] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-StorageThe storage identifier.falsetrue (ByPropertyName)
-TargetTarget volume identifiertruetrue (ByPropertyName)
-TargetNodeTarget node. Default is local node.falsetrue (ByPropertyName)
-VolumeSource volume identifiertruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesStorageDownloadUrl [[-PveTicket] <PveTicket>] [[-Checksum] <String>] [[-ChecksumAlgorithm] <String>] [[-Compression] <String>] [-Content] <String> [-Filename] <String> [-Node] <String> [-Storage] <String> [-Url] <String> [-VerifyCertificates] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ChecksumThe expected checksum of the file.falsetrue (ByPropertyName)
-ChecksumAlgorithmThe algorithm to calculate the checksum of the file. Enum: md5,sha1,sha224,sha256,sha384,sha512falsetrue (ByPropertyName)
-CompressionDecompress the downloaded file using the specified compression algorithm.falsetrue (ByPropertyName)
-ContentContent type. Enum: iso,vztmpltruetrue (ByPropertyName)
-FilenameThe name of the file to create. Caution':' This will be normalized!truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-StorageThe storage identifier.truetrue (ByPropertyName)
-UrlThe URL to download the file from.truetrue (ByPropertyName)
-VerifyCertificatesIf false, no SSL/TLS certificates will be verified.falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesStorageUpload [[-PveTicket] <PveTicket>] [[-Checksum] <String>] [[-ChecksumAlgorithm] <String>] [-Content] <String> [-Filename] <String> [-Node] <String> [-Storage] <String> [[-Tmpfilename] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ChecksumThe expected checksum of the file.falsetrue (ByPropertyName)
-ChecksumAlgorithmThe algorithm to calculate the checksum of the file. Enum: md5,sha1,sha224,sha256,sha384,sha512falsetrue (ByPropertyName)
-ContentContent type. Enum: iso,vztmpltruetrue (ByPropertyName)
-FilenameThe name of the file to create. Caution':' This will be normalized!truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-StorageThe storage identifier.truetrue (ByPropertyName)
-TmpfilenameThe source file name. This parameter is usually set by the REST handler. You can only overwrite it when connecting to the trusted port on localhost.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ForceAlways connect to server, even if local cache is still valid.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesSuspendall [[-PveTicket] <PveTicket>] [-Node] <String> [[-Vms] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmsOnly consider Guests with these IDs.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesTermproxy [[-PveTicket] <PveTicket>] [[-Cmd] <String>] [[-CmdOpts] <String>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CmdRun specific command or default to login (requires 'root@pam') Enum: ceph_install,login,upgradefalsetrue (ByPropertyName)
-CmdOptsAdd parameters to a command. Encoded as null terminated strings.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesVncshell [[-PveTicket] <PveTicket>] [[-Cmd] <String>] [[-CmdOpts] <String>] [[-Height] <Int32>] [-Node] <String> [-Websocket] [[-Width] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CmdRun specific command or default to login (requires 'root@pam') Enum: ceph_install,login,upgradefalsetrue (ByPropertyName)
-CmdOptsAdd parameters to a command. Encoded as null terminated strings.falsetrue (ByPropertyName)
-Heightsets the height of the console in pixels.falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-Websocketuse websocket instead of standard vnc.falsetrue (ByPropertyName)False
-Widthsets the width of the console in pixels.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+
+

Aliases

+
+
+
    +
  • Backup-PveVzdump
  • +
+
+
+
+

Syntax

+
+
+
+ New-PveNodesVzdump [[-PveTicket] <PveTicket>] [-All] [[-Bwlimit] <Int32>] [[-Compress] <String>] [[-Dumpdir] <String>] [[-Exclude] <String>] [[-ExcludePath] <Array>] [[-Ionice] <Int32>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AllBackup all known guest systems on this host.falsetrue (ByPropertyName)False
-BwlimitLimit I/O bandwidth (in KiB/s).falsetrue (ByPropertyName)0
-CompressCompress dump file. Enum: 0,1,gzip,lzo,zstdfalsetrue (ByPropertyName)
-DumpdirStore resulting files to specified directory.falsetrue (ByPropertyName)
-ExcludeExclude specified guest systems (assumes --all)falsetrue (ByPropertyName)
-ExcludePathExclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.falsetrue (ByPropertyName)
-IoniceSet 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.falsetrue (ByPropertyName)0
-LockwaitMaximal time to wait for the global lock (minutes).falsetrue (ByPropertyName)0
-MailnotificationDeprecated':' use 'notification-policy' instead. Enum: always,failurefalsetrue (ByPropertyName)
-MailtoComma-separated list of email addresses or users that should receive email notifications. Has no effect if the 'notification-target' option is set at the same time.falsetrue (ByPropertyName)
-MaxfilesDeprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system.falsetrue (ByPropertyName)0
-ModeBackup mode. Enum: snapshot,suspend,stopfalsetrue (ByPropertyName)
-NodeOnly run if executed on this node.falsetrue (ByPropertyName)
-NotesTemplateTemplate 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.falsetrue (ByPropertyName)
-NotificationPolicySpecify when to send a notification Enum: always,failure,neverfalsetrue (ByPropertyName)
-NotificationTargetDetermine the target to which notifications should be sent. Can either be a notification endpoint or a notification group. This option takes precedence over 'mailto', meaning that if both are set, the 'mailto' option will be ignored.falsetrue (ByPropertyName)
-PerformanceOther performance-related settings.falsetrue (ByPropertyName)
-PigzUse pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.falsetrue (ByPropertyName)0
-PoolBackup all known guest systems included in the specified pool.falsetrue (ByPropertyName)
-ProtectedIf true, mark backup(s) as protected.falsetrue (ByPropertyName)False
-PruneBackupsUse these retention options instead of those from the storage configuration.falsetrue (ByPropertyName)
-QuietBe quiet.falsetrue (ByPropertyName)False
-RemovePrune older backups according to 'prune-backups'.falsetrue (ByPropertyName)False
-ScriptUse specified hook script.falsetrue (ByPropertyName)
-StdexcludesExclude temporary files and logs.falsetrue (ByPropertyName)False
-StdoutWrite tar to stdout, not to a file.falsetrue (ByPropertyName)False
-StopStop running backup jobs on this host.falsetrue (ByPropertyName)False
-StopwaitMaximal time to wait until a guest system is stopped (minutes).falsetrue (ByPropertyName)0
-StorageStore resulting file to this storage.falsetrue (ByPropertyName)
-TmpdirStore temporary files to specified directory.falsetrue (ByPropertyName)
-VmidThe ID of the guest system you want to backup.falsetrue (ByPropertyName)
-ZstdZstd threads. N=0 uses half of the available cores, N>0 uses N as thread count.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveNodesWakeonlan [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Nodetarget node for wake on LAN packettruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PvePools [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Poolid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-Poolid--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveStorage [[-PveTicket] <PveTicket>] [[-Authsupported] <String>] [[-Base] <String>] [[-Blocksize] <String>] [[-Bwlimit] <String>] [[-ComstarHg] <String>] [[-ComstarTg] <String>] [[-Content] <String>] [[-ContentDirs] <String>] [-CreateBasePath] [-CreateSubdirs] [[-DataPool] <String>] [[-Datastore] <String>] [-Disable] [[-Domain] <String>] [[-EncryptionKey] <String>] [[-Export] <String>] [[-Fingerprint] <String>] [[-Format] <String>] [[-FsName] <String>] [-Fuse] [[-IsMountpoint] <String>] [[-Iscsiprovider] <String>] [[-Keyring] <String>] [-Krbd] [[-LioTpg] <String>] [[-MasterPubkey] <String>] [[-MaxProtectedBackups] <Int32>] [[-Maxfiles] <Int32>] [-Mkdir] [[-Monhost] <String>] [[-Mountpoint] <String>] [[-Namespace] <String>] [-Nocow] [[-Nodes] <String>] [-Nowritecache] [[-Options] <String>] [[-Password] <SecureString>] [[-Path] <String>] [[-Pool] <String>] [[-Port] <Int32>] [[-Portal] <String>] [[-Preallocation] <String>] [[-PruneBackups] <String>] [-Saferemove] [[-SaferemoveThroughput] <String>] [[-Server] <String>] [[-Server2] <String>] [[-Share] <String>] [-Shared] [[-Smbversion] <String>] [-Sparse] [-Storage] <String> [[-Subdir] <String>] [-TaggedOnly] [[-Target] <String>] [[-Thinpool] <String>] [[-Transport] <String>] [-Type] <String> [[-Username] <String>] [[-Vgname] <String>] [[-Volume] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AuthsupportedAuthsupported.falsetrue (ByPropertyName)
-BaseBase volume. This volume is automatically activated.falsetrue (ByPropertyName)
-Blocksizeblock sizefalsetrue (ByPropertyName)
-BwlimitSet I/O bandwidth limit for various operations (in KiB/s).falsetrue (ByPropertyName)
-ComstarHghost group for comstar viewsfalsetrue (ByPropertyName)
-ComstarTgtarget group for comstar viewsfalsetrue (ByPropertyName)
-ContentAllowed content types.NOTE':' the value 'rootdir' is used for Containers, and value 'images' for VMs.falsetrue (ByPropertyName)
-ContentDirsOverrides for default content type directories.falsetrue (ByPropertyName)
-CreateBasePathCreate the base directory if it doesn't exist.falsetrue (ByPropertyName)False
-CreateSubdirsPopulate the directory with the default structure.falsetrue (ByPropertyName)False
-DataPoolData Pool (for erasure coding only)falsetrue (ByPropertyName)
-DatastoreProxmox Backup Server datastore name.falsetrue (ByPropertyName)
-DisableFlag to disable the storage.falsetrue (ByPropertyName)False
-DomainCIFS domain.falsetrue (ByPropertyName)
-EncryptionKeyEncryption key. Use 'autogen' to generate one automatically without passphrase.falsetrue (ByPropertyName)
-ExportNFS export path.falsetrue (ByPropertyName)
-FingerprintCertificate SHA 256 fingerprint.falsetrue (ByPropertyName)
-FormatDefault image format.falsetrue (ByPropertyName)
-FsNameThe Ceph filesystem name.falsetrue (ByPropertyName)
-FuseMount CephFS through FUSE.falsetrue (ByPropertyName)False
-IsMountpointAssume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.falsetrue (ByPropertyName)
-Iscsiprovideriscsi providerfalsetrue (ByPropertyName)
-KeyringClient keyring contents (for external clusters).falsetrue (ByPropertyName)
-KrbdAlways access rbd through krbd kernel module.falsetrue (ByPropertyName)False
-LioTpgtarget portal group for Linux LIO targetsfalsetrue (ByPropertyName)
-MasterPubkeyBase64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup.falsetrue (ByPropertyName)
-MaxProtectedBackupsMaximal number of protected backups per guest. Use '-1' for unlimited.falsetrue (ByPropertyName)0
-MaxfilesDeprecated':' use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited.falsetrue (ByPropertyName)0
-MkdirCreate the directory if it doesn't exist and populate it with default sub-dirs. NOTE':' Deprecated, use the 'create-base-path' and 'create-subdirs' options instead.falsetrue (ByPropertyName)False
-MonhostIP addresses of monitors (for external clusters).falsetrue (ByPropertyName)
-Mountpointmount pointfalsetrue (ByPropertyName)
-NamespaceNamespace.falsetrue (ByPropertyName)
-NocowSet the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system.falsetrue (ByPropertyName)False
-NodesList of cluster node names.falsetrue (ByPropertyName)
-Nowritecachedisable write caching on the targetfalsetrue (ByPropertyName)False
-OptionsNFS/CIFS mount options (see 'man nfs' or 'man mount.cifs')falsetrue (ByPropertyName)
-PasswordPassword for accessing the share/datastore.falsetrue (ByPropertyName)
-PathFile system path.falsetrue (ByPropertyName)
-PoolPool.falsetrue (ByPropertyName)
-PortFor non default port.falsetrue (ByPropertyName)0
-PortaliSCSI portal (IP or DNS name with optional port).falsetrue (ByPropertyName)
-PreallocationPreallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. Enum: off,metadata,falloc,fullfalsetrue (ByPropertyName)
-PruneBackupsThe retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.falsetrue (ByPropertyName)
-SaferemoveZero-out data when removing LVs.falsetrue (ByPropertyName)False
-SaferemoveThroughputWipe throughput (cstream -t parameter value).falsetrue (ByPropertyName)
-ServerServer IP or DNS name.falsetrue (ByPropertyName)
-Server2Backup volfile server IP or DNS name.falsetrue (ByPropertyName)
-ShareCIFS share.falsetrue (ByPropertyName)
-SharedMark storage as shared.falsetrue (ByPropertyName)False
-SmbversionSMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. Enum: default,2.0,2.1,3,3.0,3.11falsetrue (ByPropertyName)
-Sparseuse sparse volumesfalsetrue (ByPropertyName)False
-StorageThe storage identifier.truetrue (ByPropertyName)
-SubdirSubdir to mount.falsetrue (ByPropertyName)
-TaggedOnlyOnly use logical volumes tagged with 'pve-vm-ID'.falsetrue (ByPropertyName)False
-TargetiSCSI target.falsetrue (ByPropertyName)
-ThinpoolLVM thin pool LV name.falsetrue (ByPropertyName)
-TransportGluster transport':' tcp or rdma Enum: tcp,rdma,unixfalsetrue (ByPropertyName)
-TypeStorage type. Enum: btrfs,cephfs,cifs,dir,glusterfs,iscsi,iscsidirect,lvm,lvmthin,nfs,pbs,rbd,zfs,zfspooltruetrue (ByPropertyName)
-UsernameRBD Id.falsetrue (ByPropertyName)
-VgnameVolume group name.falsetrue (ByPropertyName)
-VolumeGlusterfs Volume.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ New-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [[-Description] <String>] [-Snapname] <String> [-Vmstate] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-VmIdOrNameThe (unique) ID or Name of the VM.truetrue (ByValue, ByPropertyName)
-DescriptionA textual description or comment.falsetrue (ByValue, ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByValue, ByPropertyName)
-VmstateSave the vmstatefalsetrue (ByValue, ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveAccessDomains [[-PveTicket] <PveTicket>] [-Realm] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-RealmAuthentication domain IDtruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveAccessGroups [[-PveTicket] <PveTicket>] [-Groupid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Groupid--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveAccessRoles [[-PveTicket] <PveTicket>] [-Roleid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Roleid--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveAccessTfa [[-PveTicket] <PveTicket>] [-Id] <String> [[-Password] <SecureString>] [-Userid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IdA TFA entry id.truetrue (ByPropertyName)
-PasswordThe current password.falsetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveAccessUsers [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveAccessUsersToken [[-PveTicket] <PveTicket>] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-TokenidUser-specific token identifier.truetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [[-Name] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NameACME account config file name.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IdUnique identifier for ACME plugin instance.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterBackup [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IdThe job ID.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterConfigNodes [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NameAlias name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-GroupSecurity Group name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterFirewallGroupsIdx [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Group] <String> [[-Pos] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-GroupSecurity Group name.truetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ForceDelete all members of the IPSet, if there are any.falsetrue (ByPropertyName)False
-NameIP set name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NameIP set name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [[-Pos] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterHaGroups [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-GroupThe HA group identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterHaResources [[-PveTicket] <PveTicket>] [-Sid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-SidHA 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).truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Id--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterMappingPci [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Id--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Id--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Id--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Name--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Name--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Name--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Name--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterReplication [[-PveTicket] <PveTicket>] [-Force] [-Id] <String> [-Keep] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ForceWill remove the jobconfig entry, but will not cleanup.falsetrue (ByPropertyName)False
-IdReplication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.truetrue (ByPropertyName)
-KeepKeep replicated data at target (do not remove).falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [-Controller] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ControllerThe SDN controller object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterSdnDns [[-PveTicket] <PveTicket>] [-Dns] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DnsThe SDN dns object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [-Ipam] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IpamThe SDN ipam object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [-Vnet] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-VnetThe SDN vnet object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IpThe IP address to deletetruetrue (ByPropertyName)
-MacUnicast MAC address.falsetrue (ByPropertyName)
-VnetThe SDN vnet object identifier.truetrue (ByPropertyName)
-ZoneThe SDN zone object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [-Subnet] <String> [-Vnet] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-SubnetThe SDN subnet object identifier.truetrue (ByPropertyName)
-VnetThe SDN vnet object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-Zone] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ZoneThe SDN zone object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesCephMds [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NameThe name (ID) of the mdstruetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesCephMgr [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IdThe ID of the managertruetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesCephMon [[-PveTicket] <PveTicket>] [-Monid] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-MonidMonitor IDtruetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesCephOsd [[-PveTicket] <PveTicket>] [-Cleanup] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CleanupIf set, we remove partition table entries.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-OsdidOSD IDtruetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesCephPool [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-RemoveEcprofile] [-RemoveStorages] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ForceIf true, destroys pool even if in usefalsetrue (ByPropertyName)False
-NameThe name of the pool. It must be unique.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-RemoveEcprofileRemove the erasure code profile. Defaults to true, if applicable.falsetrue (ByPropertyName)False
-RemoveStoragesRemove all pveceph-managed storages configured for this poolfalsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesCertificatesAcmeCertificate [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesCertificatesCustom [[-PveTicket] <PveTicket>] [-Node] <String> [-Restart] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-RestartRestart pveproxy.falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesDisksDirectory [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CleanupConfigMarks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only).falsetrue (ByPropertyName)False
-CleanupDisksAlso wipe disk so it can be repurposed afterwards.falsetrue (ByPropertyName)False
-NameThe storage identifier.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesDisksLvm [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CleanupConfigMarks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only).falsetrue (ByPropertyName)False
-CleanupDisksAlso wipe disks so they can be repurposed afterwards.falsetrue (ByPropertyName)False
-NameThe storage identifier.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesDisksLvmthin [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [-VolumeGroup] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CleanupConfigMarks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only).falsetrue (ByPropertyName)False
-CleanupDisksAlso wipe disks so they can be repurposed afterwards.falsetrue (ByPropertyName)False
-NameThe storage identifier.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VolumeGroupThe storage identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesDisksZfs [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CleanupConfigMarks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only).falsetrue (ByPropertyName)False
-CleanupDisksAlso wipe disks so they can be repurposed afterwards.falsetrue (ByPropertyName)False
-NameThe storage identifier.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesLxc [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Force] [-Node] <String> [-Purge] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DestroyUnreferencedDisksIf set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config.falsetrue (ByPropertyName)False
-ForceForce destroy, even if running.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-PurgeRemove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed.falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NameAlias name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ForceDelete all members of the IPSet, if there are any.falsetrue (ByPropertyName)False
-NameIP set name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesLxcFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NameIP set name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ForceFor removal from config file, even if removing disk snapshots fails.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesNetworkIdx [[-PveTicket] <PveTicket>] [-Iface] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IfaceNetwork interface name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesQemu [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Node] <String> [-Purge] [-Skiplock] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DestroyUnreferencedDisksIf set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-PurgeRemove VMID from configurations, like backup & replication jobs and HA.falsetrue (ByPropertyName)False
-SkiplockIgnore locks - only root is allowed to use this option.falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NameAlias name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ForceDelete all members of the IPSet, if there are any.falsetrue (ByPropertyName)False
-NameIP set name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesQemuFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NameIP set name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ForceFor removal from config file, even if removing disk snapshots fails.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesStorageContent [[-PveTicket] <PveTicket>] [[-Delay] <Int32>] [-Node] <String> [[-Storage] <String>] [-Volume] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DelayTime to wait for the task to finish. We return 'null' if the task finish within that time.falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-StorageThe storage identifier.falsetrue (ByPropertyName)
-VolumeVolume identifiertruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesStoragePrunebackups [[-PveTicket] <PveTicket>] [-Node] <String> [[-PruneBackups] <String>] [-Storage] <String> [[-Type] <String>] [[-Vmid] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PruneBackupsUse these retention options instead of those from the storage configuration.falsetrue (ByPropertyName)
-StorageThe storage identifier.truetrue (ByPropertyName)
-TypeEither 'qemu' or 'lxc'. Only consider backups for guests of this type. Enum: qemu,lxcfalsetrue (ByPropertyName)
-VmidOnly prune backups for this VM.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveNodesTasks [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-Upid--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PvePools [[-PveTicket] <PveTicket>] [-Poolid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Poolid--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PvePoolsIdx [[-PveTicket] <PveTicket>] [-Poolid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Poolid--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveStorage [[-PveTicket] <PveTicket>] [-Storage] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-StorageThe storage identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Remove-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Snapname] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-VmIdOrNameThe (unique) ID or Name of the VM.truetrue (ByValue, ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByValue, ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Reset-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-VmIdOrNameThe (unique) ID or Name of the VM.truetrue (ByValue, ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Resume-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-VmIdOrNameThe (unique) ID or Name of the VM.truetrue (ByValue, ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveAccessAcl [[-PveTicket] <PveTicket>] [-Delete] [[-Groups] <String>] [-Path] <String> [-Propagate] [-Roles] <String> [[-Tokens] <String>] [[-Users] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DeleteRemove permissions (instead of adding it).falsetrue (ByPropertyName)False
-GroupsList of groups.falsetrue (ByPropertyName)
-PathAccess control pathtruetrue (ByPropertyName)
-PropagateAllow to propagate (inherit) permissions.falsetrue (ByPropertyName)False
-RolesList of roles.truetrue (ByPropertyName)
-TokensList of API tokens.falsetrue (ByPropertyName)
-UsersList of users.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-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] [[-Delete] <String>] [[-Digest] <String>] [[-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>] [[-UserAttr] <String>] [[-UserClasses] <String>] [-Verify] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AcrValuesSpecifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request.falsetrue (ByPropertyName)
-AutocreateAutomatically create users if they do not exist.falsetrue (ByPropertyName)False
-BaseDnLDAP base domain namefalsetrue (ByPropertyName)
-BindDnLDAP bind domain namefalsetrue (ByPropertyName)
-CapathPath to the CA certificate storefalsetrue (ByPropertyName)
-CaseSensitiveusername is case-sensitivefalsetrue (ByPropertyName)False
-CertPath to the client certificatefalsetrue (ByPropertyName)
-CertkeyPath to the client certificate keyfalsetrue (ByPropertyName)
-CheckConnectionCheck bind connection to the server.falsetrue (ByPropertyName)False
-ClientIdOpenID Client IDfalsetrue (ByPropertyName)
-ClientKeyOpenID Client Keyfalsetrue (ByPropertyName)
-CommentDescription.falsetrue (ByPropertyName)
-DefaultUse this as default realmfalsetrue (ByPropertyName)False
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DomainAD domain namefalsetrue (ByPropertyName)
-FilterLDAP filter for user sync.falsetrue (ByPropertyName)
-GroupClassesThe objectclasses for groups.falsetrue (ByPropertyName)
-GroupDnLDAP base domain name for group sync. If not set, the base_dn will be used.falsetrue (ByPropertyName)
-GroupFilterLDAP filter for group sync.falsetrue (ByPropertyName)
-GroupNameAttrLDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name.falsetrue (ByPropertyName)
-IssuerUrlOpenID Issuer Urlfalsetrue (ByPropertyName)
-ModeLDAP protocol mode. Enum: ldap,ldaps,ldap+starttlsfalsetrue (ByPropertyName)
-PasswordLDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'.falsetrue (ByPropertyName)
-PortServer port.falsetrue (ByPropertyName)0
-PromptSpecifies whether the Authorization Server prompts the End-User for reauthentication and consent.falsetrue (ByPropertyName)
-RealmAuthentication domain IDtruetrue (ByPropertyName)
-ScopesSpecifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'.falsetrue (ByPropertyName)
-SecureUse secure LDAPS protocol. DEPRECATED':' use 'mode' instead.falsetrue (ByPropertyName)False
-Server1Server IP address (or DNS name)falsetrue (ByPropertyName)
-Server2Fallback Server IP address (or DNS name)falsetrue (ByPropertyName)
-SslversionLDAPS TLS/SSL version. It's not recommended to use version older than 1.2! Enum: tlsv1,tlsv1_1,tlsv1_2,tlsv1_3falsetrue (ByPropertyName)
-SyncDefaultsOptionsThe default options for behavior of synchronizations.falsetrue (ByPropertyName)
-SyncAttributesComma 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.falsetrue (ByPropertyName)
-TfaUse Two-factor authentication.falsetrue (ByPropertyName)
-UserAttrLDAP user attribute namefalsetrue (ByPropertyName)
-UserClassesThe objectclasses for users.falsetrue (ByPropertyName)
-VerifyVerify the server's SSL certificatefalsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveAccessGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Groupid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-Groupid--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveAccessPassword [[-PveTicket] <PveTicket>] [-Password] <SecureString> [-Userid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-PasswordThe new password.truetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveAccessRoles [[-PveTicket] <PveTicket>] [-Append] [[-Privs] <String>] [-Roleid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Append--falsetrue (ByPropertyName)False
-Privs--falsetrue (ByPropertyName)
-Roleid--truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveAccessTfa [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Enable] [-Id] <String> [[-Password] <SecureString>] [-Userid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DescriptionA description to distinguish multiple entries from one anotherfalsetrue (ByPropertyName)
-EnableWhether the entry should be enabled for login.falsetrue (ByPropertyName)False
-IdA TFA entry id.truetrue (ByPropertyName)
-PasswordThe current password.falsetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveAccessUsers [[-PveTicket] <PveTicket>] [-Append] [[-Comment] <String>] [[-Email] <String>] [-Enable] [[-Expire] <Int32>] [[-Firstname] <String>] [[-Groups] <String>] [[-Keys] <String>] [[-Lastname] <String>] [-Userid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Append--falsetrue (ByPropertyName)False
-Comment--falsetrue (ByPropertyName)
-Email--falsetrue (ByPropertyName)
-EnableEnable the account (default). You can set this to '0' to disable the accountfalsetrue (ByPropertyName)False
-ExpireAccount expiration date (seconds since epoch). '0' means no expiration date.falsetrue (ByPropertyName)0
-Firstname--falsetrue (ByPropertyName)
-Groups--falsetrue (ByPropertyName)
-KeysKeys for two factor auth (yubico).falsetrue (ByPropertyName)
-Lastname--falsetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveAccessUsersToken [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Expire] <Int32>] [-Privsep] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-ExpireAPI token expiration date (seconds since epoch). '0' means no expiration date.falsetrue (ByPropertyName)0
-PrivsepRestrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.falsetrue (ByPropertyName)False
-TokenidUser-specific token identifier.truetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveAccessUsersUnlockTfa [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-UseridFull User ID, in the `name@realm` format.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [[-Contact] <String>] [[-Name] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ContactContact email addresses.falsetrue (ByPropertyName)
-NameACME account config file name.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [[-Api] <String>] [[-Data] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [-Id] <String> [[-Nodes] <String>] [[-ValidationDelay] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ApiAPI 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,zonomifalsetrue (ByPropertyName)
-DataDNS plugin data. (base64 encoded)falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DisableFlag to disable the config.falsetrue (ByPropertyName)False
-IdACME Plugin ID nametruetrue (ByPropertyName)
-NodesList of cluster node names.falsetrue (ByPropertyName)
-ValidationDelayExtra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterBackup [[-PveTicket] <PveTicket>] [-All] [[-Bwlimit] <Int32>] [[-Comment] <String>] [[-Compress] <String>] [[-Delete] <String>] [[-Dow] <String>] [[-Dumpdir] <String>] [-Enabled] [[-Exclude] <String>] [[-ExcludePath] <Array>] [-Id] <String> [[-Ionice] <Int32>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AllBackup all known guest systems on this host.falsetrue (ByPropertyName)False
-BwlimitLimit I/O bandwidth (in KiB/s).falsetrue (ByPropertyName)0
-CommentDescription for the Job.falsetrue (ByPropertyName)
-CompressCompress dump file. Enum: 0,1,gzip,lzo,zstdfalsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DowDay of week selection.falsetrue (ByPropertyName)
-DumpdirStore resulting files to specified directory.falsetrue (ByPropertyName)
-EnabledEnable or disable the job.falsetrue (ByPropertyName)False
-ExcludeExclude specified guest systems (assumes --all)falsetrue (ByPropertyName)
-ExcludePathExclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.falsetrue (ByPropertyName)
-IdThe job ID.truetrue (ByPropertyName)
-IoniceSet 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.falsetrue (ByPropertyName)0
-LockwaitMaximal time to wait for the global lock (minutes).falsetrue (ByPropertyName)0
-MailnotificationDeprecated':' use 'notification-policy' instead. Enum: always,failurefalsetrue (ByPropertyName)
-MailtoComma-separated list of email addresses or users that should receive email notifications. Has no effect if the 'notification-target' option is set at the same time.falsetrue (ByPropertyName)
-MaxfilesDeprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system.falsetrue (ByPropertyName)0
-ModeBackup mode. Enum: snapshot,suspend,stopfalsetrue (ByPropertyName)
-NodeOnly run if executed on this node.falsetrue (ByPropertyName)
-NotesTemplateTemplate 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.falsetrue (ByPropertyName)
-NotificationPolicySpecify when to send a notification Enum: always,failure,neverfalsetrue (ByPropertyName)
-NotificationTargetDetermine the target to which notifications should be sent. Can either be a notification endpoint or a notification group. This option takes precedence over 'mailto', meaning that if both are set, the 'mailto' option will be ignored.falsetrue (ByPropertyName)
-PerformanceOther performance-related settings.falsetrue (ByPropertyName)
-PigzUse pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.falsetrue (ByPropertyName)0
-PoolBackup all known guest systems included in the specified pool.falsetrue (ByPropertyName)
-ProtectedIf true, mark backup(s) as protected.falsetrue (ByPropertyName)False
-PruneBackupsUse these retention options instead of those from the storage configuration.falsetrue (ByPropertyName)
-QuietBe quiet.falsetrue (ByPropertyName)False
-RemovePrune older backups according to 'prune-backups'.falsetrue (ByPropertyName)False
-RepeatMissedIf true, the job will be run as soon as possible if it was missed while the scheduler was not running.falsetrue (ByPropertyName)False
-ScheduleBackup schedule. The format is a subset of `systemd` calendar events.falsetrue (ByPropertyName)
-ScriptUse specified hook script.falsetrue (ByPropertyName)
-StarttimeJob Start time.falsetrue (ByPropertyName)
-StdexcludesExclude temporary files and logs.falsetrue (ByPropertyName)False
-StopStop running backup jobs on this host.falsetrue (ByPropertyName)False
-StopwaitMaximal time to wait until a guest system is stopped (minutes).falsetrue (ByPropertyName)0
-StorageStore resulting file to this storage.falsetrue (ByPropertyName)
-TmpdirStore temporary files to specified directory.falsetrue (ByPropertyName)
-VmidThe ID of the guest system you want to backup.falsetrue (ByPropertyName)
-ZstdZstd threads. N=0 uses half of the available cores, N>0 uses N as thread count.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterCephFlags [[-PveTicket] <PveTicket>] [-Nobackfill] [-NodeepScrub] [-Nodown] [-Noin] [-Noout] [-Norebalance] [-Norecover] [-Noscrub] [-Notieragent] [-Noup] [-Pause] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NobackfillBackfilling of PGs is suspended.falsetrue (ByPropertyName)False
-NodeepScrubDeep Scrubbing is disabled.falsetrue (ByPropertyName)False
-NodownOSD failure reports are being ignored, such that the monitors will not mark OSDs down.falsetrue (ByPropertyName)False
-NoinOSDs that were previously marked out will not be marked back in when they start.falsetrue (ByPropertyName)False
-NooutOSDs will not automatically be marked out after the configured interval.falsetrue (ByPropertyName)False
-NorebalanceRebalancing of PGs is suspended.falsetrue (ByPropertyName)False
-NorecoverRecovery of PGs is suspended.falsetrue (ByPropertyName)False
-NoscrubScrubbing is disabled.falsetrue (ByPropertyName)False
-NotieragentCache tiering activity is suspended.falsetrue (ByPropertyName)False
-NoupOSDs are not allowed to start.falsetrue (ByPropertyName)False
-PausePauses read and writes.falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterCephFlagsIdx [[-PveTicket] <PveTicket>] [-Flag] <String> -Value [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-FlagThe ceph flag to update Enum: nobackfill,nodeep-scrub,nodown,noin,noout,norebalance,norecover,noscrub,notieragent,noup,pausetruetrue (ByPropertyName)
-ValueThe new value of the flagtruetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [[-Rename] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NameAlias name.truetrue (ByPropertyName)
-RenameRename an existing alias.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [-Group] <String> [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ActionRule action ('ACCEPT', 'DROP', 'REJECT') or security group name.falsetrue (ByPropertyName)
-CommentDescriptive comment.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DestRestrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DportRestrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-EnableFlag to enable/disable a rule.falsetrue (ByPropertyName)0
-GroupSecurity Group name.truetrue (ByPropertyName)
-IcmpTypeSpecify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.falsetrue (ByPropertyName)
-IfaceNetwork interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.falsetrue (ByPropertyName)
-LogLog level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-MacroUse predefined standard macro.falsetrue (ByPropertyName)
-MovetoMove rule to new position <moveto>. Other arguments are ignored.falsetrue (ByPropertyName)0
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
-ProtoIP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.falsetrue (ByPropertyName)
-SourceRestrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-SportRestrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-TypeRule type. Enum: in,out,groupfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Nomatch] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NameIP set name.truetrue (ByPropertyName)
-Nomatch--falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Ebtables] [[-Enable] <Int32>] [[-LogRatelimit] <String>] [[-PolicyIn] <String>] [[-PolicyOut] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-EbtablesEnable ebtables rules cluster wide.falsetrue (ByPropertyName)False
-EnableEnable or disable the firewall cluster wide.falsetrue (ByPropertyName)0
-LogRatelimitLog ratelimiting settingsfalsetrue (ByPropertyName)
-PolicyInInput policy. Enum: ACCEPT,REJECT,DROPfalsetrue (ByPropertyName)
-PolicyOutOutput policy. Enum: ACCEPT,REJECT,DROPfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ActionRule action ('ACCEPT', 'DROP', 'REJECT') or security group name.falsetrue (ByPropertyName)
-CommentDescriptive comment.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DestRestrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DportRestrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-EnableFlag to enable/disable a rule.falsetrue (ByPropertyName)0
-IcmpTypeSpecify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.falsetrue (ByPropertyName)
-IfaceNetwork interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.falsetrue (ByPropertyName)
-LogLog level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-MacroUse predefined standard macro.falsetrue (ByPropertyName)
-MovetoMove rule to new position <moveto>. Other arguments are ignored.falsetrue (ByPropertyName)0
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
-ProtoIP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.falsetrue (ByPropertyName)
-SourceRestrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-SportRestrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-TypeRule type. Enum: in,out,groupfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterHaGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Group] <String> [[-Nodes] <String>] [-Nofailback] [-Restricted] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CommentDescription.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-GroupThe HA group identifier.truetrue (ByPropertyName)
-NodesList of cluster node names with optional priority.falsetrue (ByPropertyName)
-NofailbackThe CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.falsetrue (ByPropertyName)False
-RestrictedResources bound to restricted groups may only run on nodes defined by the group.falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterHaResources [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [[-Digest] <String>] [[-Group] <String>] [[-MaxRelocate] <Int32>] [[-MaxRestart] <Int32>] [-Sid] <String> [[-State] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CommentDescription.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-GroupThe HA group identifier.falsetrue (ByPropertyName)
-MaxRelocateMaximal number of service relocate tries when a service failes to start.falsetrue (ByPropertyName)0
-MaxRestartMaximal number of tries to restart the service on a node after its start failed.falsetrue (ByPropertyName)0
-SidHA 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).truetrue (ByPropertyName)
-StateRequested resource state. Enum: started,stopped,enabled,disabled,ignoredfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [-EnableNew] [-Enabled] [-Id] <String> [[-RemoveVanished] <String>] [-Schedule] <String> [[-Scope] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CommentDescription for the Job.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-EnableNewEnable newly synced users immediately.falsetrue (ByPropertyName)False
-EnabledDetermines if the job is enabled.falsetrue (ByPropertyName)False
-IdThe ID of the job.truetrue (ByPropertyName)
-RemoveVanishedA 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).falsetrue (ByPropertyName)
-ScheduleBackup schedule. The format is a subset of `systemd` calendar events.truetrue (ByPropertyName)
-ScopeSelect what to sync. Enum: users,groups,bothfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterMappingPci [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [-Id] <String> [[-Map] <Array>] [-Mdev] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DescriptionDescription of the logical PCI device.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-IdThe ID of the logical PCI mapping.truetrue (ByPropertyName)
-MapA list of maps for the cluster nodes.falsetrue (ByPropertyName)
-Mdev--falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [-Id] <String> [-Map] <Array> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DescriptionDescription of the logical USB device.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-IdThe ID of the logical USB mapping.truetrue (ByPropertyName)
-MapA list of maps for the cluster nodes.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [[-ApiPathPrefix] <String>] [[-Bucket] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [-Id] <String> [[-Influxdbproto] <String>] [[-MaxBodySize] <Int32>] [[-Mtu] <Int32>] [[-Organization] <String>] [[-Path] <String>] [-Port] <Int32> [[-Proto] <String>] [-Server] <String> [[-Timeout] <Int32>] [[-Token] <String>] [-VerifyCertificate] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ApiPathPrefixAn API path prefix inserted between '<host>':'<port>/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy.falsetrue (ByPropertyName)
-BucketThe InfluxDB bucket/db. Only necessary when using the http v2 api.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DisableFlag to disable the plugin.falsetrue (ByPropertyName)False
-IdThe ID of the entry.truetrue (ByPropertyName)
-Influxdbproto-- Enum: udp,http,httpsfalsetrue (ByPropertyName)
-MaxBodySizeInfluxDB max-body-size in bytes. Requests are batched up to this size.falsetrue (ByPropertyName)0
-MtuMTU for metrics transmission over UDPfalsetrue (ByPropertyName)0
-OrganizationThe InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api.falsetrue (ByPropertyName)
-Pathroot graphite path (ex':' proxmox.mycluster.mykey)falsetrue (ByPropertyName)
-Portserver network porttruetrue (ByPropertyName)0
-ProtoProtocol to send graphite data. TCP or UDP (default) Enum: udp,tcpfalsetrue (ByPropertyName)
-Serverserver dns name or IP addresstruetrue (ByPropertyName)
-Timeoutgraphite TCP socket timeout (default=1)falsetrue (ByPropertyName)0
-TokenThe InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user':'password' instead.falsetrue (ByPropertyName)
-VerifyCertificateSet to 0 to disable certificate verification for https endpoints.falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [-Name] <String> [[-Server] <String>] [[-Token] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CommentCommentfalsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DisableDisable this targetfalsetrue (ByPropertyName)False
-NameThe name of the endpoint.truetrue (ByPropertyName)
-ServerServer URLfalsetrue (ByPropertyName)
-TokenSecret tokenfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [[-Author] <String>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [[-FromAddress] <String>] [[-Mailto] <Array>] [[-MailtoUser] <Array>] [-Name] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AuthorAuthor of the mailfalsetrue (ByPropertyName)
-CommentCommentfalsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DisableDisable this targetfalsetrue (ByPropertyName)False
-FromAddress`From` address for the mailfalsetrue (ByPropertyName)
-MailtoList of email recipientsfalsetrue (ByPropertyName)
-MailtoUserList of usersfalsetrue (ByPropertyName)
-NameThe name of the endpoint.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [[-Author] <String>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [[-FromAddress] <String>] [[-Mailto] <Array>] [[-MailtoUser] <Array>] [[-Mode] <String>] [-Name] <String> [[-Password] <SecureString>] [[-Port] <Int32>] [[-Server] <String>] [[-Username] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AuthorAuthor of the mail. Defaults to 'Proxmox VE'.falsetrue (ByPropertyName)
-CommentCommentfalsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DisableDisable this targetfalsetrue (ByPropertyName)False
-FromAddress`From` address for the mailfalsetrue (ByPropertyName)
-MailtoList of email recipientsfalsetrue (ByPropertyName)
-MailtoUserList of usersfalsetrue (ByPropertyName)
-ModeDetermine which encryption method shall be used for the connection. Enum: insecure,starttls,tlsfalsetrue (ByPropertyName)
-NameThe name of the endpoint.truetrue (ByPropertyName)
-PasswordPassword for SMTP authenticationfalsetrue (ByPropertyName)
-PortThe port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections.falsetrue (ByPropertyName)0
-ServerThe address of the SMTP server.falsetrue (ByPropertyName)
-UsernameUsername for SMTP authenticationfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [-InvertMatch] [[-MatchCalendar] <Array>] [[-MatchField] <Array>] [[-MatchSeverity] <Array>] [[-Mode] <String>] [-Name] <String> [[-Target] <Array>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CommentCommentfalsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DisableDisable this matcherfalsetrue (ByPropertyName)False
-InvertMatchInvert match of the whole matcherfalsetrue (ByPropertyName)False
-MatchCalendarMatch notification timestampfalsetrue (ByPropertyName)
-MatchFieldMetadata fields to match (regex or exact match). Must be in the form (regex|exact)':'<field>=<value>falsetrue (ByPropertyName)
-MatchSeverityNotification severities to matchfalsetrue (ByPropertyName)
-ModeChoose between 'all' and 'any' for when multiple properties are specified Enum: all,anyfalsetrue (ByPropertyName)
-NameName of the matcher.truetrue (ByPropertyName)
-TargetTargets to notify on matchfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterOptions [[-PveTicket] <PveTicket>] [[-Bwlimit] <String>] [[-Console] <String>] [[-Crs] <String>] [[-Delete] <String>] [[-Description] <String>] [[-EmailFrom] <String>] [[-Fencing] <String>] [[-Ha] <String>] [[-HttpProxy] <String>] [[-Keyboard] <String>] [[-Language] <String>] [[-MacPrefix] <String>] [[-MaxWorkers] <Int32>] [[-Migration] <String>] [-MigrationUnsecure] [[-NextId] <String>] [[-Notify] <String>] [[-RegisteredTags] <String>] [[-TagStyle] <String>] [[-U2f] <String>] [[-UserTagAccess] <String>] [[-Webauthn] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-BwlimitSet I/O bandwidth limit for various operations (in KiB/s).falsetrue (ByPropertyName)
-ConsoleSelect the default Console viewer. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer comtatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC. Enum: applet,vv,html5,xtermjsfalsetrue (ByPropertyName)
-CrsCluster resource scheduling settings.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DescriptionDatacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.falsetrue (ByPropertyName)
-EmailFromSpecify email address to send notification from (default is root@$hostname)falsetrue (ByPropertyName)
-FencingSet the fencing mode of the HA cluster. Hardware mode needs a valid configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two modes are used.WARNING':' 'hardware' and 'both' are EXPERIMENTAL & WIP Enum: watchdog,hardware,bothfalsetrue (ByPropertyName)
-HaCluster wide HA settings.falsetrue (ByPropertyName)
-HttpProxySpecify external http proxy which is used for downloads (example':' 'http':'//username':'password@host':'port/')falsetrue (ByPropertyName)
-KeyboardDefault keybord layout for vnc server. Enum: de,de-ch,da,en-gb,en-us,es,fi,fr,fr-be,fr-ca,fr-ch,hu,is,it,ja,lt,mk,nl,no,pl,pt,pt-br,sv,sl,trfalsetrue (ByPropertyName)
-LanguageDefault GUI language. Enum: ar,ca,da,de,en,es,eu,fa,fr,hr,he,it,ja,ka,kr,nb,nl,nn,pl,pt_BR,ru,sl,sv,tr,ukr,zh_CN,zh_TWfalsetrue (ByPropertyName)
-MacPrefixPrefix for the auto-generated MAC addresses of virtual guests. The default 'BC':'24':'11' is the OUI assigned by the IEEE to Proxmox Server Solutions GmbH for a 24-bit large MAC block. You're allowed to use this in local networks, i.e., those not directly reachable by the public (e.g., in a LAN or behind NAT).falsetrue (ByPropertyName)
-MaxWorkersDefines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.falsetrue (ByPropertyName)0
-MigrationFor cluster wide migration settings.falsetrue (ByPropertyName)
-MigrationUnsecureMigration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration. Deprecated, use the 'migration' property instead!falsetrue (ByPropertyName)False
-NextIdControl the range for the free VMID auto-selection pool.falsetrue (ByPropertyName)
-NotifyCluster-wide notification settings.falsetrue (ByPropertyName)
-RegisteredTagsA list of tags that require a `Sys.Modify` on '/' to set and delete. Tags set here that are also in 'user-tag-access' also require `Sys.Modify`.falsetrue (ByPropertyName)
-TagStyleTag style options.falsetrue (ByPropertyName)
-U2fu2ffalsetrue (ByPropertyName)
-UserTagAccessPrivilege options for user-settable tagsfalsetrue (ByPropertyName)
-Webauthnwebauthn configurationfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterReplication [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [-Id] <String> [[-Rate] <Single>] [[-RemoveJob] <String>] [[-Schedule] <String>] [[-Source] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CommentDescription.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DisableFlag to disable/deactivate the entry.falsetrue (ByPropertyName)False
-IdReplication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.truetrue (ByPropertyName)
-RateRate limit in mbps (megabytes per second) as floating point number.falsetrue (ByPropertyName)0
-RemoveJobMark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. Enum: local,fullfalsetrue (ByPropertyName)
-ScheduleStorage replication schedule. The format is a subset of `systemd` calendar events.falsetrue (ByPropertyName)
-SourceFor internal use, to detect if the guest was stolen.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterSdn [[-PveTicket] <PveTicket>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [[-Asn] <Int32>] [-BgpMultipathAsPathRelax] [-Controller] <String> [[-Delete] <String>] [[-Digest] <String>] [-Ebgp] [[-EbgpMultihop] <Int32>] [[-IsisDomain] <String>] [[-IsisIfaces] <String>] [[-IsisNet] <String>] [[-Loopback] <String>] [[-Node] <String>] [[-Peers] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Asnautonomous system numberfalsetrue (ByPropertyName)0
-BgpMultipathAsPathRelax--falsetrue (ByPropertyName)False
-ControllerThe SDN controller object identifier.truetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-EbgpEnable ebgp. (remote-as external)falsetrue (ByPropertyName)False
-EbgpMultihop--falsetrue (ByPropertyName)0
-IsisDomainISIS domain.falsetrue (ByPropertyName)
-IsisIfacesISIS interface.falsetrue (ByPropertyName)
-IsisNetISIS network entity title.falsetrue (ByPropertyName)
-Loopbacksource loopback interface.falsetrue (ByPropertyName)
-NodeThe cluster node name.falsetrue (ByPropertyName)
-Peerspeers address list.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterSdnDns [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Dns] <String> [[-Key] <String>] [[-Reversemaskv6] <Int32>] [[-Ttl] <Int32>] [[-Url] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DnsThe SDN dns object identifier.truetrue (ByPropertyName)
-Key--falsetrue (ByPropertyName)
-Reversemaskv6--falsetrue (ByPropertyName)0
-Ttl--falsetrue (ByPropertyName)0
-Url--falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Ipam] <String> [[-Section] <Int32>] [[-Token] <String>] [[-Url] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-IpamThe SDN ipam object identifier.truetrue (ByPropertyName)
-Section--falsetrue (ByPropertyName)0
-Token--falsetrue (ByPropertyName)
-Url--falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [[-Alias] <String>] [[-Delete] <String>] [[-Digest] <String>] [[-Tag] <Int32>] [-Vlanaware] [-Vnet] <String> [[-Zone] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Aliasalias name of the vnetfalsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-Tagvlan or vxlan idfalsetrue (ByPropertyName)0
-VlanawareAllow vm VLANs to pass through this vnet.falsetrue (ByPropertyName)False
-VnetThe SDN vnet object identifier.truetrue (ByPropertyName)
-Zonezone idfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [[-Vmid] <Int32>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-IpThe IP address to associate with the given MAC addresstruetrue (ByPropertyName)
-MacUnicast MAC address.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.falsetrue (ByPropertyName)0
-VnetThe SDN vnet object identifier.truetrue (ByPropertyName)
-ZoneThe SDN zone object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-DhcpDnsServer] <String>] [[-DhcpRange] <Array>] [[-Digest] <String>] [[-Dnszoneprefix] <String>] [[-Gateway] <String>] [-Snat] [-Subnet] <String> [[-Vnet] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DhcpDnsServerIP address for the DNS serverfalsetrue (ByPropertyName)
-DhcpRangeA list of DHCP ranges for this subnetfalsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-Dnszoneprefixdns domain zone prefix ex':' 'adm' -> <hostname>.adm.mydomain.comfalsetrue (ByPropertyName)
-GatewaySubnet Gateway':' Will be assign on vnet for layer3 zonesfalsetrue (ByPropertyName)
-Snatenable masquerade for this subnet if pve-firewallfalsetrue (ByPropertyName)False
-SubnetThe SDN subnet object identifier.truetrue (ByPropertyName)
-Vnetassociated vnetfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-AdvertiseSubnets] [[-Bridge] <String>] [-BridgeDisableMacLearning] [[-Controller] <String>] [[-Delete] <String>] [[-Dhcp] <String>] [[-Digest] <String>] [-DisableArpNdSuppression] [[-Dns] <String>] [[-Dnszone] <String>] [[-DpId] <Int32>] [[-Exitnodes] <String>] [-ExitnodesLocalRouting] [[-ExitnodesPrimary] <String>] [[-Ipam] <String>] [[-Mac] <String>] [[-Mtu] <Int32>] [[-Nodes] <String>] [[-Peers] <String>] [[-Reversedns] <String>] [[-RtImport] <String>] [[-Tag] <Int32>] [[-VlanProtocol] <String>] [[-VrfVxlan] <Int32>] [[-VxlanPort] <Int32>] [-Zone] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AdvertiseSubnetsAdvertise evpn subnets if you have silent hostsfalsetrue (ByPropertyName)False
-Bridge--falsetrue (ByPropertyName)
-BridgeDisableMacLearningDisable auto mac learning.falsetrue (ByPropertyName)False
-ControllerFrr router namefalsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DhcpType of the DHCP backend for this zone Enum: dnsmasqfalsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DisableArpNdSuppressionDisable ipv4 arp && ipv6 neighbour discovery suppressionfalsetrue (ByPropertyName)False
-Dnsdns api serverfalsetrue (ByPropertyName)
-Dnszonedns domain zone ex':' mydomain.comfalsetrue (ByPropertyName)
-DpIdFaucet dataplane idfalsetrue (ByPropertyName)0
-ExitnodesList of cluster node names.falsetrue (ByPropertyName)
-ExitnodesLocalRoutingAllow exitnodes to connect to evpn guestsfalsetrue (ByPropertyName)False
-ExitnodesPrimaryForce traffic to this exitnode first.falsetrue (ByPropertyName)
-Ipamuse a specific ipamfalsetrue (ByPropertyName)
-MacAnycast logical router mac addressfalsetrue (ByPropertyName)
-MtuMTUfalsetrue (ByPropertyName)0
-NodesList of cluster node names.falsetrue (ByPropertyName)
-Peerspeers address list.falsetrue (ByPropertyName)
-Reversednsreverse dns api serverfalsetrue (ByPropertyName)
-RtImportRoute-Target importfalsetrue (ByPropertyName)
-TagService-VLAN Tagfalsetrue (ByPropertyName)0
-VlanProtocol-- Enum: 802.1q,802.1adfalsetrue (ByPropertyName)
-VrfVxlanl3vni.falsetrue (ByPropertyName)0
-VxlanPortVxlan tunnel udp port (default 4789).falsetrue (ByPropertyName)0
-ZoneThe SDN zone object identifier.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Handle] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DigestDigest to detect modifications.falsetrue (ByPropertyName)
-HandleHandle that identifies a repository.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesCephPool [[-PveTicket] <PveTicket>] [[-Application] <String>] [[-CrushRule] <String>] [[-MinSize] <Int32>] [-Name] <String> [-Node] <String> [[-PgAutoscaleMode] <String>] [[-PgNum] <Int32>] [[-PgNumMin] <Int32>] [[-Size] <Int32>] [[-TargetSize] <String>] [[-TargetSizeRatio] <Single>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ApplicationThe application of the pool. Enum: rbd,cephfs,rgwfalsetrue (ByPropertyName)
-CrushRuleThe rule to use for mapping object placement in the cluster.falsetrue (ByPropertyName)
-MinSizeMinimum number of replicas per objectfalsetrue (ByPropertyName)0
-NameThe name of the pool. It must be unique.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-PgAutoscaleModeThe automatic PG scaling mode of the pool. Enum: on,off,warnfalsetrue (ByPropertyName)
-PgNumNumber of placement groups.falsetrue (ByPropertyName)0
-PgNumMinMinimal number of placement groups.falsetrue (ByPropertyName)0
-SizeNumber of replicas per objectfalsetrue (ByPropertyName)0
-TargetSizeThe estimated target size of the pool for the PG autoscaler.falsetrue (ByPropertyName)
-TargetSizeRatioThe estimated target ratio of the pool for the PG autoscaler.falsetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesCertificatesAcmeCertificate [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ForceForce renewal even if expiry is more than 30 days away.falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesConfig [[-PveTicket] <PveTicket>] [[-Acme] <String>] [[-AcmedomainN] <Hashtable>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [-Node] <String> [[-StartallOnbootDelay] <Int32>] [[-Wakeonlan] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AcmeNode specific ACME settings.falsetrue (ByPropertyName)
-AcmedomainNACME domain and validation pluginfalsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DescriptionDescription for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-StartallOnbootDelayInitial delay in seconds, before starting all the Virtual Guests with on-boot enabled.falsetrue (ByPropertyName)0
-WakeonlanMAC address for wake on LANfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesDisksWipedisk [[-PveTicket] <PveTicket>] [-Disk] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DiskBlock device nametruetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesDns [[-PveTicket] <PveTicket>] [[-Dns1] <String>] [[-Dns2] <String>] [[-Dns3] <String>] [-Node] <String> [-Search] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Dns1First name server IP address.falsetrue (ByPropertyName)
-Dns2Second name server IP address.falsetrue (ByPropertyName)
-Dns3Third name server IP address.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SearchSearch domain for host-name lookup.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Enable] [[-LogLevelIn] <String>] [[-LogLevelOut] <String>] [-LogNfConntrack] [-Ndp] [-NfConntrackAllowInvalid] [[-NfConntrackHelpers] <String>] [[-NfConntrackMax] <Int32>] [[-NfConntrackTcpTimeoutEstablished] <Int32>] [[-NfConntrackTcpTimeoutSynRecv] <Int32>] [-Node] <String> [-Nosmurfs] [-ProtectionSynflood] [[-ProtectionSynfloodBurst] <Int32>] [[-ProtectionSynfloodRate] <Int32>] [[-SmurfLogLevel] <String>] [[-TcpFlagsLogLevel] <String>] [-Tcpflags] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-EnableEnable host firewall rules.falsetrue (ByPropertyName)False
-LogLevelInLog level for incoming traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-LogLevelOutLog level for outgoing traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-LogNfConntrackEnable logging of conntrack information.falsetrue (ByPropertyName)False
-NdpEnable NDP (Neighbor Discovery Protocol).falsetrue (ByPropertyName)False
-NfConntrackAllowInvalidAllow invalid packets on connection tracking.falsetrue (ByPropertyName)False
-NfConntrackHelpersEnable conntrack helpers for specific protocols. Supported protocols':' amanda, ftp, irc, netbios-ns, pptp, sane, sip, snmp, tftpfalsetrue (ByPropertyName)
-NfConntrackMaxMaximum number of tracked connections.falsetrue (ByPropertyName)0
-NfConntrackTcpTimeoutEstablishedConntrack established timeout.falsetrue (ByPropertyName)0
-NfConntrackTcpTimeoutSynRecvConntrack syn recv timeout.falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-NosmurfsEnable SMURFS filter.falsetrue (ByPropertyName)False
-ProtectionSynfloodEnable synflood protectionfalsetrue (ByPropertyName)False
-ProtectionSynfloodBurstSynflood protection rate burst by ip src.falsetrue (ByPropertyName)0
-ProtectionSynfloodRateSynflood protection rate syn/sec by ip src.falsetrue (ByPropertyName)0
-SmurfLogLevelLog level for SMURFS filter. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-TcpFlagsLogLevelLog level for illegal tcp flags filter. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-TcpflagsFilter illegal combinations of TCP flags.falsetrue (ByPropertyName)False
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ActionRule action ('ACCEPT', 'DROP', 'REJECT') or security group name.falsetrue (ByPropertyName)
-CommentDescriptive comment.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DestRestrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DportRestrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-EnableFlag to enable/disable a rule.falsetrue (ByPropertyName)0
-IcmpTypeSpecify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.falsetrue (ByPropertyName)
-IfaceNetwork interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.falsetrue (ByPropertyName)
-LogLog level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-MacroUse predefined standard macro.falsetrue (ByPropertyName)
-MovetoMove rule to new position <moveto>. Other arguments are ignored.falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
-ProtoIP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.falsetrue (ByPropertyName)
-SourceRestrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-SportRestrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-TypeRule type. Enum: in,out,groupfalsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesLxcConfig [[-PveTicket] <PveTicket>] [[-Arch] <String>] [[-Cmode] <String>] [-Console] [[-Cores] <Int32>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [-Debug_] [[-Delete] <String>] [[-Description] <String>] [[-DevN] <Hashtable>] [[-Digest] <String>] [[-Features] <String>] [[-Hookscript] <String>] [[-Hostname] <String>] [[-Lock] <String>] [[-Memory] <Int32>] [[-MpN] <Hashtable>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Onboot] [[-Ostype] <String>] [-Protection] [[-Revert] <String>] [[-Rootfs] <String>] [[-Searchdomain] <String>] [[-Startup] <String>] [[-Swap] <Int32>] [[-Tags] <String>] [-Template] [[-Timezone] <String>] [[-Tty] <Int32>] [-Unprivileged] [[-UnusedN] <Hashtable>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ArchOS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64falsetrue (ByPropertyName)
-CmodeConsole mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). Enum: shell,console,ttyfalsetrue (ByPropertyName)
-ConsoleAttach a console device (/dev/console) to the container.falsetrue (ByPropertyName)False
-CoresThe number of cores assigned to the container. A container can use all available cores by default.falsetrue (ByPropertyName)0
-CpulimitLimit of CPU usage.NOTE':' If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.falsetrue (ByPropertyName)0
-CpuunitsCPU weight for a container, will be clamped to \[1, 10000] in cgroup v2.falsetrue (ByPropertyName)0
-Debug_Try to be more verbose. For now this only enables debug log-level on start.falsetrue (ByPropertyName)False
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DescriptionDescription for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.falsetrue (ByPropertyName)
-DevNDevice to pass through to the containerfalsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-FeaturesAllow containers access to advanced features.falsetrue (ByPropertyName)
-HookscriptScript that will be exectued during various steps in the containers lifetime.falsetrue (ByPropertyName)
-HostnameSet a host name for the container.falsetrue (ByPropertyName)
-LockLock/unlock the container. Enum: backup,create,destroyed,disk,fstrim,migrate,mounted,rollback,snapshot,snapshot-deletefalsetrue (ByPropertyName)
-MemoryAmount of RAM for the container in MB.falsetrue (ByPropertyName)0
-MpNUse volume as container mount point. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume.falsetrue (ByPropertyName)
-NameserverSets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.falsetrue (ByPropertyName)
-NetNSpecifies network interfaces for the container.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-OnbootSpecifies whether a container will be started during system bootup.falsetrue (ByPropertyName)False
-OstypeOS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. Enum: debian,devuan,ubuntu,centos,fedora,opensuse,archlinux,alpine,gentoo,nixos,unmanagedfalsetrue (ByPropertyName)
-ProtectionSets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.falsetrue (ByPropertyName)False
-RevertRevert a pending change.falsetrue (ByPropertyName)
-RootfsUse volume as container root.falsetrue (ByPropertyName)
-SearchdomainSets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.falsetrue (ByPropertyName)
-StartupStartup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.falsetrue (ByPropertyName)
-SwapAmount of SWAP for the container in MB.falsetrue (ByPropertyName)0
-TagsTags of the Container. This is only meta information.falsetrue (ByPropertyName)
-TemplateEnable/disable Template.falsetrue (ByPropertyName)False
-TimezoneTime zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tabfalsetrue (ByPropertyName)
-TtySpecify the number of tty available to the containerfalsetrue (ByPropertyName)0
-UnprivilegedMakes the container run as unprivileged user. (Should not be modified manually.)falsetrue (ByPropertyName)False
-UnusedNReference to unused volumes. This is used internally, and should not be modified manually.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NameAlias name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-RenameRename an existing alias.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NameIP set name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-Nomatch--falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesLxcFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [-Dhcp] [[-Digest] <String>] [-Enable] [-Ipfilter] [[-LogLevelIn] <String>] [[-LogLevelOut] <String>] [-Macfilter] [-Ndp] [-Node] <String> [[-PolicyIn] <String>] [[-PolicyOut] <String>] [-Radv] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DhcpEnable DHCP.falsetrue (ByPropertyName)False
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-EnableEnable/disable firewall rules.falsetrue (ByPropertyName)False
-IpfilterEnable default IP filters. This is equivalent to adding an empty ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added.falsetrue (ByPropertyName)False
-LogLevelInLog level for incoming traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-LogLevelOutLog level for outgoing traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-MacfilterEnable/disable MAC address filter.falsetrue (ByPropertyName)False
-NdpEnable NDP (Neighbor Discovery Protocol).falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-PolicyInInput policy. Enum: ACCEPT,REJECT,DROPfalsetrue (ByPropertyName)
-PolicyOutOutput policy. Enum: ACCEPT,REJECT,DROPfalsetrue (ByPropertyName)
-RadvAllow sending Router Advertisement.falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ActionRule action ('ACCEPT', 'DROP', 'REJECT') or security group name.falsetrue (ByPropertyName)
-CommentDescriptive comment.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DestRestrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DportRestrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-EnableFlag to enable/disable a rule.falsetrue (ByPropertyName)0
-IcmpTypeSpecify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.falsetrue (ByPropertyName)
-IfaceNetwork interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.falsetrue (ByPropertyName)
-LogLog level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-MacroUse predefined standard macro.falsetrue (ByPropertyName)
-MovetoMove rule to new position <moveto>. Other arguments are ignored.falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
-ProtoIP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.falsetrue (ByPropertyName)
-SourceRestrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-SportRestrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-TypeRule type. Enum: in,out,groupfalsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesLxcResize [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Disk] <String> [-Node] <String> [-Size] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DiskThe disk you want to resize. Enum: rootfs,mp0,mp1,mp2,mp3,mp4,mp5,mp6,mp7,mp8,mp9,mp10,mp11,mp12,mp13,mp14,mp15,mp16,mp17,mp18,mp19,mp20,mp21,mp22,mp23,mp24,mp25,mp26,mp27,mp28,mp29,mp30,mp31,mp32,mp33,mp34,mp35,mp36,mp37,mp38,mp39,mp40,mp41,mp42,mp43,mp44,mp45,mp46,mp47,mp48,mp49,mp50,mp51,mp52,mp53,mp54,mp55,mp56,mp57,mp58,mp59,mp60,mp61,mp62,mp63,mp64,mp65,mp66,mp67,mp68,mp69,mp70,mp71,mp72,mp73,mp74,mp75,mp76,mp77,mp78,mp79,mp80,mp81,mp82,mp83,mp84,mp85,mp86,mp87,mp88,mp89,mp90,mp91,mp92,mp93,mp94,mp95,mp96,mp97,mp98,mp99,mp100,mp101,mp102,mp103,mp104,mp105,mp106,mp107,mp108,mp109,mp110,mp111,mp112,mp113,mp114,mp115,mp116,mp117,mp118,mp119,mp120,mp121,mp122,mp123,mp124,mp125,mp126,mp127,mp128,mp129,mp130,mp131,mp132,mp133,mp134,mp135,mp136,mp137,mp138,mp139,mp140,mp141,mp142,mp143,mp144,mp145,mp146,mp147,mp148,mp149,mp150,mp151,mp152,mp153,mp154,mp155,mp156,mp157,mp158,mp159,mp160,mp161,mp162,mp163,mp164,mp165,mp166,mp167,mp168,mp169,mp170,mp171,mp172,mp173,mp174,mp175,mp176,mp177,mp178,mp179,mp180,mp181,mp182,mp183,mp184,mp185,mp186,mp187,mp188,mp189,mp190,mp191,mp192,mp193,mp194,mp195,mp196,mp197,mp198,mp199,mp200,mp201,mp202,mp203,mp204,mp205,mp206,mp207,mp208,mp209,mp210,mp211,mp212,mp213,mp214,mp215,mp216,mp217,mp218,mp219,mp220,mp221,mp222,mp223,mp224,mp225,mp226,mp227,mp228,mp229,mp230,mp231,mp232,mp233,mp234,mp235,mp236,mp237,mp238,mp239,mp240,mp241,mp242,mp243,mp244,mp245,mp246,mp247,mp248,mp249,mp250,mp251,mp252,mp253,mp254,mp255truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SizeThe new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesLxcSnapshotConfig [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DescriptionA textual description or comment.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesNetworkIdx [[-PveTicket] <PveTicket>] [[-Address] <String>] [[-Address6] <String>] [-Autostart] [[-BondPrimary] <String>] [[-BondMode] <String>] [[-BondXmitHashPolicy] <String>] [[-BridgePorts] <String>] [-BridgeVlanAware] [[-Cidr] <String>] [[-Cidr6] <String>] [[-Comments] <String>] [[-Comments6] <String>] [[-Delete] <String>] [[-Gateway] <String>] [[-Gateway6] <String>] [-Iface] <String> [[-Mtu] <Int32>] [[-Netmask] <String>] [[-Netmask6] <Int32>] [-Node] <String> [[-OvsBonds] <String>] [[-OvsBridge] <String>] [[-OvsOptions] <String>] [[-OvsPorts] <String>] [[-OvsTag] <Int32>] [[-Slaves] <String>] [-Type] <String> [[-VlanId] <Int32>] [[-VlanRawDevice] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AddressIP address.falsetrue (ByPropertyName)
-Address6IP address.falsetrue (ByPropertyName)
-AutostartAutomatically start interface on boot.falsetrue (ByPropertyName)False
-BondPrimarySpecify the primary interface for active-backup bond.falsetrue (ByPropertyName)
-BondModeBonding mode. Enum: balance-rr,active-backup,balance-xor,broadcast,802.3ad,balance-tlb,balance-alb,balance-slb,lacp-balance-slb,lacp-balance-tcpfalsetrue (ByPropertyName)
-BondXmitHashPolicySelects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. Enum: layer2,layer2+3,layer3+4falsetrue (ByPropertyName)
-BridgePortsSpecify the interfaces you want to add to your bridge.falsetrue (ByPropertyName)
-BridgeVlanAwareEnable bridge vlan support.falsetrue (ByPropertyName)False
-CidrIPv4 CIDR.falsetrue (ByPropertyName)
-Cidr6IPv6 CIDR.falsetrue (ByPropertyName)
-CommentsCommentsfalsetrue (ByPropertyName)
-Comments6Commentsfalsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-GatewayDefault gateway address.falsetrue (ByPropertyName)
-Gateway6Default ipv6 gateway address.falsetrue (ByPropertyName)
-IfaceNetwork interface name.truetrue (ByPropertyName)
-MtuMTU.falsetrue (ByPropertyName)0
-NetmaskNetwork mask.falsetrue (ByPropertyName)
-Netmask6Network mask.falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-OvsBondsSpecify the interfaces used by the bonding device.falsetrue (ByPropertyName)
-OvsBridgeThe OVS bridge associated with a OVS port. This is required when you create an OVS port.falsetrue (ByPropertyName)
-OvsOptionsOVS interface options.falsetrue (ByPropertyName)
-OvsPortsSpecify the interfaces you want to add to your bridge.falsetrue (ByPropertyName)
-OvsTagSpecify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)falsetrue (ByPropertyName)0
-SlavesSpecify the interfaces used by the bonding device.falsetrue (ByPropertyName)
-TypeNetwork interface type Enum: bridge,bond,eth,alias,vlan,OVSBridge,OVSBond,OVSPort,OVSIntPort,unknowntruetrue (ByPropertyName)
-VlanIdvlan-id for a custom named vlan interface (ifupdown2 only).falsetrue (ByPropertyName)0
-VlanRawDeviceSpecify the raw interface for the vlan interface.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesQemuCloudinit [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesQemuConfig [[-PveTicket] <PveTicket>] [-Acpi] [[-Affinity] <String>] [[-Agent] <String>] [[-Arch] <String>] [[-Args_] <String>] [[-Audio0] <String>] [-Autostart] [[-Balloon] <Int32>] [[-Bios] <String>] [[-Boot] <String>] [[-Bootdisk] <String>] [[-Cdrom] <String>] [[-Cicustom] <String>] [[-Cipassword] <SecureString>] [[-Citype] <String>] [-Ciupgrade] [[-Ciuser] <String>] [[-Cores] <Int32>] [[-Cpu] <String>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [[-Efidisk0] <String>] [-Force] [-Freeze] [[-Hookscript] <String>] [[-HostpciN] <Hashtable>] [[-Hotplug] <String>] [[-Hugepages] <String>] [[-IdeN] <Hashtable>] [[-IpconfigN] <Hashtable>] [[-Ivshmem] <String>] [-Keephugepages] [[-Keyboard] <String>] [-Kvm] [-Localtime] [[-Lock] <String>] [[-Machine] <String>] [[-Memory] <String>] [[-MigrateDowntime] <Single>] [[-MigrateSpeed] <Int32>] [[-Name] <String>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Numa] [[-NumaN] <Hashtable>] [-Onboot] [[-Ostype] <String>] [[-ParallelN] <Hashtable>] [-Protection] [-Reboot] [[-Revert] <String>] [[-Rng0] <String>] [[-SataN] <Hashtable>] [[-ScsiN] <Hashtable>] [[-Scsihw] <String>] [[-Searchdomain] <String>] [[-SerialN] <Hashtable>] [[-Shares] <Int32>] [-Skiplock] [[-Smbios1] <String>] [[-Smp] <Int32>] [[-Sockets] <Int32>] [[-SpiceEnhancements] <String>] [[-Sshkeys] <String>] [[-Startdate] <String>] [[-Startup] <String>] [-Tablet] [[-Tags] <String>] [-Tdf] [-Template] [[-Tpmstate0] <String>] [[-UnusedN] <Hashtable>] [[-UsbN] <Hashtable>] [[-Vcpus] <Int32>] [[-Vga] <String>] [[-VirtioN] <Hashtable>] [[-Vmgenid] <String>] [-Vmid] <Int32> [[-Vmstatestorage] <String>] [[-Watchdog] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AcpiEnable/disable ACPI.falsetrue (ByPropertyName)False
-AffinityList of host cores used to execute guest processes, for example':' 0,5,8-11falsetrue (ByPropertyName)
-AgentEnable/disable communication with the QEMU Guest Agent and its properties.falsetrue (ByPropertyName)
-ArchVirtual processor architecture. Defaults to the host. Enum: x86_64,aarch64falsetrue (ByPropertyName)
-Args_Arbitrary arguments passed to kvm.falsetrue (ByPropertyName)
-Audio0Configure a audio device, useful in combination with QXL/Spice.falsetrue (ByPropertyName)
-AutostartAutomatic restart after crash (currently ignored).falsetrue (ByPropertyName)False
-BalloonAmount of target RAM for the VM in MiB. Using zero disables the ballon driver.falsetrue (ByPropertyName)0
-BiosSelect BIOS implementation. Enum: seabios,ovmffalsetrue (ByPropertyName)
-BootSpecify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.falsetrue (ByPropertyName)
-BootdiskEnable booting from specified disk. Deprecated':' Use 'boot':' order=foo;bar' instead.falsetrue (ByPropertyName)
-CdromThis is an alias for option -ide2falsetrue (ByPropertyName)
-Cicustomcloud-init':' Specify custom files to replace the automatically generated ones at start.falsetrue (ByPropertyName)
-Cipasswordcloud-init':' Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.falsetrue (ByPropertyName)
-CitypeSpecifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. Enum: configdrive2,nocloud,opennebulafalsetrue (ByPropertyName)
-Ciupgradecloud-init':' do an automatic package upgrade after the first boot.falsetrue (ByPropertyName)False
-Ciusercloud-init':' User name to change ssh keys and password for instead of the image's configured default user.falsetrue (ByPropertyName)
-CoresThe number of cores per socket.falsetrue (ByPropertyName)0
-CpuEmulated CPU type.falsetrue (ByPropertyName)
-CpulimitLimit of CPU usage.falsetrue (ByPropertyName)0
-CpuunitsCPU weight for a VM, will be clamped to \[1, 10000] in cgroup v2.falsetrue (ByPropertyName)0
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DescriptionDescription for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-Efidisk0Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-ForceForce physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused\[n]', which contains the volume ID. Unlink of unused\[n] always cause physical removal.falsetrue (ByPropertyName)False
-FreezeFreeze CPU at startup (use 'c' monitor command to start execution).falsetrue (ByPropertyName)False
-HookscriptScript that will be executed during various steps in the vms lifetime.falsetrue (ByPropertyName)
-HostpciNMap host PCI devices into guest.falsetrue (ByPropertyName)
-HotplugSelectively enable hotplug features. This is a comma separated list of hotplug features':' 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.falsetrue (ByPropertyName)
-HugepagesEnable/disable hugepages memory. Enum: any,2,1024falsetrue (ByPropertyName)
-IdeNUse volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-IpconfigNcloud-init':' Specify IP addresses and gateways for the corresponding interface.IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicitgateway should be provided.For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requirescloud-init 19.4 or newer.If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to usingdhcp on IPv4.falsetrue (ByPropertyName)
-IvshmemInter-VM shared memory. Useful for direct communication between VMs, or to the host.falsetrue (ByPropertyName)
-KeephugepagesUse together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.falsetrue (ByPropertyName)False
-KeyboardKeyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. Enum: de,de-ch,da,en-gb,en-us,es,fi,fr,fr-be,fr-ca,fr-ch,hu,is,it,ja,lt,mk,nl,no,pl,pt,pt-br,sv,sl,trfalsetrue (ByPropertyName)
-KvmEnable/disable KVM hardware virtualization.falsetrue (ByPropertyName)False
-LocaltimeSet the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.falsetrue (ByPropertyName)False
-LockLock/unlock the VM. Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspendedfalsetrue (ByPropertyName)
-MachineSpecifies the QEMU machine type.falsetrue (ByPropertyName)
-MemoryMemory properties.falsetrue (ByPropertyName)
-MigrateDowntimeSet maximum tolerated downtime (in seconds) for migrations.falsetrue (ByPropertyName)0
-MigrateSpeedSet maximum speed (in MB/s) for migrations. Value 0 is no limit.falsetrue (ByPropertyName)0
-NameSet a name for the VM. Only used on the configuration web interface.falsetrue (ByPropertyName)
-Nameservercloud-init':' Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.falsetrue (ByPropertyName)
-NetNSpecify network devices.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-NumaEnable/disable NUMA.falsetrue (ByPropertyName)False
-NumaNNUMA topology.falsetrue (ByPropertyName)
-OnbootSpecifies whether a VM will be started during system bootup.falsetrue (ByPropertyName)False
-OstypeSpecify guest operating system. Enum: other,wxp,w2k,w2k3,w2k8,wvista,win7,win8,win10,win11,l24,l26,solarisfalsetrue (ByPropertyName)
-ParallelNMap host parallel devices (n is 0 to 2).falsetrue (ByPropertyName)
-ProtectionSets the protection flag of the VM. This will disable the remove VM and remove disk operations.falsetrue (ByPropertyName)False
-RebootAllow reboot. If set to '0' the VM exit on reboot.falsetrue (ByPropertyName)False
-RevertRevert a pending change.falsetrue (ByPropertyName)
-Rng0Configure a VirtIO-based Random Number Generator.falsetrue (ByPropertyName)
-SataNUse volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-ScsiNUse volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-ScsihwSCSI controller model Enum: lsi,lsi53c810,virtio-scsi-pci,virtio-scsi-single,megasas,pvscsifalsetrue (ByPropertyName)
-Searchdomaincloud-init':' Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.falsetrue (ByPropertyName)
-SerialNCreate a serial device inside the VM (n is 0 to 3)falsetrue (ByPropertyName)
-SharesAmount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.falsetrue (ByPropertyName)0
-SkiplockIgnore locks - only root is allowed to use this option.falsetrue (ByPropertyName)False
-Smbios1Specify SMBIOS type 1 fields.falsetrue (ByPropertyName)
-SmpThe number of CPUs. Please use option -sockets instead.falsetrue (ByPropertyName)0
-SocketsThe number of CPU sockets.falsetrue (ByPropertyName)0
-SpiceEnhancementsConfigure additional enhancements for SPICE.falsetrue (ByPropertyName)
-Sshkeyscloud-init':' Setup public SSH keys (one key per line, OpenSSH format).falsetrue (ByPropertyName)
-StartdateSet the initial date of the real time clock. Valid format for date are':''now' or '2006-06-17T16':'01':'21' or '2006-06-17'.falsetrue (ByPropertyName)
-StartupStartup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.falsetrue (ByPropertyName)
-TabletEnable/disable the USB tablet device.falsetrue (ByPropertyName)False
-TagsTags of the VM. This is only meta information.falsetrue (ByPropertyName)
-TdfEnable/disable time drift fix.falsetrue (ByPropertyName)False
-TemplateEnable/disable Template.falsetrue (ByPropertyName)False
-Tpmstate0Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-UnusedNReference to unused volumes. This is used internally, and should not be modified manually.falsetrue (ByPropertyName)
-UsbNConfigure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14).falsetrue (ByPropertyName)
-VcpusNumber of hotplugged vcpus.falsetrue (ByPropertyName)0
-VgaConfigure the VGA hardware.falsetrue (ByPropertyName)
-VirtioNUse volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.falsetrue (ByPropertyName)
-VmgenidSet VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
-VmstatestorageDefault storage for VM state volumes/files.falsetrue (ByPropertyName)
-WatchdogCreate a virtual hardware watchdog device.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NameAlias name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-RenameRename an existing alias.falsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-CidrNetwork/IP specification in CIDR format.truetrue (ByPropertyName)
-Comment--falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-NameIP set name.truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-Nomatch--falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesQemuFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [-Dhcp] [[-Digest] <String>] [-Enable] [-Ipfilter] [[-LogLevelIn] <String>] [[-LogLevelOut] <String>] [-Macfilter] [-Ndp] [-Node] <String> [[-PolicyIn] <String>] [[-PolicyOut] <String>] [-Radv] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DhcpEnable DHCP.falsetrue (ByPropertyName)False
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-EnableEnable/disable firewall rules.falsetrue (ByPropertyName)False
-IpfilterEnable default IP filters. This is equivalent to adding an empty ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added.falsetrue (ByPropertyName)False
-LogLevelInLog level for incoming traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-LogLevelOutLog level for outgoing traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-MacfilterEnable/disable MAC address filter.falsetrue (ByPropertyName)False
-NdpEnable NDP (Neighbor Discovery Protocol).falsetrue (ByPropertyName)False
-NodeThe cluster node name.truetrue (ByPropertyName)
-PolicyInInput policy. Enum: ACCEPT,REJECT,DROPfalsetrue (ByPropertyName)
-PolicyOutOutput policy. Enum: ACCEPT,REJECT,DROPfalsetrue (ByPropertyName)
-RadvAllow sending Router Advertisement.falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-ActionRule action ('ACCEPT', 'DROP', 'REJECT') or security group name.falsetrue (ByPropertyName)
-CommentDescriptive comment.falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DestRestrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DportRestrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-EnableFlag to enable/disable a rule.falsetrue (ByPropertyName)0
-IcmpTypeSpecify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.falsetrue (ByPropertyName)
-IfaceNetwork interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.falsetrue (ByPropertyName)
-LogLog level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nologfalsetrue (ByPropertyName)
-MacroUse predefined standard macro.falsetrue (ByPropertyName)
-MovetoMove rule to new position <moveto>. Other arguments are ignored.falsetrue (ByPropertyName)0
-NodeThe cluster node name.truetrue (ByPropertyName)
-PosUpdate rule at position <pos>.falsetrue (ByPropertyName)0
-ProtoIP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.falsetrue (ByPropertyName)
-SourceRestrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.falsetrue (ByPropertyName)
-SportRestrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.falsetrue (ByPropertyName)
-TypeRule type. Enum: in,out,groupfalsetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesQemuResize [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Disk] <String> [-Node] <String> [-Size] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DiskThe disk you want to resize. Enum: ide0,ide1,ide2,ide3,scsi0,scsi1,scsi2,scsi3,scsi4,scsi5,scsi6,scsi7,scsi8,scsi9,scsi10,scsi11,scsi12,scsi13,scsi14,scsi15,scsi16,scsi17,scsi18,scsi19,scsi20,scsi21,scsi22,scsi23,scsi24,scsi25,scsi26,scsi27,scsi28,scsi29,scsi30,virtio0,virtio1,virtio2,virtio3,virtio4,virtio5,virtio6,virtio7,virtio8,virtio9,virtio10,virtio11,virtio12,virtio13,virtio14,virtio15,sata0,sata1,sata2,sata3,sata4,sata5,efidisk0,tpmstate0truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SizeThe new size. With the `+` sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.truetrue (ByPropertyName)
-SkiplockIgnore locks - only root is allowed to use this option.falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesQemuSendkey [[-PveTicket] <PveTicket>] [-Key] <String> [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-KeyThe key (qemu monitor encoding).truetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SkiplockIgnore locks - only root is allowed to use this option.falsetrue (ByPropertyName)False
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesQemuSnapshotConfig [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-DescriptionA textual description or comment.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByPropertyName)
-VmidThe (unique) ID of the VM.truetrue (ByPropertyName)0
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+ +
+ +
+

Syntax

+
+
+
+ Set-PveNodesStorageContent [[-PveTicket] <PveTicket>] [-Node] <String> [[-Notes] <String>] [-Protected] [[-Storage] <String>] [-Volume] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-NotesThe new notes.falsetrue (ByPropertyName)
-ProtectedProtection status. Currently only supported for backups.falsetrue (ByPropertyName)False
-StorageThe storage identifier.falsetrue (ByPropertyName)
-VolumeVolume identifiertruetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Key] <String> [-Node] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-KeyProxmox VE subscription keytruetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveNodesTime [[-PveTicket] <PveTicket>] [-Node] <String> [-Timezone] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-NodeThe cluster node name.truetrue (ByPropertyName)
-TimezoneTime zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names.truetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PvePools [[-PveTicket] <PveTicket>] [-AllowMove] [[-Comment] <String>] [-Delete] [-Poolid] <String> [[-Storage] <String>] [[-Vms] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AllowMoveAllow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one.falsetrue (ByPropertyName)False
-Comment--falsetrue (ByPropertyName)
-DeleteRemove the passed VMIDs and/or storage IDs instead of adding them.falsetrue (ByPropertyName)False
-Poolid--truetrue (ByPropertyName)
-StorageList of storage IDs to add or remove from this pool.falsetrue (ByPropertyName)
-VmsList of guest VMIDs to add or remove from this pool.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PvePoolsIdx [[-PveTicket] <PveTicket>] [-AllowMove] [[-Comment] <String>] [-Delete] [-Poolid] <String> [[-Storage] <String>] [[-Vms] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-AllowMoveAllow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one.falsetrue (ByPropertyName)False
-Comment--falsetrue (ByPropertyName)
-DeleteRemove the passed VMIDs and/or storage IDs instead of adding them.falsetrue (ByPropertyName)False
-Poolid--truetrue (ByPropertyName)
-StorageList of storage IDs to add or remove from this pool.falsetrue (ByPropertyName)
-VmsList of guest VMIDs to add or remove from this pool.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Set-PveStorage [[-PveTicket] <PveTicket>] [[-Blocksize] <String>] [[-Bwlimit] <String>] [[-ComstarHg] <String>] [[-ComstarTg] <String>] [[-Content] <String>] [[-ContentDirs] <String>] [-CreateBasePath] [-CreateSubdirs] [[-DataPool] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [[-Domain] <String>] [[-EncryptionKey] <String>] [[-Fingerprint] <String>] [[-Format] <String>] [[-FsName] <String>] [-Fuse] [[-IsMountpoint] <String>] [[-Keyring] <String>] [-Krbd] [[-LioTpg] <String>] [[-MasterPubkey] <String>] [[-MaxProtectedBackups] <Int32>] [[-Maxfiles] <Int32>] [-Mkdir] [[-Monhost] <String>] [[-Mountpoint] <String>] [[-Namespace] <String>] [-Nocow] [[-Nodes] <String>] [-Nowritecache] [[-Options] <String>] [[-Password] <SecureString>] [[-Pool] <String>] [[-Port] <Int32>] [[-Preallocation] <String>] [[-PruneBackups] <String>] [-Saferemove] [[-SaferemoveThroughput] <String>] [[-Server] <String>] [[-Server2] <String>] [-Shared] [[-Smbversion] <String>] [-Sparse] [-Storage] <String> [[-Subdir] <String>] [-TaggedOnly] [[-Transport] <String>] [[-Username] <String>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByPropertyName)
-Blocksizeblock sizefalsetrue (ByPropertyName)
-BwlimitSet I/O bandwidth limit for various operations (in KiB/s).falsetrue (ByPropertyName)
-ComstarHghost group for comstar viewsfalsetrue (ByPropertyName)
-ComstarTgtarget group for comstar viewsfalsetrue (ByPropertyName)
-ContentAllowed content types.NOTE':' the value 'rootdir' is used for Containers, and value 'images' for VMs.falsetrue (ByPropertyName)
-ContentDirsOverrides for default content type directories.falsetrue (ByPropertyName)
-CreateBasePathCreate the base directory if it doesn't exist.falsetrue (ByPropertyName)False
-CreateSubdirsPopulate the directory with the default structure.falsetrue (ByPropertyName)False
-DataPoolData Pool (for erasure coding only)falsetrue (ByPropertyName)
-DeleteA list of settings you want to delete.falsetrue (ByPropertyName)
-DigestPrevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.falsetrue (ByPropertyName)
-DisableFlag to disable the storage.falsetrue (ByPropertyName)False
-DomainCIFS domain.falsetrue (ByPropertyName)
-EncryptionKeyEncryption key. Use 'autogen' to generate one automatically without passphrase.falsetrue (ByPropertyName)
-FingerprintCertificate SHA 256 fingerprint.falsetrue (ByPropertyName)
-FormatDefault image format.falsetrue (ByPropertyName)
-FsNameThe Ceph filesystem name.falsetrue (ByPropertyName)
-FuseMount CephFS through FUSE.falsetrue (ByPropertyName)False
-IsMountpointAssume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.falsetrue (ByPropertyName)
-KeyringClient keyring contents (for external clusters).falsetrue (ByPropertyName)
-KrbdAlways access rbd through krbd kernel module.falsetrue (ByPropertyName)False
-LioTpgtarget portal group for Linux LIO targetsfalsetrue (ByPropertyName)
-MasterPubkeyBase64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup.falsetrue (ByPropertyName)
-MaxProtectedBackupsMaximal number of protected backups per guest. Use '-1' for unlimited.falsetrue (ByPropertyName)0
-MaxfilesDeprecated':' use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited.falsetrue (ByPropertyName)0
-MkdirCreate the directory if it doesn't exist and populate it with default sub-dirs. NOTE':' Deprecated, use the 'create-base-path' and 'create-subdirs' options instead.falsetrue (ByPropertyName)False
-MonhostIP addresses of monitors (for external clusters).falsetrue (ByPropertyName)
-Mountpointmount pointfalsetrue (ByPropertyName)
-NamespaceNamespace.falsetrue (ByPropertyName)
-NocowSet the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system.falsetrue (ByPropertyName)False
-NodesList of cluster node names.falsetrue (ByPropertyName)
-Nowritecachedisable write caching on the targetfalsetrue (ByPropertyName)False
-OptionsNFS/CIFS mount options (see 'man nfs' or 'man mount.cifs')falsetrue (ByPropertyName)
-PasswordPassword for accessing the share/datastore.falsetrue (ByPropertyName)
-PoolPool.falsetrue (ByPropertyName)
-PortFor non default port.falsetrue (ByPropertyName)0
-PreallocationPreallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. Enum: off,metadata,falloc,fullfalsetrue (ByPropertyName)
-PruneBackupsThe retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.falsetrue (ByPropertyName)
-SaferemoveZero-out data when removing LVs.falsetrue (ByPropertyName)False
-SaferemoveThroughputWipe throughput (cstream -t parameter value).falsetrue (ByPropertyName)
-ServerServer IP or DNS name.falsetrue (ByPropertyName)
-Server2Backup volfile server IP or DNS name.falsetrue (ByPropertyName)
-SharedMark storage as shared.falsetrue (ByPropertyName)False
-SmbversionSMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. Enum: default,2.0,2.1,3,3.0,3.11falsetrue (ByPropertyName)
-Sparseuse sparse volumesfalsetrue (ByPropertyName)False
-StorageThe storage identifier.truetrue (ByPropertyName)
-SubdirSubdir to mount.falsetrue (ByPropertyName)
-TaggedOnlyOnly use logical volumes tagged with 'pve-vm-ID'.falsetrue (ByPropertyName)False
-TransportGluster transport':' tcp or rdma Enum: tcp,rdma,unixfalsetrue (ByPropertyName)
-UsernameRBD Id.falsetrue (ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Start-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-VmIdOrNameThe (unique) ID or Name of the VM.truetrue (ByValue, ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Stop-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-VmIdOrNameThe (unique) ID or Name of the VM.truetrue (ByValue, ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Suspend-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-VmIdOrNameThe (unique) ID or Name of the VM.truetrue (ByValue, ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Undo-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Snapname] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-VmIdOrNameThe (unique) ID or Name of the VM.truetrue (ByValue, ByPropertyName)
-SnapnameThe name of the snapshot.truetrue (ByValue, ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Syntax

+
+
+
+ Unlock-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-VmIdOrNameThe (unique) ID or Name of the VM.truetrue (ByValue, ByPropertyName)
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • PveResponse. Return response.
+
+
+
+ +
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-VmNonefalsefalse
-VmIdOrNameNonefalsefalse
+
+
+
+ +
+

Syntax

+
+
+
+ Wait-PveTaskIsFinish [[-PveTicket] <PveTicket>] [-Upid] <String> [[-Wait] <Int32>] [[-Timeout] <Int32>] [<CommonParameters>] +
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameAliasDescriptionRequired?Pipeline InputDefault Value
-PveTicketTicket data connection.falsetrue (ByValue, ByPropertyName)
-UpidUpid task e.g UPID:pve1:00004A1A:0964214C:5EECEF11:vzdump:134:root@pam:truetrue (ByValue, ByPropertyName)
-WaitMillisecond wait next checkfalsetrue (ByValue, ByPropertyName)500
-TimeoutMillisecond timeoutfalsetrue (ByValue, ByPropertyName)10000
+
+
+

Outputs

+

The output type is the type of the objects that the cmdlet emits.

+
  • Bool. Return tas is running.
+
+
+