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

📙 Documentation

Documentation

Tutorial

Tutorial interactive in VSCode notebook

Video

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

New-PveNodesVzdump [[-PveTicket] <PveTicket>] [-All] [[-Bwlimit] <Int32>] [[-Compress] <String>] [[-Dumpdir] <String>] [[-Exclude] <String>] [[-ExcludePath] <Array>] [[-Fleecing] <String>] [[-Ionice] <Int32>] [[-JobId] <String>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <String>] [[-NotificationMode] <String>] [[-NotificationPolicy] <String>] [[-NotificationTarget] <String>] [[-PbsChangeDetectionMode] <String>] [[-Performance] <String>] [[-Pigz] <Int32>] [[-Pool] <String>] [-Protected] [[-PruneBackups] <String>] [-Quiet] [-Remove] [[-Script] <String>] [-Stdexcludes] [-Stdout] [-Stop] [[-Stopwait] <Int32>] [[-Storage] <String>] [[-Tmpdir] <String>] [[-Vmid] <String>] [[-Zstd] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-All Backup all known guest systems on this host. false true (ByPropertyName) False
-Bwlimit Limit I/O bandwidth (in KiB/s). false true (ByPropertyName) 0
-Compress Compress dump file. Enum: 0,1,gzip,lzo,zstd false true (ByPropertyName)
-Dumpdir Store resulting files to specified directory. false true (ByPropertyName)
-Exclude Exclude specified guest systems (assumes --all) false true (ByPropertyName)
-ExcludePath Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. false true (ByPropertyName)
-Fleecing Options for backup fleecing (VM only). false true (ByPropertyName)
-Ionice Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. false true (ByPropertyName) 0
-JobId The ID of the backup job. If set, the 'backup-job' metadata field of the backup notification will be set to this value. Only root@pam can set this parameter. false true (ByPropertyName)
-Lockwait Maximal time to wait for the global lock (minutes). false true (ByPropertyName) 0
-Mailnotification Deprecated':' use notification targets/matchers instead. Specify when to send a notification mail Enum: always,failure false true (ByPropertyName)
-Mailto Deprecated':' Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications. false true (ByPropertyName)
-Maxfiles Deprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system. false true (ByPropertyName) 0
-Mode Backup mode. Enum: snapshot,suspend,stop false true (ByPropertyName)
-Node Only run if executed on this node. false true (ByPropertyName)
-NotesTemplate Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. false true (ByPropertyName)
-NotificationMode Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. Enum: auto,legacy-sendmail,notification-system false true (ByPropertyName)
-NotificationPolicy Deprecated':' Do not use Enum: always,failure,never false true (ByPropertyName)
-NotificationTarget Deprecated':' Do not use false true (ByPropertyName)
-PbsChangeDetectionMode PBS mode used to detect file changes and switch encoding format for container backups. Enum: legacy,data,metadata false true (ByPropertyName)
-Performance Other performance-related settings. false true (ByPropertyName)
-Pigz Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. false true (ByPropertyName) 0
-Pool Backup all known guest systems included in the specified pool. false true (ByPropertyName)
-Protected If true, mark backup(s) as protected. false true (ByPropertyName) False
-PruneBackups Use these retention options instead of those from the storage configuration. false true (ByPropertyName)
-Quiet Be quiet. false true (ByPropertyName) False
-Remove Prune older backups according to 'prune-backups'. false true (ByPropertyName) False
-Script Use specified hook script. false true (ByPropertyName)
-Stdexcludes Exclude temporary files and logs. false true (ByPropertyName) False
-Stdout Write tar to stdout, not to a file. false true (ByPropertyName) False
-Stop Stop running backup jobs on this host. false true (ByPropertyName) False
-Stopwait Maximal time to wait until a guest system is stopped (minutes). false true (ByPropertyName) 0
-Storage Store resulting file to this storage. false true (ByPropertyName)
-Tmpdir Store temporary files to specified directory. false true (ByPropertyName)
-Vmid The ID of the guest system you want to backup. false true (ByPropertyName)
-Zstd Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-TemplateFile Template file for generation documentation false false https://raw.githubusercontent.com/corsinvest/cv4pve-api-powershell/master/help-out-html.ps1
-OutputFile Output file true false

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

Name Alias Description Required? Pipeline Input Default Value
-HostsAndPorts Host and portsFormat 10.1.1.90:8006,10.1.1.91:8006,10.1.1.92:8006. true true (ByValue, ByPropertyName)
-Credentials Username and password, username formatted as user@pam, user@pve, user@yourdomain or user (default domain pam). false false
-ApiToken Api Token format USER@REALM!TOKENID=UUID false false
-Otp One-time password for Two-factor authentication. false false
-SkipCertificateCheck Skips certificate validation checks. false false False
-SkipRefreshPveTicketLast Skip refresh PveTicket Last global variable false false False

Outputs

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

  • PveTicket. Return ticket connection.

Examples

EXAMPLE 1 $PveTicket = Connect-PveCluster -HostsAndPorts 192.168.128.115 -Credentials (Get-Credential -Username 'root').

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Time Unix Time true false 0

Outputs

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

  • DateTime. Return DateTime from Unix Time.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Date Date time true true (ByValue)

Outputs

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

  • [Int32]. Return Unix Time.

Syntax

New-PveNodesLxcClone [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [[-Description] <String>] [-Full] [[-Hostname] <String>] [-Newid] <Int32> [-Node] <String> [[-Pool] <String>] [[-Snapname] <String>] [[-Storage] <String>] [[-Target] <String>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Bwlimit Override I/O bandwidth limit (in KiB/s). false true (ByPropertyName) 0
-Description Description for the new CT. false true (ByPropertyName)
-Full Create a full copy of all disks. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default. false true (ByPropertyName) False
-Hostname Set a hostname for the new CT. false true (ByPropertyName)
-Newid VMID for the clone. true true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Pool Add the new CT to the specified pool. false true (ByPropertyName)
-Snapname The name of the snapshot. false true (ByPropertyName)
-Storage Target storage for full clone. false true (ByPropertyName)
-Target Target node. Only allowed if the original VM is on shared storage. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuClone [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [[-Description] <String>] [[-Format] <String>] [-Full] [[-Name] <String>] [-Newid] <Int32> [-Node] <String> [[-Pool] <String>] [[-Snapname] <String>] [[-Storage] <String>] [[-Target] <String>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Bwlimit Override I/O bandwidth limit (in KiB/s). false true (ByPropertyName) 0
-Description Description for the new VM. false true (ByPropertyName)
-Format Target format for file storage. Only valid for full clone. Enum: raw,qcow2,vmdk false true (ByPropertyName)
-Full Create a full copy of all disks. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default. false true (ByPropertyName) False
-Name Set a name for the new VM. false true (ByPropertyName)
-Newid VMID for the clone. true true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Pool Add the new VM to the specified pool. false true (ByPropertyName)
-Snapname The name of the snapshot. false true (ByPropertyName)
-Storage Target storage for full clone. false true (ByPropertyName)
-Target Target node. Only allowed if the original VM is on shared storage. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Description A textual description or comment. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [-Vmstate] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Description A textual description or comment. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0
-Vmstate Save the vmstate false true (ByPropertyName) False

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Realm Authentication domain ID true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Groupid -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Path Only dump this specific path, not the whole tree. false true (ByPropertyName)
-Userid User ID or full API token ID false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Roleid -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id A TFA entry id. true true (ByPropertyName)
-Userid Full User ID, in the `name@realm` format. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Enabled Optional filter for enable property. false true (ByPropertyName) False
-Full Include group and token information. false true (ByPropertyName) False

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Userid Full User ID, in the `name@realm` format. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Multiple Request all entries as an array. false true (ByPropertyName) False
-Userid Full User ID, in the `name@realm` format. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Userid Full User ID, in the `name@realm` format. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Tokenid User-specific token identifier. true true (ByPropertyName)
-Userid Full User ID, in the `name@realm` format. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name ACME account config file name. false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Directory URL of ACME CA directory endpoint. false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Type Only list ACME plugins of a specific type Enum: dns,standalone false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id Unique identifier for ACME plugin instance. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Directory URL of ACME CA directory endpoint. false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id The job ID. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id The job ID. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Flag The name of the flag name to get. Enum: nobackfill,nodeep-scrub,nodown,noin,noout,norebalance,norecover,noscrub,notieragent,noup,pause true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Scope -- Enum: all,versions false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The node for which the joinee gets the nodeinfo. false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name Alias name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Group Security Group name. true true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Name IP set name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Type Only list references of specified type. Enum: alias,ipset false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Group The HA group identifier. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Type Only list resources of specific type Enum: ct,vm false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Sid HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100). true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Iterations Number of event-iteration to simulate and return. false true (ByPropertyName) 0
-Schedule Job schedule. The format is a subset of `systemd` calendar events. true true (ByPropertyName)
-Starttime UNIX timestamp to start the calculation from. Defaults to the current time. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Max Maximum number of entries. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-CheckNode If given, checks the configurations on the given node for correctness, and adds relevant diagnostics for the devices to the response. false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-CheckNode If given, checks the configurations on the given node for correctness, and adds relevant errors to the devices. false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveClusterMetricsExport [[-PveTicket] <PveTicket>] [-History] [-LocalOnly] [[-StartTime] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-History Also return historic values. Returns full available metric history unless `start-time` is also set false true (ByPropertyName) False
-LocalOnly Only return metrics for the current node instead of the whole cluster false true (ByPropertyName) False
-StartTime Only include metrics with a timestamp > start-time. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name Name of the endpoint. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name -- true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveClusterNotificationsEndpointsWebhook [[-PveTicket] <PveTicket>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveClusterNotificationsEndpointsWebhookIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name Name of the endpoint. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveClusterNotificationsMatcherFields [[-PveTicket] <PveTicket>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveClusterNotificationsMatcherFieldValues [[-PveTicket] <PveTicket>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Type Resource type. Enum: vm,storage,node,sdn false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Pending Display pending config. false true (ByPropertyName) False
-Running Display running config. false true (ByPropertyName) False
-Type Only list sdn controllers of specific type Enum: bgp,evpn,faucet,isis false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Controller The SDN controller object identifier. true true (ByPropertyName)
-Pending Display pending config. false true (ByPropertyName) False
-Running Display running config. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Type Only list sdn dns of specific type Enum: powerdns false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Dns The SDN dns object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Type Only list sdn ipams of specific type Enum: netbox,phpipam,pve false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Ipam The SDN ipam object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Ipam The SDN ipam object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Pending Display pending config. false true (ByPropertyName) False
-Running Display running config. false true (ByPropertyName) False

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveClusterSdnVnetsFirewall [[-PveTicket] <PveTicket>] [-Vnet] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Vnet The SDN vnet object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveClusterSdnVnetsFirewallOptions [[-PveTicket] <PveTicket>] [-Vnet] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Vnet The SDN vnet object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveClusterSdnVnetsFirewallRules [[-PveTicket] <PveTicket>] [-Vnet] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Vnet The SDN vnet object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveClusterSdnVnetsFirewallRulesIdx [[-PveTicket] <PveTicket>] [[-Pos] <Int32>] [-Vnet] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Vnet The SDN vnet object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Pending Display pending config. false true (ByPropertyName) False
-Running Display running config. false true (ByPropertyName) False
-Vnet The SDN vnet object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Pending Display pending config. false true (ByPropertyName) False
-Running Display running config. false true (ByPropertyName) False
-Vnet The SDN vnet object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Pending Display pending config. false true (ByPropertyName) False
-Running Display running config. false true (ByPropertyName) False
-Subnet The SDN subnet object identifier. true true (ByPropertyName)
-Vnet The SDN vnet object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Pending Display pending config. false true (ByPropertyName) False
-Running Display running config. false true (ByPropertyName) False
-Type Only list SDN zones of specific type Enum: evpn,faucet,qinq,simple,vlan,vxlan false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Pending Display pending config. false true (ByPropertyName) False
-Running Display running config. false true (ByPropertyName) False
-Zone The SDN zone object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Current Get current values (instead of pending values). false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Snapshot Fetch config values from given snapshot. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByValue, ByPropertyName)
-Node The Name of the node. false true (ByValue, ByPropertyName)

Outputs

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

  • PSCustomObject. Return Node/s data.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name Package name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Version Package version. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-ConfigKeys List of <section>':'<config key> items. true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Action Action to check Enum: stop,destroy true true (ByPropertyName)
-Id ID of the service true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Service Service type Enum: osd,mon,mds true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Limit -- false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Start -- false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Osdid OSD ID true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Osdid OSD ID true true (ByPropertyName) 0
-Type OSD device type Enum: block,db,wal false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Osdid OSD ID true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name The name of the pool. true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name The name of the pool. It must be unique. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Verbose_ If enabled, will display additional data(eg. statistics). false true (ByPropertyName) False

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Property Return only a specific property from the node configuration. Enum: acme,acmedomain0,acmedomain1,acmedomain2,acmedomain3,acmedomain4,acmedomain5,description,startall-onboot-delay,wakeonlan false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-IncludePartitions Also include partitions. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Skipsmart Skip smart checks. false true (ByPropertyName) False
-Type Only list specific types of disks. Enum: unused,journal_disks false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Disk Block device name true true (ByPropertyName)
-Healthonly If true returns only the health status false true (ByPropertyName) False
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name The storage identifier. true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Limit -- false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Since Display log since this UNIX epoch. false true (ByPropertyName) 0
-Start -- false true (ByPropertyName) 0
-Until Display log until this UNIX epoch. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-PciClassBlacklist A list of blacklisted PCI classes, which will not be returned. Following are filtered by default':' Memory Controller (05), Bridge (06) and Processor (0b). false true (ByPropertyName)
-Verbose_ If disabled, does only print the PCI IDs. Otherwise, additional information like vendor and device will be returned. false true (ByPropertyName) False

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesHardwarePciIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-PciIdOrMapping] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-PciIdOrMapping -- true true (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> [-PciIdOrMapping] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-PciIdOrMapping The PCI ID or mapping to list the mdev types for. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Endcursor End before the given Cursor. Conflicts with 'until' false true (ByPropertyName)
-Lastentries Limit to the last X lines. Conflicts with a range. false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Since Display all log since this UNIX epoch. Conflicts with 'startcursor'. false true (ByPropertyName) 0
-Startcursor Start after the given Cursor. Conflicts with 'since' false true (ByPropertyName)
-Until Display all log until this UNIX epoch. Conflicts with 'endcursor'. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Aliases

  • Get-PveLxcConfig

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Current Get current values (instead of pending values). false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Snapshot Fetch config values from given snapshot. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Feature Feature to check. Enum: snapshot,clone,copy true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name Alias name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Name IP set name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Limit -- false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Since Display log since this UNIX epoch. false true (ByPropertyName) 0
-Start -- false true (ByPropertyName) 0
-Until Display log until this UNIX epoch. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Type Only list references of specified type. Enum: alias,ipset false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Socket unix socket to forward to true true (ByPropertyName)
-Ticket ticket return by initial 'mtunnel' API call, or retrieved via 'ticket' tunnel command true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cf The RRD consolidation function Enum: AVERAGE,MAX false true (ByPropertyName)
-Ds The list of datasources you want to display. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Timeframe Specify the time frame you are interested in. Enum: hour,day,week,month,year true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cf The RRD consolidation function Enum: AVERAGE,MAX false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Timeframe Specify the time frame you are interested in. Enum: hour,day,week,month,year true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Get-PveLxcSnapshot

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Get-PveLxcSnapshotConfig

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Port Port number returned by previous vncproxy call. true true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0
-Vncticket Ticket from previous call to vncproxy. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Type Only list specific interface types. Enum: bridge,bond,eth,alias,vlan,OVSBridge,OVSBond,OVSPort,OVSIntPort,any_bridge,any_local_bridge false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesNetworkIdx [[-PveTicket] <PveTicket>] [-Iface] <String> [-Node] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Iface Network interface name. true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Full Determine the full status of active VMs. false true (ByPropertyName) False
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesQemuAgentExecStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Pid_] <Int32> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Pid_ The PID to query true true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesQemuAgentFileRead [[-PveTicket] <PveTicket>] [-File] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-File The path to the file true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Type Config type. Enum: user,network,meta true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Get-PveQemuConfig

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Current Get current values (instead of pending values). false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Snapshot Fetch config values from given snapshot. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Feature Feature to check. Enum: snapshot,clone,copy true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name Alias name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Name IP set name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Limit -- false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Since Display log since this UNIX epoch. false true (ByPropertyName) 0
-Start -- false true (ByPropertyName) 0
-Until Display log until this UNIX epoch. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Type Only list references of specified type. Enum: alias,ipset false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesQemuMigrate [[-PveTicket] <PveTicket>] [-Node] <String> [[-Target] <String>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Target Target node. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Socket unix socket to forward to true true (ByPropertyName)
-Ticket ticket return by initial 'mtunnel' API call, or retrieved via 'ticket' tunnel command true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cf The RRD consolidation function Enum: AVERAGE,MAX false true (ByPropertyName)
-Ds The list of datasources you want to display. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Timeframe Specify the time frame you are interested in. Enum: hour,day,week,month,year true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cf The RRD consolidation function Enum: AVERAGE,MAX false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Timeframe Specify the time frame you are interested in. Enum: hour,day,week,month,year true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Get-PveQemuSnapshot

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Get-PveQemuSnapshotConfig

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Port Port number returned by previous vncproxy call. true true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0
-Vncticket Ticket from previous call to vncproxy. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesQueryUrlMetadata [[-PveTicket] <PveTicket>] [-Node] <String> [-Url] <String> [-VerifyCertificates] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Url The URL to query the metadata from. true true (ByPropertyName)
-VerifyCertificates If false, no SSL/TLS certificates will be verified. false true (ByPropertyName) False

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesReplication [[-PveTicket] <PveTicket>] [[-Guest] <Int32>] [-Node] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Guest Only list replication jobs for this guest. false true (ByPropertyName) 0
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. true true (ByPropertyName)
-Limit -- false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Start -- false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cf The RRD consolidation function Enum: AVERAGE,MAX false true (ByPropertyName)
-Ds The list of datasources you want to display. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Timeframe Specify the time frame you are interested in. Enum: hour,day,week,month,year true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Timeframe] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cf The RRD consolidation function Enum: AVERAGE,MAX false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Timeframe Specify the time frame you are interested in. Enum: hour,day,week,month,year true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesScan [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Domain SMB domain (Workgroup). false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Password User password. false true (ByPropertyName)
-Server The server address (name or IP). true true (ByPropertyName)
-Username User name. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Server The server address (name or IP). true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesScanIscsi [[-PveTicket] <PveTicket>] [-Node] <String> [-Portal] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Portal The iSCSI portal (IP or DNS name with optional port). true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesScanLvm [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vg -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Server The server address (name or IP). true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesScanPbs [[-PveTicket] <PveTicket>] [[-Fingerprint] <String>] [-Node] <String> [-Password] <SecureString> [[-Port] <Int32>] [-Server] <String> [-Username] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Fingerprint Certificate SHA 256 fingerprint. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Password User password or API token secret. true true (ByPropertyName)
-Port Optional port. false true (ByPropertyName) 0
-Server The server address (name or IP). true true (ByPropertyName)
-Username User-name or API token-ID. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesScanZfs [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Zone The SDN zone object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesSdnZonesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Zone] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Zone The SDN zone object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesServices [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Service Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesServicesState [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Service Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesStatus [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Content Only list stores which support this content type. false true (ByPropertyName)
-Enabled Only list stores which are enabled (not disabled in config). false true (ByPropertyName) False
-Format Include information about formats false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Storage Only list status for specified storage false true (ByPropertyName)
-Target If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node. false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesStorageContent [[-PveTicket] <PveTicket>] [[-Content] <String>] [-Node] <String> [-Storage] <String> [[-Vmid] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Content Only list content of this type. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Storage The storage identifier. true true (ByPropertyName)
-Vmid Only list images for this VM false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesStorageContentIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Storage] <String>] [-Volume] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Storage The storage identifier. false true (ByPropertyName)
-Volume Volume identifier true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Storage The storage identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesStorageImportMetadata [[-PveTicket] <PveTicket>] [-Node] <String> [-Storage] <String> [-Volume] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Storage The storage identifier. true true (ByPropertyName)
-Volume Volume identifier for the guest archive/entry. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesStoragePrunebackups [[-PveTicket] <PveTicket>] [-Node] <String> [[-PruneBackups] <String>] [-Storage] <String> [[-Type] <String>] [[-Vmid] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-PruneBackups Use these retention options instead of those from the storage configuration. false true (ByPropertyName)
-Storage The storage identifier. true true (ByPropertyName)
-Type Either 'qemu' or 'lxc'. Only consider backups for guests of this type. Enum: qemu,lxc false true (ByPropertyName)
-Vmid Only consider backups for this guest. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesStorageRrd [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Ds] <String> [-Node] <String> [-Storage] <String> [-Timeframe] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cf The RRD consolidation function Enum: AVERAGE,MAX false true (ByPropertyName)
-Ds The list of datasources you want to display. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Storage The storage identifier. true true (ByPropertyName)
-Timeframe Specify the time frame you are interested in. Enum: hour,day,week,month,year true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesStorageRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Storage] <String> [-Timeframe] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cf The RRD consolidation function Enum: AVERAGE,MAX false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Storage The storage identifier. true true (ByPropertyName)
-Timeframe Specify the time frame you are interested in. Enum: hour,day,week,month,year true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesStorageStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Storage] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Storage The storage identifier. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Limit -- false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Service Service ID false true (ByPropertyName)
-Since Display all log since this date-time string. false true (ByPropertyName)
-Start -- false true (ByPropertyName) 0
-Until Display all log until this date-time string. false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesTasks [[-PveTicket] <PveTicket>] [-Errors] [[-Limit] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Source] <String>] [[-Start] <Int32>] [[-Statusfilter] <String>] [[-Typefilter] <String>] [[-Until] <Int32>] [[-Userfilter] <String>] [[-Vmid] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Errors Only list tasks with a status of ERROR. false true (ByPropertyName) False
-Limit Only list this amount of tasks. false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Since Only list tasks since this UNIX epoch. false true (ByPropertyName) 0
-Source List archived, active or all tasks. Enum: archive,active,all false true (ByPropertyName)
-Start List tasks beginning from this offset. false true (ByPropertyName) 0
-Statusfilter List of Task States that should be returned. false true (ByPropertyName)
-Typefilter Only list tasks of this type (e.g., vzstart, vzdump). false true (ByPropertyName)
-Until Only list tasks until this UNIX epoch. false true (ByPropertyName) 0
-Userfilter Only list tasks from this user. false true (ByPropertyName)
-Vmid Only list tasks for this VM. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesTasksIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Upid -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Download Whether the tasklog file should be downloaded. This parameter can't be used in conjunction with other parameters false true (ByPropertyName) False
-Limit The amount of lines to read from the tasklog. false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Start Start at this line when reading the tasklog false true (ByPropertyName) 0
-Upid The task's unique ID. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Aliases

  • Get-PveTasksStatus

Syntax

Get-PveNodesTasksStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Upid The task's unique ID. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesTime [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Port Port number returned by previous vncproxy call. true true (ByPropertyName) 0
-Vncticket Ticket from previous call to vncproxy. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveNodesVzdumpDefaults [[-PveTicket] <PveTicket>] [-Node] <String> [[-Storage] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Storage The storage identifier. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Volume Volume identifier true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Poolid -- false true (ByPropertyName)
-Type -- Enum: qemu,lxc,storage false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Poolid -- true true (ByPropertyName)
-Type -- Enum: qemu,lxc,storage false true (ByPropertyName)

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Current Get current values (instead of pending values). false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Snapshot Fetch config values from given snapshot. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveStorage [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Type Only list storage of specific type Enum: btrfs,cephfs,cifs,dir,esxi,glusterfs,iscsi,iscsidirect,lvm,lvmthin,nfs,pbs,rbd,zfs,zfspool false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveStorageIdx [[-PveTicket] <PveTicket>] [-Storage] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Storage The storage identifier. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByValue, ByPropertyName)
-Upid Upid task e.g UPID:pve1:00004A1A:0964214C:5EECEF11:vzdump:134:root@pam: true true (ByValue, ByPropertyName)

Outputs

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

  • Bool. Return tas is running.

Syntax

Get-PveNodesTasksStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Upid The task's unique ID. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Get-PveVersion [[-PveTicket] <PveTicket>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByValue, ByPropertyName)
-VmIdOrName The id or name VM/CT comma separated (eg. 100,101,102,TestDebian)-vmid or -name exclude (e.g. -200,-TestUbuntu)range 100:107,-105,200:204'@pool-???' for all VM/CT in specific pool (e.g. @pool-customer1),'@tag-???' for all VM/CT in specific tags (e.g. @tag-customerA),'@node-???' for all VM/CT in specific node (e.g. @node-pve1, @node-\$(hostname)),'@all-???' for all VM/CT in specific host (e.g. @all-pve1, @all-\$(hostname)),'@all' for all VM/CT in cluster"; false true (ByValue, ByPropertyName)

Outputs

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

  • PSCustomObject. Return Vm/s data.

Syntax

Get-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByValue, ByPropertyName)
-VmIdOrName The (unique) ID or Name of the VM. true true (ByValue, ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Invoke-PveRestApi [[-PveTicket] <PveTicket>] [-Resource] <String> [[-Method] <String>] [[-ResponseType] <String>] [[-Parameters] <Hashtable>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data false true (ByValue, ByPropertyName)
-Resource Resource Request true false
-Method Method request false false Get
-ResponseType Type request false false json
-Parameters Parameters request false false

Outputs

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

  • Return object request

Note

This must be used before any other cmdlets are used

Examples

EXAMPLE 1 $PveTicket = Connect-PveCluster -HostsAndPorts '192.168.128.115' -Credentials (Get-Credential -Username 'root'). (Invoke-PveRestApi -PveTicket $PveTicket -Method Get -Resource '/version').Resonse.data
data----@{version=5.4; release=15; repoid=d0ec33c6; keyboard=it}

Aliases

  • Show-PveSpice

Syntax

Invoke-PveSpice [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Viewer] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByValue, ByPropertyName)
-VmIdOrName The (unique) ID or Name of the VM. true true (ByValue, ByPropertyName)
-Viewer Path of Spice remove viewer.- Linux /usr/bin/remote-viewer- Windows C:\Program Files\VirtViewer v?.?-???\bin\remote-viewer.exe true true (ByValue, ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Parameters

Name Alias Description Required? Pipeline Input Default Value
-x None false false

Syntax

New-PveNodesLxcMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [-Node] <String> [-Online] [-Restart] [-Target] <String> [[-TargetStorage] <String>] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Bwlimit Override I/O bandwidth limit (in KiB/s). false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Online Use online/live migration. false true (ByPropertyName) False
-Restart Use restart migration false true (ByPropertyName) False
-Target Target node. true true (ByPropertyName)
-TargetStorage Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. false true (ByPropertyName)
-Timeout Timeout in seconds for shutdown for restart migration false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [-Force] [[-MigrationNetwork] <String>] [[-MigrationType] <String>] [-Node] <String> [-Online] [-Target] <String> [[-Targetstorage] <String>] [-Vmid] <Int32> [-WithLocalDisks] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Bwlimit Override I/O bandwidth limit (in KiB/s). false true (ByPropertyName) 0
-Force Allow to migrate VMs which use local devices. Only root may use this option. false true (ByPropertyName) False
-MigrationNetwork CIDR of the (sub) network that is used for migration. false true (ByPropertyName)
-MigrationType Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. Enum: secure,insecure false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Online Use online/live migration if VM is running. Ignored if VM is stopped. false true (ByPropertyName) False
-Target Target node. true true (ByPropertyName)
-Targetstorage Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0
-WithLocalDisks Enable live storage migration for local disk false true (ByPropertyName) False

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveAccessDomains [[-PveTicket] <PveTicket>] [[-AcrValues] <String>] [-Autocreate] [[-BaseDn] <String>] [[-BindDn] <String>] [[-Capath] <String>] [-CaseSensitive] [[-Cert] <String>] [[-Certkey] <String>] [-CheckConnection] [[-ClientId] <String>] [[-ClientKey] <String>] [[-Comment] <String>] [-Default] [[-Domain] <String>] [[-Filter] <String>] [[-GroupClasses] <String>] [[-GroupDn] <String>] [[-GroupFilter] <String>] [[-GroupNameAttr] <String>] [[-IssuerUrl] <String>] [[-Mode] <String>] [[-Password] <SecureString>] [[-Port] <Int32>] [[-Prompt] <String>] [-Realm] <String> [[-Scopes] <String>] [-Secure] [[-Server1] <String>] [[-Server2] <String>] [[-Sslversion] <String>] [[-SyncDefaultsOptions] <String>] [[-SyncAttributes] <String>] [[-Tfa] <String>] [-Type] <String> [[-UserAttr] <String>] [[-UserClasses] <String>] [[-UsernameClaim] <String>] [-Verify] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-AcrValues Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. false true (ByPropertyName)
-Autocreate Automatically create users if they do not exist. false true (ByPropertyName) False
-BaseDn LDAP base domain name false true (ByPropertyName)
-BindDn LDAP bind domain name false true (ByPropertyName)
-Capath Path to the CA certificate store false true (ByPropertyName)
-CaseSensitive username is case-sensitive false true (ByPropertyName) False
-Cert Path to the client certificate false true (ByPropertyName)
-Certkey Path to the client certificate key false true (ByPropertyName)
-CheckConnection Check bind connection to the server. false true (ByPropertyName) False
-ClientId OpenID Client ID false true (ByPropertyName)
-ClientKey OpenID Client Key false true (ByPropertyName)
-Comment Description. false true (ByPropertyName)
-Default Use this as default realm false true (ByPropertyName) False
-Domain AD domain name false true (ByPropertyName)
-Filter LDAP filter for user sync. false true (ByPropertyName)
-GroupClasses The objectclasses for groups. false true (ByPropertyName)
-GroupDn LDAP base domain name for group sync. If not set, the base_dn will be used. false true (ByPropertyName)
-GroupFilter LDAP filter for group sync. false true (ByPropertyName)
-GroupNameAttr LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name. false true (ByPropertyName)
-IssuerUrl OpenID Issuer Url false true (ByPropertyName)
-Mode LDAP protocol mode. Enum: ldap,ldaps,ldap+starttls false true (ByPropertyName)
-Password LDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'. false true (ByPropertyName)
-Port Server port. false true (ByPropertyName) 0
-Prompt Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. false true (ByPropertyName)
-Realm Authentication domain ID true true (ByPropertyName)
-Scopes Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. false true (ByPropertyName)
-Secure Use secure LDAPS protocol. DEPRECATED':' use 'mode' instead. false true (ByPropertyName) False
-Server1 Server IP address (or DNS name) false true (ByPropertyName)
-Server2 Fallback Server IP address (or DNS name) false true (ByPropertyName)
-Sslversion LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! Enum: tlsv1,tlsv1_1,tlsv1_2,tlsv1_3 false true (ByPropertyName)
-SyncDefaultsOptions The default options for behavior of synchronizations. false true (ByPropertyName)
-SyncAttributes Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name. false true (ByPropertyName)
-Tfa Use Two-factor authentication. false true (ByPropertyName)
-Type Realm type. Enum: ad,ldap,openid,pam,pve true true (ByPropertyName)
-UserAttr LDAP user attribute name false true (ByPropertyName)
-UserClasses The objectclasses for users. false true (ByPropertyName)
-UsernameClaim OpenID claim used to generate the unique username. false true (ByPropertyName)
-Verify Verify the server's SSL certificate false true (ByPropertyName) False

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveAccessDomainsSync [[-PveTicket] <PveTicket>] [-DryRun] [-EnableNew] [-Full] [-Purge] [-Realm] <String> [[-RemoveVanished] <String>] [[-Scope] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-DryRun If set, does not write anything. false true (ByPropertyName) False
-EnableNew Enable newly synced users immediately. false true (ByPropertyName) False
-Full DEPRECATED':' use 'remove-vanished' instead. If set, uses the LDAP Directory as source of truth, deleting users or groups not returned from the sync and removing all locally modified properties of synced users. If not set, only syncs information which is present in the synced data, and does not delete or modify anything else. false true (ByPropertyName) False
-Purge DEPRECATED':' use 'remove-vanished' instead. Remove ACLs for users or groups which were removed from the config during a sync. false true (ByPropertyName) False
-Realm Authentication domain ID true true (ByPropertyName)
-RemoveVanished A semicolon-seperated list of things to remove when they or the user vanishes during a sync. The following values are possible':' 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default). false true (ByPropertyName)
-Scope Select what to sync. Enum: users,groups,both false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveAccessGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Groupid] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Groupid -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Realm Authentication domain ID true true (ByPropertyName)
-RedirectUrl Redirection Url. The client should set this to the used server url (location.origin). true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveAccessOpenidLogin [[-PveTicket] <PveTicket>] [-Code] <String> [-RedirectUrl] <String> [-State] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Code OpenId authorization code. true true (ByPropertyName)
-RedirectUrl Redirection Url. The client should set this to the used server url (location.origin). true true (ByPropertyName)
-State OpenId state. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Privs -- false true (ByPropertyName)
-Roleid -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Challenge When responding to a u2f challenge':' the original challenge string false true (ByPropertyName)
-Description A description to distinguish multiple entries from one another false true (ByPropertyName)
-Password The current password of the user performing the change. false true (ByPropertyName)
-Totp A totp URI. false true (ByPropertyName)
-Type TFA Entry Type. Enum: totp,u2f,webauthn,recovery,yubico true true (ByPropertyName)
-Userid Full User ID, in the `name@realm` format. true true (ByPropertyName)
-Value The current value for the provided totp URI, or a Webauthn/U2F challenge response false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveAccessTicket [[-PveTicket] <PveTicket>] [-NewFormat] [[-Otp] <String>] [-Password] <SecureString> [[-Path] <String>] [[-Privs] <String>] [[-Realm] <String>] [[-TfaChallenge] <String>] [-Username] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-NewFormat This parameter is now ignored and assumed to be 1. false true (ByPropertyName) False
-Otp One-time password for Two-factor authentication. false true (ByPropertyName)
-Password The secret password. This can also be a valid ticket. true true (ByPropertyName)
-Path Verify ticket, and check if user have access 'privs' on 'path' false true (ByPropertyName)
-Privs Verify ticket, and check if user have access 'privs' on 'path' false true (ByPropertyName)
-Realm You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>. false true (ByPropertyName)
-TfaChallenge The signed TFA challenge string the user wants to respond to. false true (ByPropertyName)
-Username User name true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Email -- false true (ByPropertyName)
-Enable Enable the account (default). You can set this to '0' to disable the account false true (ByPropertyName) False
-Expire Account expiration date (seconds since epoch). '0' means no expiration date. false true (ByPropertyName) 0
-Firstname -- false true (ByPropertyName)
-Groups -- false true (ByPropertyName)
-Keys Keys for two factor auth (yubico). false true (ByPropertyName)
-Lastname -- false true (ByPropertyName)
-Password Initial password. false true (ByPropertyName)
-Userid Full User ID, in the `name@realm` format. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveAccessUsersToken [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Expire] <Int32>] [-Privsep] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Expire API token expiration date (seconds since epoch). '0' means no expiration date. false true (ByPropertyName) 0
-Privsep Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. false true (ByPropertyName) False
-Tokenid User-specific token identifier. true true (ByPropertyName)
-Userid Full User ID, in the `name@realm` format. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [-Contact] <String> [[-Directory] <String>] [[-EabHmacKey] <String>] [[-EabKid] <String>] [[-Name] <String>] [[-TosUrl] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Contact Contact email addresses. true true (ByPropertyName)
-Directory URL of ACME CA directory endpoint. false true (ByPropertyName)
-EabHmacKey HMAC key for External Account Binding. false true (ByPropertyName)
-EabKid Key Identifier for External Account Binding. false true (ByPropertyName)
-Name ACME account config file name. false true (ByPropertyName)
-TosUrl URL of CA TermsOfService - setting this indicates agreement. false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [[-Api] <String>] [[-Data] <String>] [-Disable] [-Id] <String> [[-Nodes] <String>] [-Type] <String> [[-ValidationDelay] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Api API plugin name Enum: 1984hosting,acmedns,acmeproxy,active24,ad,ali,anx,artfiles,arvan,aurora,autodns,aws,azion,azure,bookmyname,bunny,cf,clouddns,cloudns,cn,conoha,constellix,cpanel,curanet,cyon,da,ddnss,desec,df,dgon,dnsexit,dnshome,dnsimple,dnsservices,do,doapi,domeneshop,dp,dpi,dreamhost,duckdns,durabledns,dyn,dynu,dynv6,easydns,edgedns,euserv,exoscale,fornex,freedns,gandi_livedns,gcloud,gcore,gd,geoscaling,googledomains,he,hetzner,hexonet,hostingde,huaweicloud,infoblox,infomaniak,internetbs,inwx,ionos,ipv64,ispconfig,jd,joker,kappernet,kas,kinghost,knot,la,leaseweb,lexicon,linode,linode_v4,loopia,lua,maradns,me,miab,misaka,myapi,mydevil,mydnsjp,mythic_beasts,namecheap,namecom,namesilo,nanelo,nederhost,neodigit,netcup,netlify,nic,njalla,nm,nsd,nsone,nsupdate,nw,oci,one,online,openprovider,openstack,opnsense,ovh,pdns,pleskxml,pointhq,porkbun,rackcorp,rackspace,rage4,rcode0,regru,scaleway,schlundtech,selectel,selfhost,servercow,simply,tele3,tencent,transip,udr,ultra,unoeuro,variomedia,veesp,vercel,vscale,vultr,websupport,world4you,yandex,yc,zilore,zone,zonomi false true (ByPropertyName)
-Data DNS plugin data. (base64 encoded) false true (ByPropertyName)
-Disable Flag to disable the config. false true (ByPropertyName) False
-Id ACME Plugin ID name true true (ByPropertyName)
-Nodes List of cluster node names. false true (ByPropertyName)
-Type ACME challenge type. Enum: dns,standalone true true (ByPropertyName)
-ValidationDelay Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveClusterBackup [[-PveTicket] <PveTicket>] [-All] [[-Bwlimit] <Int32>] [[-Comment] <String>] [[-Compress] <String>] [[-Dow] <String>] [[-Dumpdir] <String>] [-Enabled] [[-Exclude] <String>] [[-ExcludePath] <Array>] [[-Fleecing] <String>] [[-Id] <String>] [[-Ionice] <Int32>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <String>] [[-NotificationMode] <String>] [[-NotificationPolicy] <String>] [[-NotificationTarget] <String>] [[-PbsChangeDetectionMode] <String>] [[-Performance] <String>] [[-Pigz] <Int32>] [[-Pool] <String>] [-Protected] [[-PruneBackups] <String>] [-Quiet] [-Remove] [-RepeatMissed] [[-Schedule] <String>] [[-Script] <String>] [[-Starttime] <String>] [-Stdexcludes] [-Stop] [[-Stopwait] <Int32>] [[-Storage] <String>] [[-Tmpdir] <String>] [[-Vmid] <String>] [[-Zstd] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-All Backup all known guest systems on this host. false true (ByPropertyName) False
-Bwlimit Limit I/O bandwidth (in KiB/s). false true (ByPropertyName) 0
-Comment Description for the Job. false true (ByPropertyName)
-Compress Compress dump file. Enum: 0,1,gzip,lzo,zstd false true (ByPropertyName)
-Dow Day of week selection. false true (ByPropertyName)
-Dumpdir Store resulting files to specified directory. false true (ByPropertyName)
-Enabled Enable or disable the job. false true (ByPropertyName) False
-Exclude Exclude specified guest systems (assumes --all) false true (ByPropertyName)
-ExcludePath Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. false true (ByPropertyName)
-Fleecing Options for backup fleecing (VM only). false true (ByPropertyName)
-Id Job ID (will be autogenerated). false true (ByPropertyName)
-Ionice Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. false true (ByPropertyName) 0
-Lockwait Maximal time to wait for the global lock (minutes). false true (ByPropertyName) 0
-Mailnotification Deprecated':' use notification targets/matchers instead. Specify when to send a notification mail Enum: always,failure false true (ByPropertyName)
-Mailto Deprecated':' Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications. false true (ByPropertyName)
-Maxfiles Deprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system. false true (ByPropertyName) 0
-Mode Backup mode. Enum: snapshot,suspend,stop false true (ByPropertyName)
-Node Only run if executed on this node. false true (ByPropertyName)
-NotesTemplate Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. false true (ByPropertyName)
-NotificationMode Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. Enum: auto,legacy-sendmail,notification-system false true (ByPropertyName)
-NotificationPolicy Deprecated':' Do not use Enum: always,failure,never false true (ByPropertyName)
-NotificationTarget Deprecated':' Do not use false true (ByPropertyName)
-PbsChangeDetectionMode PBS mode used to detect file changes and switch encoding format for container backups. Enum: legacy,data,metadata false true (ByPropertyName)
-Performance Other performance-related settings. false true (ByPropertyName)
-Pigz Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. false true (ByPropertyName) 0
-Pool Backup all known guest systems included in the specified pool. false true (ByPropertyName)
-Protected If true, mark backup(s) as protected. false true (ByPropertyName) False
-PruneBackups Use these retention options instead of those from the storage configuration. false true (ByPropertyName)
-Quiet Be quiet. false true (ByPropertyName) False
-Remove Prune older backups according to 'prune-backups'. false true (ByPropertyName) False
-RepeatMissed If true, the job will be run as soon as possible if it was missed while the scheduler was not running. false true (ByPropertyName) False
-Schedule Backup schedule. The format is a subset of `systemd` calendar events. false true (ByPropertyName)
-Script Use specified hook script. false true (ByPropertyName)
-Starttime Job Start time. false true (ByPropertyName)
-Stdexcludes Exclude temporary files and logs. false true (ByPropertyName) False
-Stop Stop running backup jobs on this host. false true (ByPropertyName) False
-Stopwait Maximal time to wait until a guest system is stopped (minutes). false true (ByPropertyName) 0
-Storage Store resulting file to this storage. false true (ByPropertyName)
-Tmpdir Store temporary files to specified directory. false true (ByPropertyName)
-Vmid The ID of the guest system you want to backup. false true (ByPropertyName)
-Zstd Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveClusterConfig [[-PveTicket] <PveTicket>] [-Clustername] <String> [[-LinkN] <Hashtable>] [[-Nodeid] <Int32>] [[-Votes] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Clustername The name of the cluster. true true (ByPropertyName)
-LinkN Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) false true (ByPropertyName)
-Nodeid Node id for this node. false true (ByPropertyName) 0
-Votes Number of votes for this node. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveClusterConfigJoin [[-PveTicket] <PveTicket>] [-Fingerprint] <String> [-Force] [-Hostname] <String> [[-LinkN] <Hashtable>] [[-Nodeid] <Int32>] [-Password] <SecureString> [[-Votes] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Fingerprint Certificate SHA 256 fingerprint. true true (ByPropertyName)
-Force Do not throw error if node already exists. false true (ByPropertyName) False
-Hostname Hostname (or IP) of an existing cluster member. true true (ByPropertyName)
-LinkN Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) false true (ByPropertyName)
-Nodeid Node id for this node. false true (ByPropertyName) 0
-Password Superuser (root) password of peer node. true true (ByPropertyName)
-Votes Number of votes for this node false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveClusterConfigNodes [[-PveTicket] <PveTicket>] [[-Apiversion] <Int32>] [-Force] [[-LinkN] <Hashtable>] [[-NewNodeIp] <String>] [-Node] <String> [[-Nodeid] <Int32>] [[-Votes] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Apiversion The JOIN_API_VERSION of the new node. false true (ByPropertyName) 0
-Force Do not throw error if node already exists. false true (ByPropertyName) False
-LinkN Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) false true (ByPropertyName)
-NewNodeIp IP Address of node to add. Used as fallback if no links are given. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Nodeid Node id for this node. false true (ByPropertyName) 0
-Votes Number of votes for this node false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Name Alias name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Group Security Group name. true true (ByPropertyName)
-Rename Rename/update an existing security group. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing group. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Action Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. true true (ByPropertyName)
-Comment Descriptive comment. false true (ByPropertyName)
-Dest Restrict 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. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Dport Restrict 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. false true (ByPropertyName)
-Enable Flag to enable/disable a rule. false true (ByPropertyName) 0
-Group Security Group name. true true (ByPropertyName)
-IcmpType Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. false true (ByPropertyName)
-Iface Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. false true (ByPropertyName)
-Log Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-Macro Use predefined standard macro. false true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Proto IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. false true (ByPropertyName)
-Source Restrict 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. false true (ByPropertyName)
-Sport Restrict 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. false true (ByPropertyName)
-Type Rule type. Enum: in,out,forward,group true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Name IP set name. true true (ByPropertyName)
-Rename Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Name IP set name. true true (ByPropertyName)
-Nomatch -- false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Action Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. true true (ByPropertyName)
-Comment Descriptive comment. false true (ByPropertyName)
-Dest Restrict 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. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Dport Restrict 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. false true (ByPropertyName)
-Enable Flag to enable/disable a rule. false true (ByPropertyName) 0
-IcmpType Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. false true (ByPropertyName)
-Iface Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. false true (ByPropertyName)
-Log Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-Macro Use predefined standard macro. false true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Proto IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. false true (ByPropertyName)
-Source Restrict 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. false true (ByPropertyName)
-Sport Restrict 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. false true (ByPropertyName)
-Type Rule type. Enum: in,out,forward,group true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment Description. false true (ByPropertyName)
-Group The HA group identifier. true true (ByPropertyName)
-Nodes List of cluster node names with optional priority. true true (ByPropertyName)
-Nofailback The 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. false true (ByPropertyName) False
-Restricted Resources bound to restricted groups may only run on nodes defined by the group. false true (ByPropertyName) False
-Type Group type. Enum: group false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment Description. false true (ByPropertyName)
-Group The HA group identifier. false true (ByPropertyName)
-MaxRelocate Maximal number of service relocate tries when a service failes to start. false true (ByPropertyName) 0
-MaxRestart Maximal number of tries to restart the service on a node after its start failed. false true (ByPropertyName) 0
-Sid HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100). true true (ByPropertyName)
-State Requested resource state. Enum: started,stopped,enabled,disabled,ignored false true (ByPropertyName)
-Type Resource type. Enum: ct,vm false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node Target node. true true (ByPropertyName)
-Sid HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100). true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveClusterHaResourcesRelocate [[-PveTicket] <PveTicket>] [-Node] <String> [-Sid] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node Target node. true true (ByPropertyName)
-Sid HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100). true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-EnableNew] [-Enabled] [-Id] <String> [[-Realm] <String>] [[-RemoveVanished] <String>] [-Schedule] <String> [[-Scope] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment Description for the Job. false true (ByPropertyName)
-EnableNew Enable newly synced users immediately. false true (ByPropertyName) False
-Enabled Determines if the job is enabled. false true (ByPropertyName) False
-Id The ID of the job. true true (ByPropertyName)
-Realm Authentication domain ID false true (ByPropertyName)
-RemoveVanished A semicolon-seperated list of things to remove when they or the user vanishes during a sync. The following values are possible':' 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default). false true (ByPropertyName)
-Schedule Backup schedule. The format is a subset of `systemd` calendar events. true true (ByPropertyName)
-Scope Select what to sync. Enum: users,groups,both false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveClusterMappingPci [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Id] <String> [-Map] <Array> [-Mdev] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Description Description of the logical PCI device. false true (ByPropertyName)
-Id The ID of the logical PCI mapping. true true (ByPropertyName)
-Map A list of maps for the cluster nodes. true true (ByPropertyName)
-Mdev Marks the device(s) as being capable of providing mediated devices. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Description Description of the logical USB device. false true (ByPropertyName)
-Id The ID of the logical USB mapping. true true (ByPropertyName)
-Map A list of maps for the cluster nodes. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-ApiPathPrefix An API path prefix inserted between '<host>':'<port>/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy. false true (ByPropertyName)
-Bucket The InfluxDB bucket/db. Only necessary when using the http v2 api. false true (ByPropertyName)
-Disable Flag to disable the plugin. false true (ByPropertyName) False
-Id The ID of the entry. true true (ByPropertyName)
-Influxdbproto -- Enum: udp,http,https false true (ByPropertyName)
-MaxBodySize InfluxDB max-body-size in bytes. Requests are batched up to this size. false true (ByPropertyName) 0
-Mtu MTU for metrics transmission over UDP false true (ByPropertyName) 0
-Organization The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api. false true (ByPropertyName)
-Path root graphite path (ex':' proxmox.mycluster.mykey) false true (ByPropertyName)
-Port server network port true true (ByPropertyName) 0
-Proto Protocol to send graphite data. TCP or UDP (default) Enum: udp,tcp false true (ByPropertyName)
-Server server dns name or IP address true true (ByPropertyName)
-Timeout graphite TCP socket timeout (default=1) false true (ByPropertyName) 0
-Token The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user':'password' instead. false true (ByPropertyName)
-Type Plugin type. Enum: graphite,influxdb true true (ByPropertyName)
-VerifyCertificate Set to 0 to disable certificate verification for https endpoints. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment Comment false true (ByPropertyName)
-Disable Disable this target false true (ByPropertyName) False
-Name The name of the endpoint. true true (ByPropertyName)
-Server Server URL true true (ByPropertyName)
-Token Secret token true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Author Author of the mail false true (ByPropertyName)
-Comment Comment false true (ByPropertyName)
-Disable Disable this target false true (ByPropertyName) False
-FromAddress `From` address for the mail false true (ByPropertyName)
-Mailto List of email recipients false true (ByPropertyName)
-MailtoUser List of users false true (ByPropertyName)
-Name The name of the endpoint. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Author Author of the mail. Defaults to 'Proxmox VE'. false true (ByPropertyName)
-Comment Comment false true (ByPropertyName)
-Disable Disable this target false true (ByPropertyName) False
-FromAddress `From` address for the mail true true (ByPropertyName)
-Mailto List of email recipients false true (ByPropertyName)
-MailtoUser List of users false true (ByPropertyName)
-Mode Determine which encryption method shall be used for the connection. Enum: insecure,starttls,tls false true (ByPropertyName)
-Name The name of the endpoint. true true (ByPropertyName)
-Password Password for SMTP authentication false true (ByPropertyName)
-Port The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections. false true (ByPropertyName) 0
-Server The address of the SMTP server. true true (ByPropertyName)
-Username Username for SMTP authentication false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveClusterNotificationsEndpointsWebhook [[-PveTicket] <PveTicket>] [[-Body] <String>] [[-Comment] <String>] [-Disable] [[-Header] <Array>] [-Method] <String> [-Name] <String> [[-Secret] <Array>] [-Url] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Body HTTP body, base64 encoded false true (ByPropertyName)
-Comment Comment false true (ByPropertyName)
-Disable Disable this target false true (ByPropertyName) False
-Header HTTP headers to set. These have to be formatted as a property string in the format name=<name>,value=<base64 of value> false true (ByPropertyName)
-Method HTTP method Enum: post,put,get true true (ByPropertyName)
-Name The name of the endpoint. true true (ByPropertyName)
-Secret Secrets to set. These have to be formatted as a property string in the format name=<name>,value=<base64 of value> false true (ByPropertyName)
-Url Server URL true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment Comment false true (ByPropertyName)
-Disable Disable this matcher false true (ByPropertyName) False
-InvertMatch Invert match of the whole matcher false true (ByPropertyName) False
-MatchCalendar Match notification timestamp false true (ByPropertyName)
-MatchField Metadata fields to match (regex or exact match). Must be in the form (regex|exact)':'<field>=<value> false true (ByPropertyName)
-MatchSeverity Notification severities to match false true (ByPropertyName)
-Mode Choose between 'all' and 'any' for when multiple properties are specified Enum: all,any false true (ByPropertyName)
-Name Name of the matcher. true true (ByPropertyName)
-Target Targets to notify on match false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment Description. false true (ByPropertyName)
-Disable Flag to disable/deactivate the entry. false true (ByPropertyName) False
-Id Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. true true (ByPropertyName)
-Rate Rate limit in mbps (megabytes per second) as floating point number. false true (ByPropertyName) 0
-RemoveJob Mark 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,full false true (ByPropertyName)
-Schedule Storage replication schedule. The format is a subset of `systemd` calendar events. false true (ByPropertyName)
-Source For internal use, to detect if the guest was stolen. false true (ByPropertyName)
-Target Target node. true true (ByPropertyName)
-Type Section type. Enum: local true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Asn autonomous system number false true (ByPropertyName) 0
-BgpMultipathAsPathRelax -- false true (ByPropertyName) False
-Controller The SDN controller object identifier. true true (ByPropertyName)
-Ebgp Enable ebgp. (remote-as external) false true (ByPropertyName) False
-EbgpMultihop -- false true (ByPropertyName) 0
-IsisDomain ISIS domain. false true (ByPropertyName)
-IsisIfaces ISIS interface. false true (ByPropertyName)
-IsisNet ISIS network entity title. false true (ByPropertyName)
-Loopback source loopback interface. false true (ByPropertyName)
-Node The cluster node name. false true (ByPropertyName)
-Peers peers address list. false true (ByPropertyName)
-Type Plugin type. Enum: bgp,evpn,faucet,isis true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Dns The SDN dns object identifier. true true (ByPropertyName)
-Key -- true true (ByPropertyName)
-Reversemaskv6 -- false true (ByPropertyName) 0
-Reversev6mask -- false true (ByPropertyName) 0
-Ttl -- false true (ByPropertyName) 0
-Type Plugin type. Enum: powerdns true true (ByPropertyName)
-Url -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Ipam The SDN ipam object identifier. true true (ByPropertyName)
-Section -- false true (ByPropertyName) 0
-Token -- false true (ByPropertyName)
-Type Plugin type. Enum: netbox,phpipam,pve true true (ByPropertyName)
-Url -- false true (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>] [-IsolatePorts] [[-Tag] <Int32>] [[-Type] <String>] [-Vlanaware] [-Vnet] <String> [-Zone] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Alias alias name of the vnet false true (ByPropertyName)
-IsolatePorts If true, sets the isolated property for all members of this VNet false true (ByPropertyName) False
-Tag vlan or vxlan id false true (ByPropertyName) 0
-Type Type Enum: vnet false true (ByPropertyName)
-Vlanaware Allow vm VLANs to pass through this vnet. false true (ByPropertyName) False
-Vnet The SDN vnet object identifier. true true (ByPropertyName)
-Zone zone id true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveClusterSdnVnetsFirewallRules [[-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> [-Vnet] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Action Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. true true (ByPropertyName)
-Comment Descriptive comment. false true (ByPropertyName)
-Dest Restrict 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. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Dport Restrict 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. false true (ByPropertyName)
-Enable Flag to enable/disable a rule. false true (ByPropertyName) 0
-IcmpType Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. false true (ByPropertyName)
-Iface Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. false true (ByPropertyName)
-Log Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-Macro Use predefined standard macro. false true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Proto IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. false true (ByPropertyName)
-Source Restrict 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. false true (ByPropertyName)
-Sport Restrict 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. false true (ByPropertyName)
-Type Rule type. Enum: in,out,forward,group true true (ByPropertyName)
-Vnet The SDN vnet object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Ip The IP address to associate with the given MAC address true true (ByPropertyName)
-Mac Unicast MAC address. false true (ByPropertyName)
-Vnet The SDN vnet object identifier. true true (ByPropertyName)
-Zone The SDN zone object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [[-DhcpDnsServer] <String>] [[-DhcpRange] <Array>] [[-Dnszoneprefix] <String>] [[-Gateway] <String>] [-Snat] [-Subnet] <String> [-Type] <String> [-Vnet] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-DhcpDnsServer IP address for the DNS server false true (ByPropertyName)
-DhcpRange A list of DHCP ranges for this subnet false true (ByPropertyName)
-Dnszoneprefix dns domain zone prefix ex':' 'adm' -> <hostname>.adm.mydomain.com false true (ByPropertyName)
-Gateway Subnet Gateway':' Will be assign on vnet for layer3 zones false true (ByPropertyName)
-Snat enable masquerade for this subnet if pve-firewall false true (ByPropertyName) False
-Subnet The SDN subnet object identifier. true true (ByPropertyName)
-Type -- Enum: subnet true true (ByPropertyName)
-Vnet associated vnet true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-AdvertiseSubnets Advertise evpn subnets if you have silent hosts false true (ByPropertyName) False
-Bridge -- false true (ByPropertyName)
-BridgeDisableMacLearning Disable auto mac learning. false true (ByPropertyName) False
-Controller Frr router name false true (ByPropertyName)
-Dhcp Type of the DHCP backend for this zone Enum: dnsmasq false true (ByPropertyName)
-DisableArpNdSuppression Disable ipv4 arp && ipv6 neighbour discovery suppression false true (ByPropertyName) False
-Dns dns api server false true (ByPropertyName)
-Dnszone dns domain zone ex':' mydomain.com false true (ByPropertyName)
-DpId Faucet dataplane id false true (ByPropertyName) 0
-Exitnodes List of cluster node names. false true (ByPropertyName)
-ExitnodesLocalRouting Allow exitnodes to connect to evpn guests false true (ByPropertyName) False
-ExitnodesPrimary Force traffic to this exitnode first. false true (ByPropertyName)
-Ipam use a specific ipam false true (ByPropertyName)
-Mac Anycast logical router mac address false true (ByPropertyName)
-Mtu MTU false true (ByPropertyName) 0
-Nodes List of cluster node names. false true (ByPropertyName)
-Peers peers address list. false true (ByPropertyName)
-Reversedns reverse dns api server false true (ByPropertyName)
-RtImport Route-Target import false true (ByPropertyName)
-Tag Service-VLAN Tag false true (ByPropertyName) 0
-Type Plugin type. Enum: evpn,faucet,qinq,simple,vlan,vxlan true true (ByPropertyName)
-VlanProtocol -- Enum: 802.1q,802.1ad false true (ByPropertyName)
-VrfVxlan l3vni. false true (ByPropertyName) 0
-VxlanPort Vxlan tunnel udp port (default 4789). false true (ByPropertyName) 0
-Zone The SDN zone object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Arch OS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64 false true (ByPropertyName)
-Bwlimit Override I/O bandwidth limit (in KiB/s). false true (ByPropertyName) 0
-Cmode Console 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,tty false true (ByPropertyName)
-Console Attach a console device (/dev/console) to the container. false true (ByPropertyName) False
-Cores The number of cores assigned to the container. A container can use all available cores by default. false true (ByPropertyName) 0
-Cpulimit Limit of CPU usage.NOTE':' If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. false true (ByPropertyName) 0
-Cpuunits CPU weight for a container, will be clamped to \[1, 10000] in cgroup v2. false true (ByPropertyName) 0
-Debug_ Try to be more verbose. For now this only enables debug log-level on start. false true (ByPropertyName) False
-Description Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. false true (ByPropertyName)
-DevN Device to pass through to the container false true (ByPropertyName)
-Features Allow containers access to advanced features. false true (ByPropertyName)
-Force Allow to overwrite existing container. false true (ByPropertyName) False
-Hookscript Script that will be executed during various steps in the containers lifetime. false true (ByPropertyName)
-Hostname Set a host name for the container. false true (ByPropertyName)
-IgnoreUnpackErrors Ignore errors when extracting the template. false true (ByPropertyName) False
-Lock Lock/unlock the container. Enum: backup,create,destroyed,disk,fstrim,migrate,mounted,rollback,snapshot,snapshot-delete false true (ByPropertyName)
-Memory Amount of RAM for the container in MB. false true (ByPropertyName) 0
-MpN Use volume as container mount point. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. false true (ByPropertyName)
-Nameserver Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. false true (ByPropertyName)
-NetN Specifies network interfaces for the container. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Onboot Specifies whether a container will be started during system bootup. false true (ByPropertyName) False
-Ostemplate The OS template or backup file. true true (ByPropertyName)
-Ostype OS 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,unmanaged false true (ByPropertyName)
-Password Sets root password inside container. false true (ByPropertyName)
-Pool Add the VM to the specified pool. false true (ByPropertyName)
-Protection Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. false true (ByPropertyName) False
-Restore Mark this as restore task. false true (ByPropertyName) False
-Rootfs Use volume as container root. false true (ByPropertyName)
-Searchdomain Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. false true (ByPropertyName)
-SshPublicKeys Setup public SSH keys (one key per line, OpenSSH format). false true (ByPropertyName)
-Start Start the CT after its creation finished successfully. false true (ByPropertyName) False
-Startup Startup 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. false true (ByPropertyName)
-Storage Default Storage. false true (ByPropertyName)
-Swap Amount of SWAP for the container in MB. false true (ByPropertyName) 0
-Tags Tags of the Container. This is only meta information. false true (ByPropertyName)
-Template Enable/disable Template. false true (ByPropertyName) False
-Timezone Time 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.tab false true (ByPropertyName)
-Tty Specify the number of tty available to the container false true (ByPropertyName) 0
-Unique Assign a unique random ethernet address. false true (ByPropertyName) False
-Unprivileged Makes the container run as unprivileged user. (Should not be modified manually.) false true (ByPropertyName) False
-UnusedN Reference to unused volumes. This is used internally, and should not be modified manually. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesAplinfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Storage] <String> [-Template] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Storage The storage where the template will be stored true true (ByPropertyName)
-Template The template which will downloaded true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Digest Digest to detect modifications. false true (ByPropertyName)
-Enabled Whether the repository should be enabled or not. false true (ByPropertyName) False
-Index Index within the file (starting from 0). true true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Path Path to the containing file. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Notify Send notification about new packages. false true (ByPropertyName) False
-Quiet Only produces output suitable for logging, omitting progress indicators. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-AddStorage Configure the created CephFS as storage for this cluster. false true (ByPropertyName) False
-Name The ceph filesystem name. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-PgNum Number of placement groups for the backing data pool. The metadata pool will use a quarter of this. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-ClusterNetwork Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it false true (ByPropertyName)
-DisableCephx Disable cephx authentication.WARNING':' cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private! false true (ByPropertyName) False
-MinSize Minimum number of available replicas per object to allow I/O false true (ByPropertyName) 0
-Network Use specific network for all ceph related traffic false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-PgBits Placement group bits, used to specify the default number of placement groups.Depreacted. This setting was deprecated in recent Ceph versions. false true (ByPropertyName) 0
-Size Targeted number of replicas per object false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Hotstandby Determines 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. false true (ByPropertyName) False
-Name The ID for the mds, when omitted the same as the nodename false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id The ID for the manager, when omitted the same as the nodename false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-MonAddress Overwrites autodetected monitor IP address(es). Must be in the public network(s) of Ceph. false true (ByPropertyName)
-Monid The ID for the monitor, when omitted the same as the nodename false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-CrushDeviceClass Set the device class of the OSD in crush. false true (ByPropertyName)
-DbDev Block device name for block.db. false true (ByPropertyName)
-DbDevSize Size in GiB for block.db. false true (ByPropertyName) 0
-Dev Block device name. true true (ByPropertyName)
-Encrypted Enables encryption of the OSD. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-OsdsPerDevice OSD services per physical device. Only useful for fast NVMe devices" ." to utilize their performance better. false true (ByPropertyName) 0
-WalDev Block device name for block.wal. false true (ByPropertyName)
-WalDevSize Size in GiB for block.wal. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Osdid OSD ID true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Osdid OSD ID true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Deep If set, instructs a deep scrub instead of a normal one. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Osdid OSD ID true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-AddStorages Configure VM and CT storage using the new pool. false true (ByPropertyName) False
-Application The application of the pool. Enum: rbd,cephfs,rgw false true (ByPropertyName)
-CrushRule The rule to use for mapping object placement in the cluster. false true (ByPropertyName)
-ErasureCoding Create 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. false true (ByPropertyName)
-MinSize Minimum number of replicas per object false true (ByPropertyName) 0
-Name The name of the pool. It must be unique. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-PgAutoscaleMode The automatic PG scaling mode of the pool. Enum: on,off,warn false true (ByPropertyName)
-PgNum Number of placement groups. false true (ByPropertyName) 0
-PgNumMin Minimal number of placement groups. false true (ByPropertyName) 0
-Size Number of replicas per object false true (ByPropertyName) 0
-TargetSize The estimated target size of the pool for the PG autoscaler. false true (ByPropertyName)
-TargetSizeRatio The estimated target ratio of the pool for the PG autoscaler. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Service Ceph service name. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Service Ceph service name. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Service Ceph service name. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Force Overwrite existing custom certificate. false true (ByPropertyName) False
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Certificates PEM encoded certificate (chain). true true (ByPropertyName)
-Force Overwrite existing custom or ACME certificate files. false true (ByPropertyName) False
-Key PEM encoded private key. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Restart Restart pveproxy. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-AddStorage Configure storage using the directory. false true (ByPropertyName) False
-Device The block device you want to create the filesystem on. true true (ByPropertyName)
-Filesystem The desired filesystem. Enum: ext4,xfs false true (ByPropertyName)
-Name The storage identifier. true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Disk Block device name true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Uuid UUID for the GPT table false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-AddStorage Configure storage using the Volume Group false true (ByPropertyName) False
-Device The block device you want to create the volume group on true true (ByPropertyName)
-Name The storage identifier. true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-AddStorage Configure storage using the thinpool. false true (ByPropertyName) False
-Device The block device you want to create the thinpool on. true true (ByPropertyName)
-Name The storage identifier. true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-AddStorage Configure storage using the zpool. false true (ByPropertyName) False
-Ashift Pool sector size exponent. false true (ByPropertyName) 0
-Compression The compression algorithm to use. Enum: on,off,gzip,lz4,lzjb,zle,zstd false true (ByPropertyName)
-Devices The block devices you want to create the zpool on. true true (ByPropertyName)
-DraidConfig -- false true (ByPropertyName)
-Name The storage identifier. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Raidlevel The RAID level to use. Enum: single,mirror,raid10,raidz,raidz2,raidz3,draid,draid2,draid3 true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Commands JSON encoded array of commands. true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Action Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. true true (ByPropertyName)
-Comment Descriptive comment. false true (ByPropertyName)
-Dest Restrict 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. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Dport Restrict 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. false true (ByPropertyName)
-Enable Flag to enable/disable a rule. false true (ByPropertyName) 0
-IcmpType Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. false true (ByPropertyName)
-Iface Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. false true (ByPropertyName)
-Log Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-Macro Use predefined standard macro. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Proto IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. false true (ByPropertyName)
-Source Restrict 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. false true (ByPropertyName)
-Sport Restrict 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. false true (ByPropertyName)
-Type Rule type. Enum: in,out,forward,group true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Data The target content of /etc/hosts. true true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Aliases

  • New-PveLxc

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Arch OS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64 false true (ByPropertyName)
-Bwlimit Override I/O bandwidth limit (in KiB/s). false true (ByPropertyName) 0
-Cmode Console 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,tty false true (ByPropertyName)
-Console Attach a console device (/dev/console) to the container. false true (ByPropertyName) False
-Cores The number of cores assigned to the container. A container can use all available cores by default. false true (ByPropertyName) 0
-Cpulimit Limit of CPU usage.NOTE':' If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. false true (ByPropertyName) 0
-Cpuunits CPU weight for a container, will be clamped to \[1, 10000] in cgroup v2. false true (ByPropertyName) 0
-Debug_ Try to be more verbose. For now this only enables debug log-level on start. false true (ByPropertyName) False
-Description Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. false true (ByPropertyName)
-DevN Device to pass through to the container false true (ByPropertyName)
-Features Allow containers access to advanced features. false true (ByPropertyName)
-Force Allow to overwrite existing container. false true (ByPropertyName) False
-Hookscript Script that will be executed during various steps in the containers lifetime. false true (ByPropertyName)
-Hostname Set a host name for the container. false true (ByPropertyName)
-IgnoreUnpackErrors Ignore errors when extracting the template. false true (ByPropertyName) False
-Lock Lock/unlock the container. Enum: backup,create,destroyed,disk,fstrim,migrate,mounted,rollback,snapshot,snapshot-delete false true (ByPropertyName)
-Memory Amount of RAM for the container in MB. false true (ByPropertyName) 0
-MpN Use volume as container mount point. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. false true (ByPropertyName)
-Nameserver Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. false true (ByPropertyName)
-NetN Specifies network interfaces for the container. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Onboot Specifies whether a container will be started during system bootup. false true (ByPropertyName) False
-Ostemplate The OS template or backup file. true true (ByPropertyName)
-Ostype OS 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,unmanaged false true (ByPropertyName)
-Password Sets root password inside container. false true (ByPropertyName)
-Pool Add the VM to the specified pool. false true (ByPropertyName)
-Protection Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. false true (ByPropertyName) False
-Restore Mark this as restore task. false true (ByPropertyName) False
-Rootfs Use volume as container root. false true (ByPropertyName)
-Searchdomain Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. false true (ByPropertyName)
-SshPublicKeys Setup public SSH keys (one key per line, OpenSSH format). false true (ByPropertyName)
-Start Start the CT after its creation finished successfully. false true (ByPropertyName) False
-Startup Startup 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. false true (ByPropertyName)
-Storage Default Storage. false true (ByPropertyName)
-Swap Amount of SWAP for the container in MB. false true (ByPropertyName) 0
-Tags Tags of the Container. This is only meta information. false true (ByPropertyName)
-Template Enable/disable Template. false true (ByPropertyName) False
-Timezone Time 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.tab false true (ByPropertyName)
-Tty Specify the number of tty available to the container false true (ByPropertyName) 0
-Unique Assign a unique random ethernet address. false true (ByPropertyName) False
-Unprivileged Makes the container run as unprivileged user. (Should not be modified manually.) false true (ByPropertyName) False
-UnusedN Reference to unused volumes. This is used internally, and should not be modified manually. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Bwlimit Override I/O bandwidth limit (in KiB/s). false true (ByPropertyName) 0
-Description Description for the new CT. false true (ByPropertyName)
-Full Create a full copy of all disks. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default. false true (ByPropertyName) False
-Hostname Set a hostname for the new CT. false true (ByPropertyName)
-Newid VMID for the clone. true true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Pool Add the new CT to the specified pool. false true (ByPropertyName)
-Snapname The name of the snapshot. false true (ByPropertyName)
-Storage Target storage for full clone. false true (ByPropertyName)
-Target Target node. Only allowed if the original VM is on shared storage. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Name Alias name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Name IP set name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Rename Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesLxcFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Name IP set name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Nomatch -- false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Action Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. true true (ByPropertyName)
-Comment Descriptive comment. false true (ByPropertyName)
-Dest Restrict 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. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Dport Restrict 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. false true (ByPropertyName)
-Enable Flag to enable/disable a rule. false true (ByPropertyName) 0
-IcmpType Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. false true (ByPropertyName)
-Iface Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. false true (ByPropertyName)
-Log Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-Macro Use predefined standard macro. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Proto IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. false true (ByPropertyName)
-Source Restrict 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. false true (ByPropertyName)
-Sport Restrict 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. false true (ByPropertyName)
-Type Rule type. Enum: in,out,forward,group true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Move-PveLxc

Syntax

New-PveNodesLxcMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [-Node] <String> [-Online] [-Restart] [-Target] <String> [[-TargetStorage] <String>] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Bwlimit Override I/O bandwidth limit (in KiB/s). false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Online Use online/live migration. false true (ByPropertyName) False
-Restart Use restart migration false true (ByPropertyName) False
-Target Target node. true true (ByPropertyName)
-TargetStorage Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. false true (ByPropertyName)
-Timeout Timeout in seconds for shutdown for restart migration false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Bwlimit Override I/O bandwidth limit (in KiB/s). false true (ByPropertyName) 0
-Delete Delete the original volume after successful copy. By default the original is kept as an unused volume entry. false true (ByPropertyName) False
-Digest Prevent changes if current configuration file has different SHA1 " . "digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Storage Target Storage. false true (ByPropertyName)
-TargetDigest Prevent changes if current configuration file of the target " . "container has a different SHA1 digest. This can be used to prevent " . "concurrent modifications. false true (ByPropertyName)
-TargetVmid The (unique) ID of the VM. false true (ByPropertyName) 0
-TargetVolume The 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,unused255 false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0
-Volume Volume 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,unused255 true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Bridges List of network bridges to check availability. Will be checked again for actually used bridges during migration. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Storages List of storages to check permission and availability. Will be checked again for all actually used storages during migration. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Bwlimit Override I/O bandwidth limit (in KiB/s). false true (ByPropertyName) 0
-Delete Delete the original CT and related data after successful migration. By default the original CT is kept on the source cluster in a stopped state. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Online Use online/live migration. false true (ByPropertyName) False
-Restart Use restart migration false true (ByPropertyName) False
-TargetBridge Mapping 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. true true (ByPropertyName)
-TargetEndpoint Remote target endpoint true true (ByPropertyName)
-TargetStorage Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. true true (ByPropertyName)
-TargetVmid The (unique) ID of the VM. false true (ByPropertyName) 0
-Timeout Timeout in seconds for shutdown for restart migration false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Create-PveLxcSnapshot

Syntax

New-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Description A textual description or comment. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Undo-PveLxcSnapshot

Syntax

New-PveNodesLxcSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Start Whether the container should get started after rolling back successfully false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesLxcSpiceproxy [[-PveTicket] <PveTicket>] [-Node] <String> [[-Proxy] <String>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Proxy SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI). false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Restart-PveLxc

Syntax

New-PveNodesLxcStatusReboot [[-PveTicket] <PveTicket>] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Timeout Wait maximal timeout seconds for the shutdown. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Resume-PveLxc

Syntax

New-PveNodesLxcStatusResume [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Shutdown-PveLxc

Syntax

New-PveNodesLxcStatusShutdown [[-PveTicket] <PveTicket>] [-Forcestop] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Forcestop Make sure the Container stops. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Timeout Wait maximal timeout seconds. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Start-PveLxc

Syntax

New-PveNodesLxcStatusStart [[-PveTicket] <PveTicket>] [-Debug_] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Debug_ If set, enables very verbose debug log-level on start. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Stop-PveLxc

Syntax

New-PveNodesLxcStatusStop [[-PveTicket] <PveTicket>] [-Node] <String> [-OverruleShutdown] [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-OverruleShutdown Try to abort active 'vzshutdown' tasks before stopping. false true (ByPropertyName) False
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Suspend-PveLxc

Syntax

New-PveNodesLxcStatusSuspend [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesLxcTemplate [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesLxcTermproxy [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesLxcVncproxy [[-PveTicket] <PveTicket>] [[-Height] <Int32>] [-Node] <String> [-Vmid] <Int32> [-Websocket] [[-Width] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Height sets the height of the console in pixels. false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0
-Websocket use websocket instead of standard VNC. false true (ByPropertyName) False
-Width sets the width of the console in pixels. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Maxworkers Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg. One of both must be set! false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Target Target node. true true (ByPropertyName)
-Vms Only consider Guests with these IDs. false true (ByPropertyName)
-WithLocalDisks Enable live storage migration for local disk false true (ByPropertyName) False

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesNetwork [[-PveTicket] <PveTicket>] [[-Address] <String>] [[-Address6] <String>] [-Autostart] [[-BondPrimary] <String>] [[-BondMode] <String>] [[-BondXmitHashPolicy] <String>] [[-BridgePorts] <String>] [[-BridgeVids] <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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Address IP address. false true (ByPropertyName)
-Address6 IP address. false true (ByPropertyName)
-Autostart Automatically start interface on boot. false true (ByPropertyName) False
-BondPrimary Specify the primary interface for active-backup bond. false true (ByPropertyName)
-BondMode Bonding mode. Enum: balance-rr,active-backup,balance-xor,broadcast,802.3ad,balance-tlb,balance-alb,balance-slb,lacp-balance-slb,lacp-balance-tcp false true (ByPropertyName)
-BondXmitHashPolicy Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. Enum: layer2,layer2+3,layer3+4 false true (ByPropertyName)
-BridgePorts Specify the interfaces you want to add to your bridge. false true (ByPropertyName)
-BridgeVids Specify the allowed VLANs. For example':' '2 4 100-200'. Only used if the bridge is VLAN aware. false true (ByPropertyName)
-BridgeVlanAware Enable bridge vlan support. false true (ByPropertyName) False
-Cidr IPv4 CIDR. false true (ByPropertyName)
-Cidr6 IPv6 CIDR. false true (ByPropertyName)
-Comments Comments false true (ByPropertyName)
-Comments6 Comments false true (ByPropertyName)
-Gateway Default gateway address. false true (ByPropertyName)
-Gateway6 Default ipv6 gateway address. false true (ByPropertyName)
-Iface Network interface name. true true (ByPropertyName)
-Mtu MTU. false true (ByPropertyName) 0
-Netmask Network mask. false true (ByPropertyName)
-Netmask6 Network mask. false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-OvsBonds Specify the interfaces used by the bonding device. false true (ByPropertyName)
-OvsBridge The OVS bridge associated with a OVS port. This is required when you create an OVS port. false true (ByPropertyName)
-OvsOptions OVS interface options. false true (ByPropertyName)
-OvsPorts Specify the interfaces you want to add to your bridge. false true (ByPropertyName)
-OvsTag Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond) false true (ByPropertyName) 0
-Slaves Specify the interfaces used by the bonding device. false true (ByPropertyName)
-Type Network interface type Enum: bridge,bond,eth,alias,vlan,OVSBridge,OVSBond,OVSPort,OVSIntPort,unknown true true (ByPropertyName)
-VlanId vlan-id for a custom named vlan interface (ifupdown2 only). false true (ByPropertyName) 0
-VlanRawDevice Specify the raw interface for the vlan interface. false true (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>] [[-AmdSev] <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>] [[-ImportWorkingStorage] <String>] [[-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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Acpi Enable/disable ACPI. false true (ByPropertyName) False
-Affinity List of host cores used to execute guest processes, for example':' 0,5,8-11 false true (ByPropertyName)
-Agent Enable/disable communication with the QEMU Guest Agent and its properties. false true (ByPropertyName)
-AmdSev Secure Encrypted Virtualization (SEV) features by AMD CPUs false true (ByPropertyName)
-Arch Virtual processor architecture. Defaults to the host. Enum: x86_64,aarch64 false true (ByPropertyName)
-Archive The 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. false true (ByPropertyName)
-Args_ Arbitrary arguments passed to kvm. false true (ByPropertyName)
-Audio0 Configure a audio device, useful in combination with QXL/Spice. false true (ByPropertyName)
-Autostart Automatic restart after crash (currently ignored). false true (ByPropertyName) False
-Balloon Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. false true (ByPropertyName) 0
-Bios Select BIOS implementation. Enum: seabios,ovmf false true (ByPropertyName)
-Boot Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. false true (ByPropertyName)
-Bootdisk Enable booting from specified disk. Deprecated':' Use 'boot':' order=foo;bar' instead. false true (ByPropertyName)
-Bwlimit Override I/O bandwidth limit (in KiB/s). false true (ByPropertyName) 0
-Cdrom This is an alias for option -ide2 false true (ByPropertyName)
-Cicustom cloud-init':' Specify custom files to replace the automatically generated ones at start. false true (ByPropertyName)
-Cipassword cloud-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. false true (ByPropertyName)
-Citype Specifies 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,opennebula false true (ByPropertyName)
-Ciupgrade cloud-init':' do an automatic package upgrade after the first boot. false true (ByPropertyName) False
-Ciuser cloud-init':' User name to change ssh keys and password for instead of the image's configured default user. false true (ByPropertyName)
-Cores The number of cores per socket. false true (ByPropertyName) 0
-Cpu Emulated CPU type. false true (ByPropertyName)
-Cpulimit Limit of CPU usage. false true (ByPropertyName) 0
-Cpuunits CPU weight for a VM, will be clamped to \[1, 10000] in cgroup v2. false true (ByPropertyName) 0
-Description Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. false true (ByPropertyName)
-Efidisk0 Configure 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. false true (ByPropertyName)
-Force Allow to overwrite existing VM. false true (ByPropertyName) False
-Freeze Freeze CPU at startup (use 'c' monitor command to start execution). false true (ByPropertyName) False
-Hookscript Script that will be executed during various steps in the vms lifetime. false true (ByPropertyName)
-HostpciN Map host PCI devices into guest. false true (ByPropertyName)
-Hotplug Selectively 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. false true (ByPropertyName)
-Hugepages Enable/disable hugepages memory. Enum: any,2,1024 false true (ByPropertyName)
-IdeN Use 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. false true (ByPropertyName)
-ImportWorkingStorage A file-based storage with 'images' content-type enabled, which is used as an intermediary extraction storage during import. Defaults to the source storage. false true (ByPropertyName)
-IpconfigN cloud-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. false true (ByPropertyName)
-Ivshmem Inter-VM shared memory. Useful for direct communication between VMs, or to the host. false true (ByPropertyName)
-Keephugepages Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. false true (ByPropertyName) False
-Keyboard Keyboard 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,tr false true (ByPropertyName)
-Kvm Enable/disable KVM hardware virtualization. false true (ByPropertyName) False
-LiveRestore Start the VM immediately while importing or restoring in the background. false true (ByPropertyName) False
-Localtime Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. false true (ByPropertyName) False
-Lock Lock/unlock the VM. Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspended false true (ByPropertyName)
-Machine Specify the QEMU machine. false true (ByPropertyName)
-Memory Memory properties. false true (ByPropertyName)
-MigrateDowntime Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge. false true (ByPropertyName) 0
-MigrateSpeed Set maximum speed (in MB/s) for migrations. Value 0 is no limit. false true (ByPropertyName) 0
-Name Set a name for the VM. Only used on the configuration web interface. false true (ByPropertyName)
-Nameserver cloud-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. false true (ByPropertyName)
-NetN Specify network devices. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Numa Enable/disable NUMA. false true (ByPropertyName) False
-NumaN NUMA topology. false true (ByPropertyName)
-Onboot Specifies whether a VM will be started during system bootup. false true (ByPropertyName) False
-Ostype Specify guest operating system. Enum: other,wxp,w2k,w2k3,w2k8,wvista,win7,win8,win10,win11,l24,l26,solaris false true (ByPropertyName)
-ParallelN Map host parallel devices (n is 0 to 2). false true (ByPropertyName)
-Pool Add the VM to the specified pool. false true (ByPropertyName)
-Protection Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. false true (ByPropertyName) False
-Reboot Allow reboot. If set to '0' the VM exit on reboot. false true (ByPropertyName) False
-Rng0 Configure a VirtIO-based Random Number Generator. false true (ByPropertyName)
-SataN Use 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. false true (ByPropertyName)
-ScsiN Use 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. false true (ByPropertyName)
-Scsihw SCSI controller model Enum: lsi,lsi53c810,virtio-scsi-pci,virtio-scsi-single,megasas,pvscsi false true (ByPropertyName)
-Searchdomain cloud-init':' Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. false true (ByPropertyName)
-SerialN Create a serial device inside the VM (n is 0 to 3) false true (ByPropertyName)
-Shares Amount 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. false true (ByPropertyName) 0
-Smbios1 Specify SMBIOS type 1 fields. false true (ByPropertyName)
-Smp The number of CPUs. Please use option -sockets instead. false true (ByPropertyName) 0
-Sockets The number of CPU sockets. false true (ByPropertyName) 0
-SpiceEnhancements Configure additional enhancements for SPICE. false true (ByPropertyName)
-Sshkeys cloud-init':' Setup public SSH keys (one key per line, OpenSSH format). false true (ByPropertyName)
-Start Start VM after it was created successfully. false true (ByPropertyName) False
-Startdate Set the initial date of the real time clock. Valid format for date are':''now' or '2006-06-17T16':'01':'21' or '2006-06-17'. false true (ByPropertyName)
-Startup Startup 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. false true (ByPropertyName)
-Storage Default storage. false true (ByPropertyName)
-Tablet Enable/disable the USB tablet device. false true (ByPropertyName) False
-Tags Tags of the VM. This is only meta information. false true (ByPropertyName)
-Tdf Enable/disable time drift fix. false true (ByPropertyName) False
-Template Enable/disable Template. false true (ByPropertyName) False
-Tpmstate0 Configure 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. false true (ByPropertyName)
-Unique Assign a unique random ethernet address. false true (ByPropertyName) False
-UnusedN Reference to unused volumes. This is used internally, and should not be modified manually. false true (ByPropertyName)
-UsbN Configure 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). false true (ByPropertyName)
-Vcpus Number of hotplugged vcpus. false true (ByPropertyName) 0
-Vga Configure the VGA hardware. false true (ByPropertyName)
-VirtioN Use 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. false true (ByPropertyName)
-Vmgenid Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0
-Vmstatestorage Default storage for VM state volumes/files. false true (ByPropertyName)
-Watchdog Create a virtual hardware watchdog device. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Command The 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-ram true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuAgentExec [[-PveTicket] <PveTicket>] [-Command] <Array> [[-InputData] <String>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Command The command as a list of program + arguments. true true (ByPropertyName)
-InputData Data to pass as 'input-data' to the guest. Usually treated as STDIN to 'command'. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuAgentFileWrite [[-PveTicket] <PveTicket>] [-Content] <String> [-Encode] [-File] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Content The content to write into the file. true true (ByPropertyName)
-Encode If set, the content will be encoded as base64 (required by QEMU).Otherwise the content needs to be encoded beforehand - defaults to true. false true (ByPropertyName) False
-File The path to the file. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuAgentFsfreezeFreeze [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuAgentFsfreezeStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuAgentFsfreezeThaw [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuAgentFstrim [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuAgentPing [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuAgentSetUserPassword [[-PveTicket] <PveTicket>] [-Crypted] [-Node] <String> [-Password] <SecureString> [-Username] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Crypted set to 1 if the password has already been passed through crypt() false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Password The new password. true true (ByPropertyName)
-Username The user to set the password for. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuAgentShutdown [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuAgentSuspendDisk [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuAgentSuspendHybrid [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuAgentSuspendRam [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Bwlimit Override I/O bandwidth limit (in KiB/s). false true (ByPropertyName) 0
-Description Description for the new VM. false true (ByPropertyName)
-Format Target format for file storage. Only valid for full clone. Enum: raw,qcow2,vmdk false true (ByPropertyName)
-Full Create a full copy of all disks. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default. false true (ByPropertyName) False
-Name Set a name for the new VM. false true (ByPropertyName)
-Newid VMID for the clone. true true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Pool Add the new VM to the specified pool. false true (ByPropertyName)
-Snapname The name of the snapshot. false true (ByPropertyName)
-Storage Target storage for full clone. false true (ByPropertyName)
-Target Target node. Only allowed if the original VM is on shared storage. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuConfig [[-PveTicket] <PveTicket>] [-Acpi] [[-Affinity] <String>] [[-Agent] <String>] [[-AmdSev] <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>] [[-ImportWorkingStorage] <String>] [[-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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Acpi Enable/disable ACPI. false true (ByPropertyName) False
-Affinity List of host cores used to execute guest processes, for example':' 0,5,8-11 false true (ByPropertyName)
-Agent Enable/disable communication with the QEMU Guest Agent and its properties. false true (ByPropertyName)
-AmdSev Secure Encrypted Virtualization (SEV) features by AMD CPUs false true (ByPropertyName)
-Arch Virtual processor architecture. Defaults to the host. Enum: x86_64,aarch64 false true (ByPropertyName)
-Args_ Arbitrary arguments passed to kvm. false true (ByPropertyName)
-Audio0 Configure a audio device, useful in combination with QXL/Spice. false true (ByPropertyName)
-Autostart Automatic restart after crash (currently ignored). false true (ByPropertyName) False
-BackgroundDelay Time to wait for the task to finish. We return 'null' if the task finish within that time. false true (ByPropertyName) 0
-Balloon Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. false true (ByPropertyName) 0
-Bios Select BIOS implementation. Enum: seabios,ovmf false true (ByPropertyName)
-Boot Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. false true (ByPropertyName)
-Bootdisk Enable booting from specified disk. Deprecated':' Use 'boot':' order=foo;bar' instead. false true (ByPropertyName)
-Cdrom This is an alias for option -ide2 false true (ByPropertyName)
-Cicustom cloud-init':' Specify custom files to replace the automatically generated ones at start. false true (ByPropertyName)
-Cipassword cloud-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. false true (ByPropertyName)
-Citype Specifies 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,opennebula false true (ByPropertyName)
-Ciupgrade cloud-init':' do an automatic package upgrade after the first boot. false true (ByPropertyName) False
-Ciuser cloud-init':' User name to change ssh keys and password for instead of the image's configured default user. false true (ByPropertyName)
-Cores The number of cores per socket. false true (ByPropertyName) 0
-Cpu Emulated CPU type. false true (ByPropertyName)
-Cpulimit Limit of CPU usage. false true (ByPropertyName) 0
-Cpuunits CPU weight for a VM, will be clamped to \[1, 10000] in cgroup v2. false true (ByPropertyName) 0
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Description Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Efidisk0 Configure 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. false true (ByPropertyName)
-Force Force 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. false true (ByPropertyName) False
-Freeze Freeze CPU at startup (use 'c' monitor command to start execution). false true (ByPropertyName) False
-Hookscript Script that will be executed during various steps in the vms lifetime. false true (ByPropertyName)
-HostpciN Map host PCI devices into guest. false true (ByPropertyName)
-Hotplug Selectively 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. false true (ByPropertyName)
-Hugepages Enable/disable hugepages memory. Enum: any,2,1024 false true (ByPropertyName)
-IdeN Use 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. false true (ByPropertyName)
-ImportWorkingStorage A file-based storage with 'images' content-type enabled, which is used as an intermediary extraction storage during import. Defaults to the source storage. false true (ByPropertyName)
-IpconfigN cloud-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. false true (ByPropertyName)
-Ivshmem Inter-VM shared memory. Useful for direct communication between VMs, or to the host. false true (ByPropertyName)
-Keephugepages Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. false true (ByPropertyName) False
-Keyboard Keyboard 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,tr false true (ByPropertyName)
-Kvm Enable/disable KVM hardware virtualization. false true (ByPropertyName) False
-Localtime Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. false true (ByPropertyName) False
-Lock Lock/unlock the VM. Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspended false true (ByPropertyName)
-Machine Specify the QEMU machine. false true (ByPropertyName)
-Memory Memory properties. false true (ByPropertyName)
-MigrateDowntime Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge. false true (ByPropertyName) 0
-MigrateSpeed Set maximum speed (in MB/s) for migrations. Value 0 is no limit. false true (ByPropertyName) 0
-Name Set a name for the VM. Only used on the configuration web interface. false true (ByPropertyName)
-Nameserver cloud-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. false true (ByPropertyName)
-NetN Specify network devices. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Numa Enable/disable NUMA. false true (ByPropertyName) False
-NumaN NUMA topology. false true (ByPropertyName)
-Onboot Specifies whether a VM will be started during system bootup. false true (ByPropertyName) False
-Ostype Specify guest operating system. Enum: other,wxp,w2k,w2k3,w2k8,wvista,win7,win8,win10,win11,l24,l26,solaris false true (ByPropertyName)
-ParallelN Map host parallel devices (n is 0 to 2). false true (ByPropertyName)
-Protection Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. false true (ByPropertyName) False
-Reboot Allow reboot. If set to '0' the VM exit on reboot. false true (ByPropertyName) False
-Revert Revert a pending change. false true (ByPropertyName)
-Rng0 Configure a VirtIO-based Random Number Generator. false true (ByPropertyName)
-SataN Use 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. false true (ByPropertyName)
-ScsiN Use 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. false true (ByPropertyName)
-Scsihw SCSI controller model Enum: lsi,lsi53c810,virtio-scsi-pci,virtio-scsi-single,megasas,pvscsi false true (ByPropertyName)
-Searchdomain cloud-init':' Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. false true (ByPropertyName)
-SerialN Create a serial device inside the VM (n is 0 to 3) false true (ByPropertyName)
-Shares Amount 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. false true (ByPropertyName) 0
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Smbios1 Specify SMBIOS type 1 fields. false true (ByPropertyName)
-Smp The number of CPUs. Please use option -sockets instead. false true (ByPropertyName) 0
-Sockets The number of CPU sockets. false true (ByPropertyName) 0
-SpiceEnhancements Configure additional enhancements for SPICE. false true (ByPropertyName)
-Sshkeys cloud-init':' Setup public SSH keys (one key per line, OpenSSH format). false true (ByPropertyName)
-Startdate Set the initial date of the real time clock. Valid format for date are':''now' or '2006-06-17T16':'01':'21' or '2006-06-17'. false true (ByPropertyName)
-Startup Startup 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. false true (ByPropertyName)
-Tablet Enable/disable the USB tablet device. false true (ByPropertyName) False
-Tags Tags of the VM. This is only meta information. false true (ByPropertyName)
-Tdf Enable/disable time drift fix. false true (ByPropertyName) False
-Template Enable/disable Template. false true (ByPropertyName) False
-Tpmstate0 Configure 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. false true (ByPropertyName)
-UnusedN Reference to unused volumes. This is used internally, and should not be modified manually. false true (ByPropertyName)
-UsbN Configure 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). false true (ByPropertyName)
-Vcpus Number of hotplugged vcpus. false true (ByPropertyName) 0
-Vga Configure the VGA hardware. false true (ByPropertyName)
-VirtioN Use 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. false true (ByPropertyName)
-Vmgenid Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0
-Vmstatestorage Default storage for VM state volumes/files. false true (ByPropertyName)
-Watchdog Create a virtual hardware watchdog device. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Name Alias name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Name IP set name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Rename Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Name IP set name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Nomatch -- false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Action Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. true true (ByPropertyName)
-Comment Descriptive comment. false true (ByPropertyName)
-Dest Restrict 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. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Dport Restrict 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. false true (ByPropertyName)
-Enable Flag to enable/disable a rule. false true (ByPropertyName) 0
-IcmpType Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. false true (ByPropertyName)
-Iface Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. false true (ByPropertyName)
-Log Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-Macro Use predefined standard macro. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Proto IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. false true (ByPropertyName)
-Source Restrict 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. false true (ByPropertyName)
-Sport Restrict 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. false true (ByPropertyName)
-Type Rule type. Enum: in,out,forward,group true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Bwlimit Override I/O bandwidth limit (in KiB/s). false true (ByPropertyName) 0
-Force Allow to migrate VMs which use local devices. Only root may use this option. false true (ByPropertyName) False
-MigrationNetwork CIDR of the (sub) network that is used for migration. false true (ByPropertyName)
-MigrationType Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. Enum: secure,insecure false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Online Use online/live migration if VM is running. Ignored if VM is stopped. false true (ByPropertyName) False
-Target Target node. true true (ByPropertyName)
-Targetstorage Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0
-WithLocalDisks Enable live storage migration for local disk false true (ByPropertyName) False

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuMonitor [[-PveTicket] <PveTicket>] [-Command] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Command The monitor command. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Bwlimit Override I/O bandwidth limit (in KiB/s). false true (ByPropertyName) 0
-Delete Delete the original disk after successful copy. By default the original disk is kept as unused disk. false true (ByPropertyName) False
-Digest Prevent changes if current configuration file has different SHA1" ." digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Disk The 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,unused255 true true (ByPropertyName)
-Format Target Format. Enum: raw,qcow2,vmdk false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Storage Target storage. false true (ByPropertyName)
-TargetDigest Prevent changes if the current config file of the target VM has a" ." different SHA1 digest. This can be used to detect concurrent modifications. false true (ByPropertyName)
-TargetDisk The 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,unused255 false true (ByPropertyName)
-TargetVmid The (unique) ID of the VM. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuMtunnel [[-PveTicket] <PveTicket>] [[-Bridges] <String>] [-Node] <String> [[-Storages] <String>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Bridges List of network bridges to check availability. Will be checked again for actually used bridges during migration. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Storages List of storages to check permission and availability. Will be checked again for all actually used storages during migration. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuRemoteMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [-Delete] [-Node] <String> [-Online] [-TargetBridge] <String> [-TargetEndpoint] <String> [-TargetStorage] <String> [[-TargetVmid] <Int32>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Bwlimit Override I/O bandwidth limit (in KiB/s). false true (ByPropertyName) 0
-Delete Delete the original VM and related data after successful migration. By default the original VM is kept on the source cluster in a stopped state. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Online Use online/live migration if VM is running. Ignored if VM is stopped. false true (ByPropertyName) False
-TargetBridge Mapping 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. true true (ByPropertyName)
-TargetEndpoint Remote target endpoint true true (ByPropertyName)
-TargetStorage Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. true true (ByPropertyName)
-TargetVmid The (unique) ID of the VM. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Create-PveQemuSnapshot

Syntax

New-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [-Vmstate] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Description A textual description or comment. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0
-Vmstate Save the vmstate false true (ByPropertyName) False

Outputs

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

  • PveResponse. Return response.

Aliases

  • Undo-PveQemuSnapshot

Syntax

New-PveNodesQemuSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Start Whether the VM should get started after rolling back successfully. (Note':' VMs will be automatically started if the snapshot includes RAM.) false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuSpiceproxy [[-PveTicket] <PveTicket>] [-Node] <String> [[-Proxy] <String>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Proxy SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI). false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Restart-PveQemu

Syntax

New-PveNodesQemuStatusReboot [[-PveTicket] <PveTicket>] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Timeout Wait maximal timeout seconds for the shutdown. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Reset-PveQemu

Syntax

New-PveNodesQemuStatusReset [[-PveTicket] <PveTicket>] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Resume-PveQemu

Syntax

New-PveNodesQemuStatusResume [[-PveTicket] <PveTicket>] [-Nocheck] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Nocheck -- false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Shutdown-PveQemu

Syntax

New-PveNodesQemuStatusShutdown [[-PveTicket] <PveTicket>] [-Forcestop] [-Keepactive] [-Node] <String> [-Skiplock] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Forcestop Make sure the VM stops. false true (ByPropertyName) False
-Keepactive Do not deactivate storage volumes. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Timeout Wait maximal timeout seconds. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-ForceCpu Override QEMU's -cpu argument with the given string. false true (ByPropertyName)
-Machine Specify the QEMU machine. false true (ByPropertyName)
-Migratedfrom The cluster node name. false true (ByPropertyName)
-MigrationNetwork CIDR of the (sub) network that is used for migration. false true (ByPropertyName)
-MigrationType Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. Enum: secure,insecure false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Stateuri Some command save/restore state from this location. false true (ByPropertyName)
-Targetstorage Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. false true (ByPropertyName)
-Timeout Wait maximal timeout seconds. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuStatusStop [[-PveTicket] <PveTicket>] [-Keepactive] [[-Migratedfrom] <String>] [-Node] <String> [-OverruleShutdown] [-Skiplock] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Keepactive Do not deactivate storage volumes. false true (ByPropertyName) False
-Migratedfrom The cluster node name. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-OverruleShutdown Try to abort active 'qmshutdown' tasks before stopping. false true (ByPropertyName) False
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Timeout Wait maximal timeout seconds. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Suspend-PveQemu

Syntax

New-PveNodesQemuStatusSuspend [[-PveTicket] <PveTicket>] [-Node] <String> [-Skiplock] [[-Statestorage] <String>] [-Todisk] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Statestorage The storage for the VM state false true (ByPropertyName)
-Todisk If set, suspends the VM to disk. Will be resumed on next VM start. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuTemplate [[-PveTicket] <PveTicket>] [[-Disk] <String>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Disk If 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,tpmstate0 false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuTermproxy [[-PveTicket] <PveTicket>] [-Node] <String> [[-Serial] <String>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Serial opens a serial terminal (defaults to display) Enum: serial0,serial1,serial2,serial3 false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuVncproxy [[-PveTicket] <PveTicket>] [-GeneratePassword] [-Node] <String> [-Vmid] <Int32> [-Websocket] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-GeneratePassword Generates a random password to be used as ticket instead of the API ticket. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0
-Websocket Prepare for websocket upgrade (only required when using serial terminal, otherwise upgrade is always possible). false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Service Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesServicesRestart [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Service Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesServicesStart [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Service Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesServicesStop [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Service Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

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

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cmd Run specific command or default to login (requires 'root@pam') Enum: upgrade,ceph_install,login false true (ByPropertyName)
-CmdOpts Add parameters to a command. Encoded as null terminated strings. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Proxy SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI). false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Force Issue start command even if virtual guest have 'onboot' not set or set to off. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Vms Only consider guests from this comma separated list of VMIDs. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Command Specify the command. Enum: reboot,shutdown true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-ForceStop Force a hard-stop after the timeout. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Timeout Timeout for each guest shutdown task. Depending on `force-stop`, the shutdown gets then simply aborted or a hard-stop is forced. false true (ByPropertyName) 0
-Vms Only consider Guests with these IDs. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Filename The name of the file to create. true true (ByPropertyName)
-Format -- Enum: raw,qcow2,subvol false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Size Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M) true true (ByPropertyName)
-Storage The storage identifier. true true (ByPropertyName)
-Vmid Specify owner VM true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Storage The storage identifier. false true (ByPropertyName)
-Target Target volume identifier true true (ByPropertyName)
-TargetNode Target node. Default is local node. false true (ByPropertyName)
-Volume Source volume identifier true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Checksum The expected checksum of the file. false true (ByPropertyName)
-ChecksumAlgorithm The algorithm to calculate the checksum of the file. Enum: md5,sha1,sha224,sha256,sha384,sha512 false true (ByPropertyName)
-Compression Decompress the downloaded file using the specified compression algorithm. false true (ByPropertyName)
-Content Content type. Enum: iso,vztmpl,import true true (ByPropertyName)
-Filename The name of the file to create. Caution':' This will be normalized! true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Storage The storage identifier. true true (ByPropertyName)
-Url The URL to download the file from. true true (ByPropertyName)
-VerifyCertificates If false, no SSL/TLS certificates will be verified. false true (ByPropertyName) False

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesStorageUpload [[-PveTicket] <PveTicket>] [[-Checksum] <String>] [[-ChecksumAlgorithm] <String>] [-Content] <String> [-Filename] <String> [-Node] <String> [-Storage] <String> [[-Tmpfilename] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Checksum The expected checksum of the file. false true (ByPropertyName)
-ChecksumAlgorithm The algorithm to calculate the checksum of the file. Enum: md5,sha1,sha224,sha256,sha384,sha512 false true (ByPropertyName)
-Content Content type. Enum: iso,vztmpl,import true true (ByPropertyName)
-Filename The name of the file to create. Caution':' This will be normalized! true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Storage The storage identifier. true true (ByPropertyName)
-Tmpfilename The 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. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Force Always connect to server, even if local cache is still valid. false true (ByPropertyName) False
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vms Only consider Guests with these IDs. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cmd Run specific command or default to login (requires 'root@pam') Enum: upgrade,ceph_install,login false true (ByPropertyName)
-CmdOpts Add parameters to a command. Encoded as null terminated strings. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cmd Run specific command or default to login (requires 'root@pam') Enum: upgrade,ceph_install,login false true (ByPropertyName)
-CmdOpts Add parameters to a command. Encoded as null terminated strings. false true (ByPropertyName)
-Height sets the height of the console in pixels. false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Websocket use websocket instead of standard vnc. false true (ByPropertyName) False
-Width sets the width of the console in pixels. false true (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>] [[-Fleecing] <String>] [[-Ionice] <Int32>] [[-JobId] <String>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <String>] [[-NotificationMode] <String>] [[-NotificationPolicy] <String>] [[-NotificationTarget] <String>] [[-PbsChangeDetectionMode] <String>] [[-Performance] <String>] [[-Pigz] <Int32>] [[-Pool] <String>] [-Protected] [[-PruneBackups] <String>] [-Quiet] [-Remove] [[-Script] <String>] [-Stdexcludes] [-Stdout] [-Stop] [[-Stopwait] <Int32>] [[-Storage] <String>] [[-Tmpdir] <String>] [[-Vmid] <String>] [[-Zstd] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-All Backup all known guest systems on this host. false true (ByPropertyName) False
-Bwlimit Limit I/O bandwidth (in KiB/s). false true (ByPropertyName) 0
-Compress Compress dump file. Enum: 0,1,gzip,lzo,zstd false true (ByPropertyName)
-Dumpdir Store resulting files to specified directory. false true (ByPropertyName)
-Exclude Exclude specified guest systems (assumes --all) false true (ByPropertyName)
-ExcludePath Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. false true (ByPropertyName)
-Fleecing Options for backup fleecing (VM only). false true (ByPropertyName)
-Ionice Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. false true (ByPropertyName) 0
-JobId The ID of the backup job. If set, the 'backup-job' metadata field of the backup notification will be set to this value. Only root@pam can set this parameter. false true (ByPropertyName)
-Lockwait Maximal time to wait for the global lock (minutes). false true (ByPropertyName) 0
-Mailnotification Deprecated':' use notification targets/matchers instead. Specify when to send a notification mail Enum: always,failure false true (ByPropertyName)
-Mailto Deprecated':' Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications. false true (ByPropertyName)
-Maxfiles Deprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system. false true (ByPropertyName) 0
-Mode Backup mode. Enum: snapshot,suspend,stop false true (ByPropertyName)
-Node Only run if executed on this node. false true (ByPropertyName)
-NotesTemplate Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. false true (ByPropertyName)
-NotificationMode Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. Enum: auto,legacy-sendmail,notification-system false true (ByPropertyName)
-NotificationPolicy Deprecated':' Do not use Enum: always,failure,never false true (ByPropertyName)
-NotificationTarget Deprecated':' Do not use false true (ByPropertyName)
-PbsChangeDetectionMode PBS mode used to detect file changes and switch encoding format for container backups. Enum: legacy,data,metadata false true (ByPropertyName)
-Performance Other performance-related settings. false true (ByPropertyName)
-Pigz Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. false true (ByPropertyName) 0
-Pool Backup all known guest systems included in the specified pool. false true (ByPropertyName)
-Protected If true, mark backup(s) as protected. false true (ByPropertyName) False
-PruneBackups Use these retention options instead of those from the storage configuration. false true (ByPropertyName)
-Quiet Be quiet. false true (ByPropertyName) False
-Remove Prune older backups according to 'prune-backups'. false true (ByPropertyName) False
-Script Use specified hook script. false true (ByPropertyName)
-Stdexcludes Exclude temporary files and logs. false true (ByPropertyName) False
-Stdout Write tar to stdout, not to a file. false true (ByPropertyName) False
-Stop Stop running backup jobs on this host. false true (ByPropertyName) False
-Stopwait Maximal time to wait until a guest system is stopped (minutes). false true (ByPropertyName) 0
-Storage Store resulting file to this storage. false true (ByPropertyName)
-Tmpdir Store temporary files to specified directory. false true (ByPropertyName)
-Vmid The ID of the guest system you want to backup. false true (ByPropertyName)
-Zstd Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesWakeonlan [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node target node for wake on LAN packet true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Poolid -- true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemu [[-PveTicket] <PveTicket>] [-Acpi] [[-Affinity] <String>] [[-Agent] <String>] [[-AmdSev] <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>] [[-ImportWorkingStorage] <String>] [[-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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Acpi Enable/disable ACPI. false true (ByPropertyName) False
-Affinity List of host cores used to execute guest processes, for example':' 0,5,8-11 false true (ByPropertyName)
-Agent Enable/disable communication with the QEMU Guest Agent and its properties. false true (ByPropertyName)
-AmdSev Secure Encrypted Virtualization (SEV) features by AMD CPUs false true (ByPropertyName)
-Arch Virtual processor architecture. Defaults to the host. Enum: x86_64,aarch64 false true (ByPropertyName)
-Archive The 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. false true (ByPropertyName)
-Args_ Arbitrary arguments passed to kvm. false true (ByPropertyName)
-Audio0 Configure a audio device, useful in combination with QXL/Spice. false true (ByPropertyName)
-Autostart Automatic restart after crash (currently ignored). false true (ByPropertyName) False
-Balloon Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. false true (ByPropertyName) 0
-Bios Select BIOS implementation. Enum: seabios,ovmf false true (ByPropertyName)
-Boot Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. false true (ByPropertyName)
-Bootdisk Enable booting from specified disk. Deprecated':' Use 'boot':' order=foo;bar' instead. false true (ByPropertyName)
-Bwlimit Override I/O bandwidth limit (in KiB/s). false true (ByPropertyName) 0
-Cdrom This is an alias for option -ide2 false true (ByPropertyName)
-Cicustom cloud-init':' Specify custom files to replace the automatically generated ones at start. false true (ByPropertyName)
-Cipassword cloud-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. false true (ByPropertyName)
-Citype Specifies 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,opennebula false true (ByPropertyName)
-Ciupgrade cloud-init':' do an automatic package upgrade after the first boot. false true (ByPropertyName) False
-Ciuser cloud-init':' User name to change ssh keys and password for instead of the image's configured default user. false true (ByPropertyName)
-Cores The number of cores per socket. false true (ByPropertyName) 0
-Cpu Emulated CPU type. false true (ByPropertyName)
-Cpulimit Limit of CPU usage. false true (ByPropertyName) 0
-Cpuunits CPU weight for a VM, will be clamped to \[1, 10000] in cgroup v2. false true (ByPropertyName) 0
-Description Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. false true (ByPropertyName)
-Efidisk0 Configure 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. false true (ByPropertyName)
-Force Allow to overwrite existing VM. false true (ByPropertyName) False
-Freeze Freeze CPU at startup (use 'c' monitor command to start execution). false true (ByPropertyName) False
-Hookscript Script that will be executed during various steps in the vms lifetime. false true (ByPropertyName)
-HostpciN Map host PCI devices into guest. false true (ByPropertyName)
-Hotplug Selectively 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. false true (ByPropertyName)
-Hugepages Enable/disable hugepages memory. Enum: any,2,1024 false true (ByPropertyName)
-IdeN Use 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. false true (ByPropertyName)
-ImportWorkingStorage A file-based storage with 'images' content-type enabled, which is used as an intermediary extraction storage during import. Defaults to the source storage. false true (ByPropertyName)
-IpconfigN cloud-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. false true (ByPropertyName)
-Ivshmem Inter-VM shared memory. Useful for direct communication between VMs, or to the host. false true (ByPropertyName)
-Keephugepages Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. false true (ByPropertyName) False
-Keyboard Keyboard 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,tr false true (ByPropertyName)
-Kvm Enable/disable KVM hardware virtualization. false true (ByPropertyName) False
-LiveRestore Start the VM immediately while importing or restoring in the background. false true (ByPropertyName) False
-Localtime Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. false true (ByPropertyName) False
-Lock Lock/unlock the VM. Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspended false true (ByPropertyName)
-Machine Specify the QEMU machine. false true (ByPropertyName)
-Memory Memory properties. false true (ByPropertyName)
-MigrateDowntime Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge. false true (ByPropertyName) 0
-MigrateSpeed Set maximum speed (in MB/s) for migrations. Value 0 is no limit. false true (ByPropertyName) 0
-Name Set a name for the VM. Only used on the configuration web interface. false true (ByPropertyName)
-Nameserver cloud-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. false true (ByPropertyName)
-NetN Specify network devices. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Numa Enable/disable NUMA. false true (ByPropertyName) False
-NumaN NUMA topology. false true (ByPropertyName)
-Onboot Specifies whether a VM will be started during system bootup. false true (ByPropertyName) False
-Ostype Specify guest operating system. Enum: other,wxp,w2k,w2k3,w2k8,wvista,win7,win8,win10,win11,l24,l26,solaris false true (ByPropertyName)
-ParallelN Map host parallel devices (n is 0 to 2). false true (ByPropertyName)
-Pool Add the VM to the specified pool. false true (ByPropertyName)
-Protection Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. false true (ByPropertyName) False
-Reboot Allow reboot. If set to '0' the VM exit on reboot. false true (ByPropertyName) False
-Rng0 Configure a VirtIO-based Random Number Generator. false true (ByPropertyName)
-SataN Use 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. false true (ByPropertyName)
-ScsiN Use 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. false true (ByPropertyName)
-Scsihw SCSI controller model Enum: lsi,lsi53c810,virtio-scsi-pci,virtio-scsi-single,megasas,pvscsi false true (ByPropertyName)
-Searchdomain cloud-init':' Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. false true (ByPropertyName)
-SerialN Create a serial device inside the VM (n is 0 to 3) false true (ByPropertyName)
-Shares Amount 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. false true (ByPropertyName) 0
-Smbios1 Specify SMBIOS type 1 fields. false true (ByPropertyName)
-Smp The number of CPUs. Please use option -sockets instead. false true (ByPropertyName) 0
-Sockets The number of CPU sockets. false true (ByPropertyName) 0
-SpiceEnhancements Configure additional enhancements for SPICE. false true (ByPropertyName)
-Sshkeys cloud-init':' Setup public SSH keys (one key per line, OpenSSH format). false true (ByPropertyName)
-Start Start VM after it was created successfully. false true (ByPropertyName) False
-Startdate Set the initial date of the real time clock. Valid format for date are':''now' or '2006-06-17T16':'01':'21' or '2006-06-17'. false true (ByPropertyName)
-Startup Startup 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. false true (ByPropertyName)
-Storage Default storage. false true (ByPropertyName)
-Tablet Enable/disable the USB tablet device. false true (ByPropertyName) False
-Tags Tags of the VM. This is only meta information. false true (ByPropertyName)
-Tdf Enable/disable time drift fix. false true (ByPropertyName) False
-Template Enable/disable Template. false true (ByPropertyName) False
-Tpmstate0 Configure 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. false true (ByPropertyName)
-Unique Assign a unique random ethernet address. false true (ByPropertyName) False
-UnusedN Reference to unused volumes. This is used internally, and should not be modified manually. false true (ByPropertyName)
-UsbN Configure 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). false true (ByPropertyName)
-Vcpus Number of hotplugged vcpus. false true (ByPropertyName) 0
-Vga Configure the VGA hardware. false true (ByPropertyName)
-VirtioN Use 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. false true (ByPropertyName)
-Vmgenid Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0
-Vmstatestorage Default storage for VM state volumes/files. false true (ByPropertyName)
-Watchdog Create a virtual hardware watchdog device. false true (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] [-SkipCertVerification] [[-Smbversion] <String>] [-Sparse] [-Storage] <String> [[-Subdir] <String>] [-TaggedOnly] [[-Target] <String>] [[-Thinpool] <String>] [[-Transport] <String>] [-Type] <String> [[-Username] <String>] [[-Vgname] <String>] [[-Volume] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Authsupported Authsupported. false true (ByPropertyName)
-Base Base volume. This volume is automatically activated. false true (ByPropertyName)
-Blocksize block size false true (ByPropertyName)
-Bwlimit Set I/O bandwidth limit for various operations (in KiB/s). false true (ByPropertyName)
-ComstarHg host group for comstar views false true (ByPropertyName)
-ComstarTg target group for comstar views false true (ByPropertyName)
-Content Allowed content types.NOTE':' the value 'rootdir' is used for Containers, and value 'images' for VMs. false true (ByPropertyName)
-ContentDirs Overrides for default content type directories. false true (ByPropertyName)
-CreateBasePath Create the base directory if it doesn't exist. false true (ByPropertyName) False
-CreateSubdirs Populate the directory with the default structure. false true (ByPropertyName) False
-DataPool Data Pool (for erasure coding only) false true (ByPropertyName)
-Datastore Proxmox Backup Server datastore name. false true (ByPropertyName)
-Disable Flag to disable the storage. false true (ByPropertyName) False
-Domain CIFS domain. false true (ByPropertyName)
-EncryptionKey Encryption key. Use 'autogen' to generate one automatically without passphrase. false true (ByPropertyName)
-Export NFS export path. false true (ByPropertyName)
-Fingerprint Certificate SHA 256 fingerprint. false true (ByPropertyName)
-Format Default image format. false true (ByPropertyName)
-FsName The Ceph filesystem name. false true (ByPropertyName)
-Fuse Mount CephFS through FUSE. false true (ByPropertyName) False
-IsMountpoint Assume 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. false true (ByPropertyName)
-Iscsiprovider iscsi provider false true (ByPropertyName)
-Keyring Client keyring contents (for external clusters). false true (ByPropertyName)
-Krbd Always access rbd through krbd kernel module. false true (ByPropertyName) False
-LioTpg target portal group for Linux LIO targets false true (ByPropertyName)
-MasterPubkey Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. false true (ByPropertyName)
-MaxProtectedBackups Maximal number of protected backups per guest. Use '-1' for unlimited. false true (ByPropertyName) 0
-Maxfiles Deprecated':' use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited. false true (ByPropertyName) 0
-Mkdir Create 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. false true (ByPropertyName) False
-Monhost IP addresses of monitors (for external clusters). false true (ByPropertyName)
-Mountpoint mount point false true (ByPropertyName)
-Namespace Namespace. false true (ByPropertyName)
-Nocow Set 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. false true (ByPropertyName) False
-Nodes List of nodes for which the storage configuration applies. false true (ByPropertyName)
-Nowritecache disable write caching on the target false true (ByPropertyName) False
-Options NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') false true (ByPropertyName)
-Password Password for accessing the share/datastore. false true (ByPropertyName)
-Path File system path. false true (ByPropertyName)
-Pool Pool. false true (ByPropertyName)
-Port Use this port to connect to the storage instead of the default one (for example, with PBS or ESXi). For NFS and CIFS, use the 'options' option to configure the port via the mount options. false true (ByPropertyName) 0
-Portal iSCSI portal (IP or DNS name with optional port). false true (ByPropertyName)
-Preallocation Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. Enum: off,metadata,falloc,full false true (ByPropertyName)
-PruneBackups The 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. false true (ByPropertyName)
-Saferemove Zero-out data when removing LVs. false true (ByPropertyName) False
-SaferemoveThroughput Wipe throughput (cstream -t parameter value). false true (ByPropertyName)
-Server Server IP or DNS name. false true (ByPropertyName)
-Server2 Backup volfile server IP or DNS name. false true (ByPropertyName)
-Share CIFS share. false true (ByPropertyName)
-Shared Indicate that this is a single storage with the same contents on all nodes (or all listed in the 'nodes' option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such! false true (ByPropertyName) False
-SkipCertVerification Disable TLS certificate verification, only enable on fully trusted networks! false true (ByPropertyName) False
-Smbversion SMB 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.11 false true (ByPropertyName)
-Sparse use sparse volumes false true (ByPropertyName) False
-Storage The storage identifier. true true (ByPropertyName)
-Subdir Subdir to mount. false true (ByPropertyName)
-TaggedOnly Only use logical volumes tagged with 'pve-vm-ID'. false true (ByPropertyName) False
-Target iSCSI target. false true (ByPropertyName)
-Thinpool LVM thin pool LV name. false true (ByPropertyName)
-Transport Gluster transport':' tcp or rdma Enum: tcp,rdma,unix false true (ByPropertyName)
-Type Storage type. Enum: btrfs,cephfs,cifs,dir,esxi,glusterfs,iscsi,iscsidirect,lvm,lvmthin,nfs,pbs,rbd,zfs,zfspool true true (ByPropertyName)
-Username RBD Id. false true (ByPropertyName)
-Vgname Volume group name. false true (ByPropertyName)
-Volume Glusterfs Volume. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByValue, ByPropertyName)
-VmIdOrName The (unique) ID or Name of the VM. true true (ByValue, ByPropertyName)
-Description A textual description or comment. false true (ByValue, ByPropertyName)
-Snapname The name of the snapshot. true true (ByValue, ByPropertyName)
-Vmstate Save the vmstate false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Realm Authentication domain ID true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Groupid -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Roleid -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id A TFA entry id. true true (ByPropertyName)
-Password The current password of the user performing the change. false true (ByPropertyName)
-Userid Full User ID, in the `name@realm` format. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveAccessUsers [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Userid Full User ID, in the `name@realm` format. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveAccessUsersToken [[-PveTicket] <PveTicket>] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Tokenid User-specific token identifier. true true (ByPropertyName)
-Userid Full User ID, in the `name@realm` format. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [[-Name] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name ACME account config file name. false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id Unique identifier for ACME plugin instance. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveClusterBackup [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id The job ID. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Name Alias name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Group Security Group name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Group Security Group name. true true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Force Delete all members of the IPSet, if there are any. false true (ByPropertyName) False
-Name IP set name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Name IP set name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveClusterHaGroups [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Group The HA group identifier. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Sid HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100). true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name -- true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveClusterNotificationsEndpointsWebhook [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Force Will remove the jobconfig entry, but will not cleanup. false true (ByPropertyName) False
-Id Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. true true (ByPropertyName)
-Keep Keep replicated data at target (do not remove). false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Controller The SDN controller object identifier. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Dns The SDN dns object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [-Ipam] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Ipam The SDN ipam object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [-Vnet] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Vnet The SDN vnet object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveClusterSdnVnetsFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [[-Pos] <Int32>] [-Vnet] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Vnet The SDN vnet object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Ip The IP address to delete true true (ByPropertyName)
-Mac Unicast MAC address. false true (ByPropertyName)
-Vnet The SDN vnet object identifier. true true (ByPropertyName)
-Zone The SDN zone object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [-Subnet] <String> [-Vnet] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Subnet The SDN subnet object identifier. true true (ByPropertyName)
-Vnet The SDN vnet object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-Zone] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Zone The SDN zone object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveNodesLxc [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Force] [-Node] <String> [-Purge] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-DestroyUnreferencedDisks If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config. false true (ByPropertyName) False
-Force Force destroy, even if running. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Purge Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Force For removal from config file, even if removing disk snapshots fails. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveNodesCephMds [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Name The name (ID) of the mds true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Id The ID of the manager true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Monid Monitor ID true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cleanup If set, we remove partition table entries. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Osdid OSD ID true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Force If true, destroys pool even if in use false true (ByPropertyName) False
-Name The name of the pool. It must be unique. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-RemoveEcprofile Remove the erasure code profile. Defaults to true, if applicable. false true (ByPropertyName) False
-RemoveStorages Remove all pveceph-managed storages configured for this pool false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Restart Restart pveproxy. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-CleanupConfig Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). false true (ByPropertyName) False
-CleanupDisks Also wipe disk so it can be repurposed afterwards. false true (ByPropertyName) False
-Name The storage identifier. true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-CleanupConfig Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). false true (ByPropertyName) False
-CleanupDisks Also wipe disks so they can be repurposed afterwards. false true (ByPropertyName) False
-Name The storage identifier. true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-CleanupConfig Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). false true (ByPropertyName) False
-CleanupDisks Also wipe disks so they can be repurposed afterwards. false true (ByPropertyName) False
-Name The storage identifier. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-VolumeGroup The storage identifier. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-CleanupConfig Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). false true (ByPropertyName) False
-CleanupDisks Also wipe disks so they can be repurposed afterwards. false true (ByPropertyName) False
-Name The storage identifier. true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Remove-PveLxc

Syntax

Remove-PveNodesLxc [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Force] [-Node] <String> [-Purge] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-DestroyUnreferencedDisks If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config. false true (ByPropertyName) False
-Force Force destroy, even if running. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Purge Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Name Alias name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Force Delete all members of the IPSet, if there are any. false true (ByPropertyName) False
-Name IP set name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveNodesLxcFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Name IP set name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Remove-PveLxcSnapshot

Syntax

Remove-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Force For removal from config file, even if removing disk snapshots fails. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Iface Network interface name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Aliases

  • Remove-PveQemu

Syntax

Remove-PveNodesQemu [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Node] <String> [-Purge] [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-DestroyUnreferencedDisks If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Purge Remove VMID from configurations, like backup & replication jobs and HA. false true (ByPropertyName) False
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Name Alias name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Force Delete all members of the IPSet, if there are any. false true (ByPropertyName) False
-Name IP set name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveNodesQemuFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Name IP set name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Remove-PveQemuSnapshot

Syntax

Remove-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Force For removal from config file, even if removing disk snapshots fails. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveNodesStorageContent [[-PveTicket] <PveTicket>] [[-Delay] <Int32>] [-Node] <String> [[-Storage] <String>] [-Volume] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Delay Time to wait for the task to finish. We return 'null' if the task finish within that time. false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Storage The storage identifier. false true (ByPropertyName)
-Volume Volume identifier true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-PruneBackups Use these retention options instead of those from the storage configuration. false true (ByPropertyName)
-Storage The storage identifier. true true (ByPropertyName)
-Type Either 'qemu' or 'lxc'. Only consider backups for guests of this type. Enum: qemu,lxc false true (ByPropertyName)
-Vmid Only prune backups for this VM. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Upid -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Poolid -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Poolid -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-DestroyUnreferencedDisks If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Purge Remove VMID from configurations, like backup & replication jobs and HA. false true (ByPropertyName) False
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Force For removal from config file, even if removing disk snapshots fails. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Remove-PveStorage [[-PveTicket] <PveTicket>] [-Storage] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Storage The storage identifier. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByValue, ByPropertyName)
-VmIdOrName The (unique) ID or Name of the VM. true true (ByValue, ByPropertyName)
-Snapname The name of the snapshot. true true (ByValue, ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuStatusReset [[-PveTicket] <PveTicket>] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Reset-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByValue, ByPropertyName)
-VmIdOrName The (unique) ID or Name of the VM. true true (ByValue, ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesLxcStatusReboot [[-PveTicket] <PveTicket>] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Timeout Wait maximal timeout seconds for the shutdown. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuStatusReboot [[-PveTicket] <PveTicket>] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Timeout Wait maximal timeout seconds for the shutdown. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesLxcStatusResume [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuStatusResume [[-PveTicket] <PveTicket>] [-Nocheck] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Nocheck -- false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Resume-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByValue, ByPropertyName)
-VmIdOrName The (unique) ID or Name of the VM. true true (ByValue, ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveAccessAcl [[-PveTicket] <PveTicket>] [-Delete] [[-Groups] <String>] [-Path] <String> [-Propagate] [-Roles] <String> [[-Tokens] <String>] [[-Users] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Delete Remove permissions (instead of adding it). false true (ByPropertyName) False
-Groups List of groups. false true (ByPropertyName)
-Path Access control path true true (ByPropertyName)
-Propagate Allow to propagate (inherit) permissions. false true (ByPropertyName) False
-Roles List of roles. true true (ByPropertyName)
-Tokens List of API tokens. false true (ByPropertyName)
-Users List of users. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-AcrValues Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. false true (ByPropertyName)
-Autocreate Automatically create users if they do not exist. false true (ByPropertyName) False
-BaseDn LDAP base domain name false true (ByPropertyName)
-BindDn LDAP bind domain name false true (ByPropertyName)
-Capath Path to the CA certificate store false true (ByPropertyName)
-CaseSensitive username is case-sensitive false true (ByPropertyName) False
-Cert Path to the client certificate false true (ByPropertyName)
-Certkey Path to the client certificate key false true (ByPropertyName)
-CheckConnection Check bind connection to the server. false true (ByPropertyName) False
-ClientId OpenID Client ID false true (ByPropertyName)
-ClientKey OpenID Client Key false true (ByPropertyName)
-Comment Description. false true (ByPropertyName)
-Default Use this as default realm false true (ByPropertyName) False
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Domain AD domain name false true (ByPropertyName)
-Filter LDAP filter for user sync. false true (ByPropertyName)
-GroupClasses The objectclasses for groups. false true (ByPropertyName)
-GroupDn LDAP base domain name for group sync. If not set, the base_dn will be used. false true (ByPropertyName)
-GroupFilter LDAP filter for group sync. false true (ByPropertyName)
-GroupNameAttr LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name. false true (ByPropertyName)
-IssuerUrl OpenID Issuer Url false true (ByPropertyName)
-Mode LDAP protocol mode. Enum: ldap,ldaps,ldap+starttls false true (ByPropertyName)
-Password LDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'. false true (ByPropertyName)
-Port Server port. false true (ByPropertyName) 0
-Prompt Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. false true (ByPropertyName)
-Realm Authentication domain ID true true (ByPropertyName)
-Scopes Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. false true (ByPropertyName)
-Secure Use secure LDAPS protocol. DEPRECATED':' use 'mode' instead. false true (ByPropertyName) False
-Server1 Server IP address (or DNS name) false true (ByPropertyName)
-Server2 Fallback Server IP address (or DNS name) false true (ByPropertyName)
-Sslversion LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! Enum: tlsv1,tlsv1_1,tlsv1_2,tlsv1_3 false true (ByPropertyName)
-SyncDefaultsOptions The default options for behavior of synchronizations. false true (ByPropertyName)
-SyncAttributes Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name. false true (ByPropertyName)
-Tfa Use Two-factor authentication. false true (ByPropertyName)
-UserAttr LDAP user attribute name false true (ByPropertyName)
-UserClasses The objectclasses for users. false true (ByPropertyName)
-Verify Verify the server's SSL certificate false true (ByPropertyName) False

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveAccessGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Groupid] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Groupid -- true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveAccessPassword [[-PveTicket] <PveTicket>] [[-ConfirmationPassword] <SecureString>] [-Password] <SecureString> [-Userid] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-ConfirmationPassword The current password of the user performing the change. false true (ByPropertyName)
-Password The new password. true true (ByPropertyName)
-Userid Full User ID, in the `name@realm` format. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveAccessRoles [[-PveTicket] <PveTicket>] [-Append] [[-Privs] <String>] [-Roleid] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Append -- false true (ByPropertyName) False
-Privs -- false true (ByPropertyName)
-Roleid -- true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Description A description to distinguish multiple entries from one another false true (ByPropertyName)
-Enable Whether the entry should be enabled for login. false true (ByPropertyName) False
-Id A TFA entry id. true true (ByPropertyName)
-Password The current password of the user performing the change. false true (ByPropertyName)
-Userid Full User ID, in the `name@realm` format. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Append -- false true (ByPropertyName) False
-Comment -- false true (ByPropertyName)
-Email -- false true (ByPropertyName)
-Enable Enable the account (default). You can set this to '0' to disable the account false true (ByPropertyName) False
-Expire Account expiration date (seconds since epoch). '0' means no expiration date. false true (ByPropertyName) 0
-Firstname -- false true (ByPropertyName)
-Groups -- false true (ByPropertyName)
-Keys Keys for two factor auth (yubico). false true (ByPropertyName)
-Lastname -- false true (ByPropertyName)
-Userid Full User ID, in the `name@realm` format. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveAccessUsersToken [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Expire] <Int32>] [-Privsep] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Expire API token expiration date (seconds since epoch). '0' means no expiration date. false true (ByPropertyName) 0
-Privsep Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. false true (ByPropertyName) False
-Tokenid User-specific token identifier. true true (ByPropertyName)
-Userid Full User ID, in the `name@realm` format. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveAccessUsersUnlockTfa [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Userid Full User ID, in the `name@realm` format. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [[-Contact] <String>] [[-Name] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Contact Contact email addresses. false true (ByPropertyName)
-Name ACME account config file name. false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [[-Api] <String>] [[-Data] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [-Id] <String> [[-Nodes] <String>] [[-ValidationDelay] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Api API plugin name Enum: 1984hosting,acmedns,acmeproxy,active24,ad,ali,anx,artfiles,arvan,aurora,autodns,aws,azion,azure,bookmyname,bunny,cf,clouddns,cloudns,cn,conoha,constellix,cpanel,curanet,cyon,da,ddnss,desec,df,dgon,dnsexit,dnshome,dnsimple,dnsservices,do,doapi,domeneshop,dp,dpi,dreamhost,duckdns,durabledns,dyn,dynu,dynv6,easydns,edgedns,euserv,exoscale,fornex,freedns,gandi_livedns,gcloud,gcore,gd,geoscaling,googledomains,he,hetzner,hexonet,hostingde,huaweicloud,infoblox,infomaniak,internetbs,inwx,ionos,ipv64,ispconfig,jd,joker,kappernet,kas,kinghost,knot,la,leaseweb,lexicon,linode,linode_v4,loopia,lua,maradns,me,miab,misaka,myapi,mydevil,mydnsjp,mythic_beasts,namecheap,namecom,namesilo,nanelo,nederhost,neodigit,netcup,netlify,nic,njalla,nm,nsd,nsone,nsupdate,nw,oci,one,online,openprovider,openstack,opnsense,ovh,pdns,pleskxml,pointhq,porkbun,rackcorp,rackspace,rage4,rcode0,regru,scaleway,schlundtech,selectel,selfhost,servercow,simply,tele3,tencent,transip,udr,ultra,unoeuro,variomedia,veesp,vercel,vscale,vultr,websupport,world4you,yandex,yc,zilore,zone,zonomi false true (ByPropertyName)
-Data DNS plugin data. (base64 encoded) false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Disable Flag to disable the config. false true (ByPropertyName) False
-Id ACME Plugin ID name true true (ByPropertyName)
-Nodes List of cluster node names. false true (ByPropertyName)
-ValidationDelay Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveClusterBackup [[-PveTicket] <PveTicket>] [-All] [[-Bwlimit] <Int32>] [[-Comment] <String>] [[-Compress] <String>] [[-Delete] <String>] [[-Dow] <String>] [[-Dumpdir] <String>] [-Enabled] [[-Exclude] <String>] [[-ExcludePath] <Array>] [[-Fleecing] <String>] [-Id] <String> [[-Ionice] <Int32>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <String>] [[-NotificationMode] <String>] [[-NotificationPolicy] <String>] [[-NotificationTarget] <String>] [[-PbsChangeDetectionMode] <String>] [[-Performance] <String>] [[-Pigz] <Int32>] [[-Pool] <String>] [-Protected] [[-PruneBackups] <String>] [-Quiet] [-Remove] [-RepeatMissed] [[-Schedule] <String>] [[-Script] <String>] [[-Starttime] <String>] [-Stdexcludes] [-Stop] [[-Stopwait] <Int32>] [[-Storage] <String>] [[-Tmpdir] <String>] [[-Vmid] <String>] [[-Zstd] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-All Backup all known guest systems on this host. false true (ByPropertyName) False
-Bwlimit Limit I/O bandwidth (in KiB/s). false true (ByPropertyName) 0
-Comment Description for the Job. false true (ByPropertyName)
-Compress Compress dump file. Enum: 0,1,gzip,lzo,zstd false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Dow Day of week selection. false true (ByPropertyName)
-Dumpdir Store resulting files to specified directory. false true (ByPropertyName)
-Enabled Enable or disable the job. false true (ByPropertyName) False
-Exclude Exclude specified guest systems (assumes --all) false true (ByPropertyName)
-ExcludePath Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. false true (ByPropertyName)
-Fleecing Options for backup fleecing (VM only). false true (ByPropertyName)
-Id The job ID. true true (ByPropertyName)
-Ionice Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. false true (ByPropertyName) 0
-Lockwait Maximal time to wait for the global lock (minutes). false true (ByPropertyName) 0
-Mailnotification Deprecated':' use notification targets/matchers instead. Specify when to send a notification mail Enum: always,failure false true (ByPropertyName)
-Mailto Deprecated':' Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications. false true (ByPropertyName)
-Maxfiles Deprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system. false true (ByPropertyName) 0
-Mode Backup mode. Enum: snapshot,suspend,stop false true (ByPropertyName)
-Node Only run if executed on this node. false true (ByPropertyName)
-NotesTemplate Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. false true (ByPropertyName)
-NotificationMode Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. Enum: auto,legacy-sendmail,notification-system false true (ByPropertyName)
-NotificationPolicy Deprecated':' Do not use Enum: always,failure,never false true (ByPropertyName)
-NotificationTarget Deprecated':' Do not use false true (ByPropertyName)
-PbsChangeDetectionMode PBS mode used to detect file changes and switch encoding format for container backups. Enum: legacy,data,metadata false true (ByPropertyName)
-Performance Other performance-related settings. false true (ByPropertyName)
-Pigz Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. false true (ByPropertyName) 0
-Pool Backup all known guest systems included in the specified pool. false true (ByPropertyName)
-Protected If true, mark backup(s) as protected. false true (ByPropertyName) False
-PruneBackups Use these retention options instead of those from the storage configuration. false true (ByPropertyName)
-Quiet Be quiet. false true (ByPropertyName) False
-Remove Prune older backups according to 'prune-backups'. false true (ByPropertyName) False
-RepeatMissed If true, the job will be run as soon as possible if it was missed while the scheduler was not running. false true (ByPropertyName) False
-Schedule Backup schedule. The format is a subset of `systemd` calendar events. false true (ByPropertyName)
-Script Use specified hook script. false true (ByPropertyName)
-Starttime Job Start time. false true (ByPropertyName)
-Stdexcludes Exclude temporary files and logs. false true (ByPropertyName) False
-Stop Stop running backup jobs on this host. false true (ByPropertyName) False
-Stopwait Maximal time to wait until a guest system is stopped (minutes). false true (ByPropertyName) 0
-Storage Store resulting file to this storage. false true (ByPropertyName)
-Tmpdir Store temporary files to specified directory. false true (ByPropertyName)
-Vmid The ID of the guest system you want to backup. false true (ByPropertyName)
-Zstd Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. false true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveClusterCephFlags [[-PveTicket] <PveTicket>] [-Nobackfill] [-NodeepScrub] [-Nodown] [-Noin] [-Noout] [-Norebalance] [-Norecover] [-Noscrub] [-Notieragent] [-Noup] [-Pause] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Nobackfill Backfilling of PGs is suspended. false true (ByPropertyName) False
-NodeepScrub Deep Scrubbing is disabled. false true (ByPropertyName) False
-Nodown OSD failure reports are being ignored, such that the monitors will not mark OSDs down. false true (ByPropertyName) False
-Noin OSDs that were previously marked out will not be marked back in when they start. false true (ByPropertyName) False
-Noout OSDs will not automatically be marked out after the configured interval. false true (ByPropertyName) False
-Norebalance Rebalancing of PGs is suspended. false true (ByPropertyName) False
-Norecover Recovery of PGs is suspended. false true (ByPropertyName) False
-Noscrub Scrubbing is disabled. false true (ByPropertyName) False
-Notieragent Cache tiering activity is suspended. false true (ByPropertyName) False
-Noup OSDs are not allowed to start. false true (ByPropertyName) False
-Pause Pauses read and writes. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Flag The ceph flag to update Enum: nobackfill,nodeep-scrub,nodown,noin,noout,norebalance,norecover,noscrub,notieragent,noup,pause true true (ByPropertyName)
-Value The new value of the flag true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Name Alias name. true true (ByPropertyName)
-Rename Rename an existing alias. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Action Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. false true (ByPropertyName)
-Comment Descriptive comment. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Dest Restrict 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. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Dport Restrict 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. false true (ByPropertyName)
-Enable Flag to enable/disable a rule. false true (ByPropertyName) 0
-Group Security Group name. true true (ByPropertyName)
-IcmpType Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. false true (ByPropertyName)
-Iface Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. false true (ByPropertyName)
-Log Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-Macro Use predefined standard macro. false true (ByPropertyName)
-Moveto Move rule to new position <moveto>. Other arguments are ignored. false true (ByPropertyName) 0
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Proto IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. false true (ByPropertyName)
-Source Restrict 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. false true (ByPropertyName)
-Sport Restrict 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. false true (ByPropertyName)
-Type Rule type. Enum: in,out,forward,group false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Name IP set name. true true (ByPropertyName)
-Nomatch -- false true (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>] [[-PolicyForward] <String>] [[-PolicyIn] <String>] [[-PolicyOut] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Ebtables Enable ebtables rules cluster wide. false true (ByPropertyName) False
-Enable Enable or disable the firewall cluster wide. false true (ByPropertyName) 0
-LogRatelimit Log ratelimiting settings false true (ByPropertyName)
-PolicyForward Forward policy. Enum: ACCEPT,DROP false true (ByPropertyName)
-PolicyIn Input policy. Enum: ACCEPT,REJECT,DROP false true (ByPropertyName)
-PolicyOut Output policy. Enum: ACCEPT,REJECT,DROP false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Action Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. false true (ByPropertyName)
-Comment Descriptive comment. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Dest Restrict 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. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Dport Restrict 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. false true (ByPropertyName)
-Enable Flag to enable/disable a rule. false true (ByPropertyName) 0
-IcmpType Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. false true (ByPropertyName)
-Iface Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. false true (ByPropertyName)
-Log Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-Macro Use predefined standard macro. false true (ByPropertyName)
-Moveto Move rule to new position <moveto>. Other arguments are ignored. false true (ByPropertyName) 0
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Proto IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. false true (ByPropertyName)
-Source Restrict 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. false true (ByPropertyName)
-Sport Restrict 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. false true (ByPropertyName)
-Type Rule type. Enum: in,out,forward,group false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment Description. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Group The HA group identifier. true true (ByPropertyName)
-Nodes List of cluster node names with optional priority. false true (ByPropertyName)
-Nofailback The 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. false true (ByPropertyName) False
-Restricted Resources bound to restricted groups may only run on nodes defined by the group. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment Description. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Group The HA group identifier. false true (ByPropertyName)
-MaxRelocate Maximal number of service relocate tries when a service failes to start. false true (ByPropertyName) 0
-MaxRestart Maximal number of tries to restart the service on a node after its start failed. false true (ByPropertyName) 0
-Sid HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100). true true (ByPropertyName)
-State Requested resource state. Enum: started,stopped,enabled,disabled,ignored false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment Description for the Job. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-EnableNew Enable newly synced users immediately. false true (ByPropertyName) False
-Enabled Determines if the job is enabled. false true (ByPropertyName) False
-Id The ID of the job. true true (ByPropertyName)
-RemoveVanished A semicolon-seperated list of things to remove when they or the user vanishes during a sync. The following values are possible':' 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default). false true (ByPropertyName)
-Schedule Backup schedule. The format is a subset of `systemd` calendar events. true true (ByPropertyName)
-Scope Select what to sync. Enum: users,groups,both false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveClusterMappingPci [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [-Id] <String> [[-Map] <Array>] [-Mdev] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Description Description of the logical PCI device. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Id The ID of the logical PCI mapping. true true (ByPropertyName)
-Map A list of maps for the cluster nodes. false true (ByPropertyName)
-Mdev Marks the device(s) as being capable of providing mediated devices. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Description Description of the logical USB device. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Id The ID of the logical USB mapping. true true (ByPropertyName)
-Map A list of maps for the cluster nodes. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-ApiPathPrefix An API path prefix inserted between '<host>':'<port>/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy. false true (ByPropertyName)
-Bucket The InfluxDB bucket/db. Only necessary when using the http v2 api. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Disable Flag to disable the plugin. false true (ByPropertyName) False
-Id The ID of the entry. true true (ByPropertyName)
-Influxdbproto -- Enum: udp,http,https false true (ByPropertyName)
-MaxBodySize InfluxDB max-body-size in bytes. Requests are batched up to this size. false true (ByPropertyName) 0
-Mtu MTU for metrics transmission over UDP false true (ByPropertyName) 0
-Organization The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api. false true (ByPropertyName)
-Path root graphite path (ex':' proxmox.mycluster.mykey) false true (ByPropertyName)
-Port server network port true true (ByPropertyName) 0
-Proto Protocol to send graphite data. TCP or UDP (default) Enum: udp,tcp false true (ByPropertyName)
-Server server dns name or IP address true true (ByPropertyName)
-Timeout graphite TCP socket timeout (default=1) false true (ByPropertyName) 0
-Token The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user':'password' instead. false true (ByPropertyName)
-VerifyCertificate Set to 0 to disable certificate verification for https endpoints. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment Comment false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Disable Disable this target false true (ByPropertyName) False
-Name The name of the endpoint. true true (ByPropertyName)
-Server Server URL false true (ByPropertyName)
-Token Secret token false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Author Author of the mail false true (ByPropertyName)
-Comment Comment false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Disable Disable this target false true (ByPropertyName) False
-FromAddress `From` address for the mail false true (ByPropertyName)
-Mailto List of email recipients false true (ByPropertyName)
-MailtoUser List of users false true (ByPropertyName)
-Name The name of the endpoint. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Author Author of the mail. Defaults to 'Proxmox VE'. false true (ByPropertyName)
-Comment Comment false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Disable Disable this target false true (ByPropertyName) False
-FromAddress `From` address for the mail false true (ByPropertyName)
-Mailto List of email recipients false true (ByPropertyName)
-MailtoUser List of users false true (ByPropertyName)
-Mode Determine which encryption method shall be used for the connection. Enum: insecure,starttls,tls false true (ByPropertyName)
-Name The name of the endpoint. true true (ByPropertyName)
-Password Password for SMTP authentication false true (ByPropertyName)
-Port The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections. false true (ByPropertyName) 0
-Server The address of the SMTP server. false true (ByPropertyName)
-Username Username for SMTP authentication false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveClusterNotificationsEndpointsWebhook [[-PveTicket] <PveTicket>] [[-Body] <String>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [[-Header] <Array>] [[-Method] <String>] [-Name] <String> [[-Secret] <Array>] [[-Url] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Body HTTP body, base64 encoded false true (ByPropertyName)
-Comment Comment false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Disable Disable this target false true (ByPropertyName) False
-Header HTTP headers to set. These have to be formatted as a property string in the format name=<name>,value=<base64 of value> false true (ByPropertyName)
-Method HTTP method Enum: post,put,get false true (ByPropertyName)
-Name The name of the endpoint. true true (ByPropertyName)
-Secret Secrets to set. These have to be formatted as a property string in the format name=<name>,value=<base64 of value> false true (ByPropertyName)
-Url Server URL false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment Comment false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Disable Disable this matcher false true (ByPropertyName) False
-InvertMatch Invert match of the whole matcher false true (ByPropertyName) False
-MatchCalendar Match notification timestamp false true (ByPropertyName)
-MatchField Metadata fields to match (regex or exact match). Must be in the form (regex|exact)':'<field>=<value> false true (ByPropertyName)
-MatchSeverity Notification severities to match false true (ByPropertyName)
-Mode Choose between 'all' and 'any' for when multiple properties are specified Enum: all,any false true (ByPropertyName)
-Name Name of the matcher. true true (ByPropertyName)
-Target Targets to notify on match false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Bwlimit Set I/O bandwidth limit for various operations (in KiB/s). false true (ByPropertyName)
-Console Select 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,xtermjs false true (ByPropertyName)
-Crs Cluster resource scheduling settings. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Description Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file. false true (ByPropertyName)
-EmailFrom Specify email address to send notification from (default is root@$hostname) false true (ByPropertyName)
-Fencing Set 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,both false true (ByPropertyName)
-Ha Cluster wide HA settings. false true (ByPropertyName)
-HttpProxy Specify external http proxy which is used for downloads (example':' 'http':'//username':'password@host':'port/') false true (ByPropertyName)
-Keyboard Default 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,tr false true (ByPropertyName)
-Language Default 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_TW false true (ByPropertyName)
-MacPrefix Prefix 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). false true (ByPropertyName)
-MaxWorkers Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager. false true (ByPropertyName) 0
-Migration For cluster wide migration settings. false true (ByPropertyName)
-MigrationUnsecure Migration 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! false true (ByPropertyName) False
-NextId Control the range for the free VMID auto-selection pool. false true (ByPropertyName)
-Notify Cluster-wide notification settings. false true (ByPropertyName)
-RegisteredTags A 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`. false true (ByPropertyName)
-TagStyle Tag style options. false true (ByPropertyName)
-U2f u2f false true (ByPropertyName)
-UserTagAccess Privilege options for user-settable tags false true (ByPropertyName)
-Webauthn webauthn configuration false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Comment Description. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Disable Flag to disable/deactivate the entry. false true (ByPropertyName) False
-Id Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. true true (ByPropertyName)
-Rate Rate limit in mbps (megabytes per second) as floating point number. false true (ByPropertyName) 0
-RemoveJob Mark 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,full false true (ByPropertyName)
-Schedule Storage replication schedule. The format is a subset of `systemd` calendar events. false true (ByPropertyName)
-Source For internal use, to detect if the guest was stolen. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Asn autonomous system number false true (ByPropertyName) 0
-BgpMultipathAsPathRelax -- false true (ByPropertyName) False
-Controller The SDN controller object identifier. true true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Ebgp Enable ebgp. (remote-as external) false true (ByPropertyName) False
-EbgpMultihop -- false true (ByPropertyName) 0
-IsisDomain ISIS domain. false true (ByPropertyName)
-IsisIfaces ISIS interface. false true (ByPropertyName)
-IsisNet ISIS network entity title. false true (ByPropertyName)
-Loopback source loopback interface. false true (ByPropertyName)
-Node The cluster node name. false true (ByPropertyName)
-Peers peers address list. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Dns The SDN dns object identifier. true true (ByPropertyName)
-Key -- false true (ByPropertyName)
-Reversemaskv6 -- false true (ByPropertyName) 0
-Ttl -- false true (ByPropertyName) 0
-Url -- false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Ipam The SDN ipam object identifier. true true (ByPropertyName)
-Section -- false true (ByPropertyName) 0
-Token -- false true (ByPropertyName)
-Url -- false true (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>] [-IsolatePorts] [[-Tag] <Int32>] [-Vlanaware] [-Vnet] <String> [[-Zone] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Alias alias name of the vnet false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-IsolatePorts If true, sets the isolated property for all members of this VNet false true (ByPropertyName) False
-Tag vlan or vxlan id false true (ByPropertyName) 0
-Vlanaware Allow vm VLANs to pass through this vnet. false true (ByPropertyName) False
-Vnet The SDN vnet object identifier. true true (ByPropertyName)
-Zone zone id false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveClusterSdnVnetsFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Enable] [[-LogLevelForward] <String>] [[-PolicyForward] <String>] [-Vnet] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Enable Enable/disable firewall rules. false true (ByPropertyName) False
-LogLevelForward Log level for forwarded traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-PolicyForward Forward policy. Enum: ACCEPT,DROP false true (ByPropertyName)
-Vnet The SDN vnet object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveClusterSdnVnetsFirewallRules [[-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>] [-Vnet] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Action Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. false true (ByPropertyName)
-Comment Descriptive comment. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Dest Restrict 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. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Dport Restrict 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. false true (ByPropertyName)
-Enable Flag to enable/disable a rule. false true (ByPropertyName) 0
-IcmpType Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. false true (ByPropertyName)
-Iface Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. false true (ByPropertyName)
-Log Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-Macro Use predefined standard macro. false true (ByPropertyName)
-Moveto Move rule to new position <moveto>. Other arguments are ignored. false true (ByPropertyName) 0
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Proto IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. false true (ByPropertyName)
-Source Restrict 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. false true (ByPropertyName)
-Sport Restrict 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. false true (ByPropertyName)
-Type Rule type. Enum: in,out,forward,group false true (ByPropertyName)
-Vnet The SDN vnet object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [[-Vmid] <Int32>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Ip The IP address to associate with the given MAC address true true (ByPropertyName)
-Mac Unicast MAC address. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. false true (ByPropertyName) 0
-Vnet The SDN vnet object identifier. true true (ByPropertyName)
-Zone The SDN zone object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-DhcpDnsServer] <String>] [[-DhcpRange] <Array>] [[-Digest] <String>] [[-Dnszoneprefix] <String>] [[-Gateway] <String>] [-Snat] [-Subnet] <String> [[-Vnet] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-DhcpDnsServer IP address for the DNS server false true (ByPropertyName)
-DhcpRange A list of DHCP ranges for this subnet false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Dnszoneprefix dns domain zone prefix ex':' 'adm' -> <hostname>.adm.mydomain.com false true (ByPropertyName)
-Gateway Subnet Gateway':' Will be assign on vnet for layer3 zones false true (ByPropertyName)
-Snat enable masquerade for this subnet if pve-firewall false true (ByPropertyName) False
-Subnet The SDN subnet object identifier. true true (ByPropertyName)
-Vnet associated vnet false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-AdvertiseSubnets Advertise evpn subnets if you have silent hosts false true (ByPropertyName) False
-Bridge -- false true (ByPropertyName)
-BridgeDisableMacLearning Disable auto mac learning. false true (ByPropertyName) False
-Controller Frr router name false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Dhcp Type of the DHCP backend for this zone Enum: dnsmasq false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-DisableArpNdSuppression Disable ipv4 arp && ipv6 neighbour discovery suppression false true (ByPropertyName) False
-Dns dns api server false true (ByPropertyName)
-Dnszone dns domain zone ex':' mydomain.com false true (ByPropertyName)
-DpId Faucet dataplane id false true (ByPropertyName) 0
-Exitnodes List of cluster node names. false true (ByPropertyName)
-ExitnodesLocalRouting Allow exitnodes to connect to evpn guests false true (ByPropertyName) False
-ExitnodesPrimary Force traffic to this exitnode first. false true (ByPropertyName)
-Ipam use a specific ipam false true (ByPropertyName)
-Mac Anycast logical router mac address false true (ByPropertyName)
-Mtu MTU false true (ByPropertyName) 0
-Nodes List of cluster node names. false true (ByPropertyName)
-Peers peers address list. false true (ByPropertyName)
-Reversedns reverse dns api server false true (ByPropertyName)
-RtImport Route-Target import false true (ByPropertyName)
-Tag Service-VLAN Tag false true (ByPropertyName) 0
-VlanProtocol -- Enum: 802.1q,802.1ad false true (ByPropertyName)
-VrfVxlan l3vni. false true (ByPropertyName) 0
-VxlanPort Vxlan tunnel udp port (default 4789). false true (ByPropertyName) 0
-Zone The SDN zone object identifier. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Arch OS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64 false true (ByPropertyName)
-Cmode Console 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,tty false true (ByPropertyName)
-Console Attach a console device (/dev/console) to the container. false true (ByPropertyName) False
-Cores The number of cores assigned to the container. A container can use all available cores by default. false true (ByPropertyName) 0
-Cpulimit Limit of CPU usage.NOTE':' If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. false true (ByPropertyName) 0
-Cpuunits CPU weight for a container, will be clamped to \[1, 10000] in cgroup v2. false true (ByPropertyName) 0
-Debug_ Try to be more verbose. For now this only enables debug log-level on start. false true (ByPropertyName) False
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Description Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. false true (ByPropertyName)
-DevN Device to pass through to the container false true (ByPropertyName)
-Digest Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Features Allow containers access to advanced features. false true (ByPropertyName)
-Hookscript Script that will be executed during various steps in the containers lifetime. false true (ByPropertyName)
-Hostname Set a host name for the container. false true (ByPropertyName)
-Lock Lock/unlock the container. Enum: backup,create,destroyed,disk,fstrim,migrate,mounted,rollback,snapshot,snapshot-delete false true (ByPropertyName)
-Memory Amount of RAM for the container in MB. false true (ByPropertyName) 0
-MpN Use volume as container mount point. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. false true (ByPropertyName)
-Nameserver Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. false true (ByPropertyName)
-NetN Specifies network interfaces for the container. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Onboot Specifies whether a container will be started during system bootup. false true (ByPropertyName) False
-Ostype OS 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,unmanaged false true (ByPropertyName)
-Protection Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. false true (ByPropertyName) False
-Revert Revert a pending change. false true (ByPropertyName)
-Rootfs Use volume as container root. false true (ByPropertyName)
-Searchdomain Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. false true (ByPropertyName)
-Startup Startup 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. false true (ByPropertyName)
-Swap Amount of SWAP for the container in MB. false true (ByPropertyName) 0
-Tags Tags of the Container. This is only meta information. false true (ByPropertyName)
-Template Enable/disable Template. false true (ByPropertyName) False
-Timezone Time 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.tab false true (ByPropertyName)
-Tty Specify the number of tty available to the container false true (ByPropertyName) 0
-Unprivileged Makes the container run as unprivileged user. (Should not be modified manually.) false true (ByPropertyName) False
-UnusedN Reference to unused volumes. This is used internally, and should not be modified manually. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveNodesLxcSnapshotConfig [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Description A textual description or comment. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Handle] <String> [-Node] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Digest Digest to detect modifications. false true (ByPropertyName)
-Handle Handle that identifies a repository. true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Application The application of the pool. Enum: rbd,cephfs,rgw false true (ByPropertyName)
-CrushRule The rule to use for mapping object placement in the cluster. false true (ByPropertyName)
-MinSize Minimum number of replicas per object false true (ByPropertyName) 0
-Name The name of the pool. It must be unique. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-PgAutoscaleMode The automatic PG scaling mode of the pool. Enum: on,off,warn false true (ByPropertyName)
-PgNum Number of placement groups. false true (ByPropertyName) 0
-PgNumMin Minimal number of placement groups. false true (ByPropertyName) 0
-Size Number of replicas per object false true (ByPropertyName) 0
-TargetSize The estimated target size of the pool for the PG autoscaler. false true (ByPropertyName)
-TargetSizeRatio The estimated target ratio of the pool for the PG autoscaler. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Force Force renewal even if expiry is more than 30 days away. false true (ByPropertyName) False
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Acme Node specific ACME settings. false true (ByPropertyName)
-AcmedomainN ACME domain and validation plugin false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Description Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-StartallOnbootDelay Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled. false true (ByPropertyName) 0
-Wakeonlan Node specific wake on LAN settings. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Disk Block device name true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Dns1 First name server IP address. false true (ByPropertyName)
-Dns2 Second name server IP address. false true (ByPropertyName)
-Dns3 Third name server IP address. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Search Search domain for host-name lookup. true true (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] [[-LogLevelForward] <String>] [[-LogLevelIn] <String>] [[-LogLevelOut] <String>] [-LogNfConntrack] [-Ndp] [-NfConntrackAllowInvalid] [[-NfConntrackHelpers] <String>] [[-NfConntrackMax] <Int32>] [[-NfConntrackTcpTimeoutEstablished] <Int32>] [[-NfConntrackTcpTimeoutSynRecv] <Int32>] [-Nftables] [-Node] <String> [-Nosmurfs] [-ProtectionSynflood] [[-ProtectionSynfloodBurst] <Int32>] [[-ProtectionSynfloodRate] <Int32>] [[-SmurfLogLevel] <String>] [[-TcpFlagsLogLevel] <String>] [-Tcpflags] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Enable Enable host firewall rules. false true (ByPropertyName) False
-LogLevelForward Log level for forwarded traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-LogLevelIn Log level for incoming traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-LogLevelOut Log level for outgoing traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-LogNfConntrack Enable logging of conntrack information. false true (ByPropertyName) False
-Ndp Enable NDP (Neighbor Discovery Protocol). false true (ByPropertyName) False
-NfConntrackAllowInvalid Allow invalid packets on connection tracking. false true (ByPropertyName) False
-NfConntrackHelpers Enable conntrack helpers for specific protocols. Supported protocols':' amanda, ftp, irc, netbios-ns, pptp, sane, sip, snmp, tftp false true (ByPropertyName)
-NfConntrackMax Maximum number of tracked connections. false true (ByPropertyName) 0
-NfConntrackTcpTimeoutEstablished Conntrack established timeout. false true (ByPropertyName) 0
-NfConntrackTcpTimeoutSynRecv Conntrack syn recv timeout. false true (ByPropertyName) 0
-Nftables Enable nftables based firewall (tech preview) false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Nosmurfs Enable SMURFS filter. false true (ByPropertyName) False
-ProtectionSynflood Enable synflood protection false true (ByPropertyName) False
-ProtectionSynfloodBurst Synflood protection rate burst by ip src. false true (ByPropertyName) 0
-ProtectionSynfloodRate Synflood protection rate syn/sec by ip src. false true (ByPropertyName) 0
-SmurfLogLevel Log level for SMURFS filter. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-TcpFlagsLogLevel Log level for illegal tcp flags filter. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-Tcpflags Filter illegal combinations of TCP flags. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Action Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. false true (ByPropertyName)
-Comment Descriptive comment. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Dest Restrict 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. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Dport Restrict 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. false true (ByPropertyName)
-Enable Flag to enable/disable a rule. false true (ByPropertyName) 0
-IcmpType Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. false true (ByPropertyName)
-Iface Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. false true (ByPropertyName)
-Log Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-Macro Use predefined standard macro. false true (ByPropertyName)
-Moveto Move rule to new position <moveto>. Other arguments are ignored. false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Proto IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. false true (ByPropertyName)
-Source Restrict 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. false true (ByPropertyName)
-Sport Restrict 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. false true (ByPropertyName)
-Type Rule type. Enum: in,out,forward,group false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Aliases

  • Set-PveLxcConfig

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Arch OS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64 false true (ByPropertyName)
-Cmode Console 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,tty false true (ByPropertyName)
-Console Attach a console device (/dev/console) to the container. false true (ByPropertyName) False
-Cores The number of cores assigned to the container. A container can use all available cores by default. false true (ByPropertyName) 0
-Cpulimit Limit of CPU usage.NOTE':' If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. false true (ByPropertyName) 0
-Cpuunits CPU weight for a container, will be clamped to \[1, 10000] in cgroup v2. false true (ByPropertyName) 0
-Debug_ Try to be more verbose. For now this only enables debug log-level on start. false true (ByPropertyName) False
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Description Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. false true (ByPropertyName)
-DevN Device to pass through to the container false true (ByPropertyName)
-Digest Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Features Allow containers access to advanced features. false true (ByPropertyName)
-Hookscript Script that will be executed during various steps in the containers lifetime. false true (ByPropertyName)
-Hostname Set a host name for the container. false true (ByPropertyName)
-Lock Lock/unlock the container. Enum: backup,create,destroyed,disk,fstrim,migrate,mounted,rollback,snapshot,snapshot-delete false true (ByPropertyName)
-Memory Amount of RAM for the container in MB. false true (ByPropertyName) 0
-MpN Use volume as container mount point. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. false true (ByPropertyName)
-Nameserver Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. false true (ByPropertyName)
-NetN Specifies network interfaces for the container. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Onboot Specifies whether a container will be started during system bootup. false true (ByPropertyName) False
-Ostype OS 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,unmanaged false true (ByPropertyName)
-Protection Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. false true (ByPropertyName) False
-Revert Revert a pending change. false true (ByPropertyName)
-Rootfs Use volume as container root. false true (ByPropertyName)
-Searchdomain Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. false true (ByPropertyName)
-Startup Startup 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. false true (ByPropertyName)
-Swap Amount of SWAP for the container in MB. false true (ByPropertyName) 0
-Tags Tags of the Container. This is only meta information. false true (ByPropertyName)
-Template Enable/disable Template. false true (ByPropertyName) False
-Timezone Time 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.tab false true (ByPropertyName)
-Tty Specify the number of tty available to the container false true (ByPropertyName) 0
-Unprivileged Makes the container run as unprivileged user. (Should not be modified manually.) false true (ByPropertyName) False
-UnusedN Reference to unused volumes. This is used internally, and should not be modified manually. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Name Alias name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Rename Rename an existing alias. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Name IP set name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Nomatch -- false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Dhcp Enable DHCP. false true (ByPropertyName) False
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Enable Enable/disable firewall rules. false true (ByPropertyName) False
-Ipfilter Enable 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. false true (ByPropertyName) False
-LogLevelIn Log level for incoming traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-LogLevelOut Log level for outgoing traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-Macfilter Enable/disable MAC address filter. false true (ByPropertyName) False
-Ndp Enable NDP (Neighbor Discovery Protocol). false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-PolicyIn Input policy. Enum: ACCEPT,REJECT,DROP false true (ByPropertyName)
-PolicyOut Output policy. Enum: ACCEPT,REJECT,DROP false true (ByPropertyName)
-Radv Allow sending Router Advertisement. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Action Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. false true (ByPropertyName)
-Comment Descriptive comment. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Dest Restrict 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. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Dport Restrict 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. false true (ByPropertyName)
-Enable Flag to enable/disable a rule. false true (ByPropertyName) 0
-IcmpType Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. false true (ByPropertyName)
-Iface Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. false true (ByPropertyName)
-Log Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-Macro Use predefined standard macro. false true (ByPropertyName)
-Moveto Move rule to new position <moveto>. Other arguments are ignored. false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Proto IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. false true (ByPropertyName)
-Source Restrict 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. false true (ByPropertyName)
-Sport Restrict 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. false true (ByPropertyName)
-Type Rule type. Enum: in,out,forward,group false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveNodesLxcResize [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Disk] <String> [-Node] <String> [-Size] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Disk The 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,mp255 true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Size The 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. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Set-PveLxcSnapshot

Syntax

Set-PveNodesLxcSnapshotConfig [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Description A textual description or comment. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (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>] [[-BridgeVids] <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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Address IP address. false true (ByPropertyName)
-Address6 IP address. false true (ByPropertyName)
-Autostart Automatically start interface on boot. false true (ByPropertyName) False
-BondPrimary Specify the primary interface for active-backup bond. false true (ByPropertyName)
-BondMode Bonding mode. Enum: balance-rr,active-backup,balance-xor,broadcast,802.3ad,balance-tlb,balance-alb,balance-slb,lacp-balance-slb,lacp-balance-tcp false true (ByPropertyName)
-BondXmitHashPolicy Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. Enum: layer2,layer2+3,layer3+4 false true (ByPropertyName)
-BridgePorts Specify the interfaces you want to add to your bridge. false true (ByPropertyName)
-BridgeVids Specify the allowed VLANs. For example':' '2 4 100-200'. Only used if the bridge is VLAN aware. false true (ByPropertyName)
-BridgeVlanAware Enable bridge vlan support. false true (ByPropertyName) False
-Cidr IPv4 CIDR. false true (ByPropertyName)
-Cidr6 IPv6 CIDR. false true (ByPropertyName)
-Comments Comments false true (ByPropertyName)
-Comments6 Comments false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Gateway Default gateway address. false true (ByPropertyName)
-Gateway6 Default ipv6 gateway address. false true (ByPropertyName)
-Iface Network interface name. true true (ByPropertyName)
-Mtu MTU. false true (ByPropertyName) 0
-Netmask Network mask. false true (ByPropertyName)
-Netmask6 Network mask. false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-OvsBonds Specify the interfaces used by the bonding device. false true (ByPropertyName)
-OvsBridge The OVS bridge associated with a OVS port. This is required when you create an OVS port. false true (ByPropertyName)
-OvsOptions OVS interface options. false true (ByPropertyName)
-OvsPorts Specify the interfaces you want to add to your bridge. false true (ByPropertyName)
-OvsTag Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond) false true (ByPropertyName) 0
-Slaves Specify the interfaces used by the bonding device. false true (ByPropertyName)
-Type Network interface type Enum: bridge,bond,eth,alias,vlan,OVSBridge,OVSBond,OVSPort,OVSIntPort,unknown true true (ByPropertyName)
-VlanId vlan-id for a custom named vlan interface (ifupdown2 only). false true (ByPropertyName) 0
-VlanRawDevice Specify the raw interface for the vlan interface. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Set-PveQemuConfig

Syntax

Set-PveNodesQemuConfig [[-PveTicket] <PveTicket>] [-Acpi] [[-Affinity] <String>] [[-Agent] <String>] [[-AmdSev] <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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Acpi Enable/disable ACPI. false true (ByPropertyName) False
-Affinity List of host cores used to execute guest processes, for example':' 0,5,8-11 false true (ByPropertyName)
-Agent Enable/disable communication with the QEMU Guest Agent and its properties. false true (ByPropertyName)
-AmdSev Secure Encrypted Virtualization (SEV) features by AMD CPUs false true (ByPropertyName)
-Arch Virtual processor architecture. Defaults to the host. Enum: x86_64,aarch64 false true (ByPropertyName)
-Args_ Arbitrary arguments passed to kvm. false true (ByPropertyName)
-Audio0 Configure a audio device, useful in combination with QXL/Spice. false true (ByPropertyName)
-Autostart Automatic restart after crash (currently ignored). false true (ByPropertyName) False
-Balloon Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. false true (ByPropertyName) 0
-Bios Select BIOS implementation. Enum: seabios,ovmf false true (ByPropertyName)
-Boot Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. false true (ByPropertyName)
-Bootdisk Enable booting from specified disk. Deprecated':' Use 'boot':' order=foo;bar' instead. false true (ByPropertyName)
-Cdrom This is an alias for option -ide2 false true (ByPropertyName)
-Cicustom cloud-init':' Specify custom files to replace the automatically generated ones at start. false true (ByPropertyName)
-Cipassword cloud-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. false true (ByPropertyName)
-Citype Specifies 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,opennebula false true (ByPropertyName)
-Ciupgrade cloud-init':' do an automatic package upgrade after the first boot. false true (ByPropertyName) False
-Ciuser cloud-init':' User name to change ssh keys and password for instead of the image's configured default user. false true (ByPropertyName)
-Cores The number of cores per socket. false true (ByPropertyName) 0
-Cpu Emulated CPU type. false true (ByPropertyName)
-Cpulimit Limit of CPU usage. false true (ByPropertyName) 0
-Cpuunits CPU weight for a VM, will be clamped to \[1, 10000] in cgroup v2. false true (ByPropertyName) 0
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Description Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Efidisk0 Configure 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. false true (ByPropertyName)
-Force Force 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. false true (ByPropertyName) False
-Freeze Freeze CPU at startup (use 'c' monitor command to start execution). false true (ByPropertyName) False
-Hookscript Script that will be executed during various steps in the vms lifetime. false true (ByPropertyName)
-HostpciN Map host PCI devices into guest. false true (ByPropertyName)
-Hotplug Selectively 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. false true (ByPropertyName)
-Hugepages Enable/disable hugepages memory. Enum: any,2,1024 false true (ByPropertyName)
-IdeN Use 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. false true (ByPropertyName)
-IpconfigN cloud-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. false true (ByPropertyName)
-Ivshmem Inter-VM shared memory. Useful for direct communication between VMs, or to the host. false true (ByPropertyName)
-Keephugepages Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. false true (ByPropertyName) False
-Keyboard Keyboard 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,tr false true (ByPropertyName)
-Kvm Enable/disable KVM hardware virtualization. false true (ByPropertyName) False
-Localtime Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. false true (ByPropertyName) False
-Lock Lock/unlock the VM. Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspended false true (ByPropertyName)
-Machine Specify the QEMU machine. false true (ByPropertyName)
-Memory Memory properties. false true (ByPropertyName)
-MigrateDowntime Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge. false true (ByPropertyName) 0
-MigrateSpeed Set maximum speed (in MB/s) for migrations. Value 0 is no limit. false true (ByPropertyName) 0
-Name Set a name for the VM. Only used on the configuration web interface. false true (ByPropertyName)
-Nameserver cloud-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. false true (ByPropertyName)
-NetN Specify network devices. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Numa Enable/disable NUMA. false true (ByPropertyName) False
-NumaN NUMA topology. false true (ByPropertyName)
-Onboot Specifies whether a VM will be started during system bootup. false true (ByPropertyName) False
-Ostype Specify guest operating system. Enum: other,wxp,w2k,w2k3,w2k8,wvista,win7,win8,win10,win11,l24,l26,solaris false true (ByPropertyName)
-ParallelN Map host parallel devices (n is 0 to 2). false true (ByPropertyName)
-Protection Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. false true (ByPropertyName) False
-Reboot Allow reboot. If set to '0' the VM exit on reboot. false true (ByPropertyName) False
-Revert Revert a pending change. false true (ByPropertyName)
-Rng0 Configure a VirtIO-based Random Number Generator. false true (ByPropertyName)
-SataN Use 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. false true (ByPropertyName)
-ScsiN Use 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. false true (ByPropertyName)
-Scsihw SCSI controller model Enum: lsi,lsi53c810,virtio-scsi-pci,virtio-scsi-single,megasas,pvscsi false true (ByPropertyName)
-Searchdomain cloud-init':' Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. false true (ByPropertyName)
-SerialN Create a serial device inside the VM (n is 0 to 3) false true (ByPropertyName)
-Shares Amount 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. false true (ByPropertyName) 0
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Smbios1 Specify SMBIOS type 1 fields. false true (ByPropertyName)
-Smp The number of CPUs. Please use option -sockets instead. false true (ByPropertyName) 0
-Sockets The number of CPU sockets. false true (ByPropertyName) 0
-SpiceEnhancements Configure additional enhancements for SPICE. false true (ByPropertyName)
-Sshkeys cloud-init':' Setup public SSH keys (one key per line, OpenSSH format). false true (ByPropertyName)
-Startdate Set the initial date of the real time clock. Valid format for date are':''now' or '2006-06-17T16':'01':'21' or '2006-06-17'. false true (ByPropertyName)
-Startup Startup 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. false true (ByPropertyName)
-Tablet Enable/disable the USB tablet device. false true (ByPropertyName) False
-Tags Tags of the VM. This is only meta information. false true (ByPropertyName)
-Tdf Enable/disable time drift fix. false true (ByPropertyName) False
-Template Enable/disable Template. false true (ByPropertyName) False
-Tpmstate0 Configure 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. false true (ByPropertyName)
-UnusedN Reference to unused volumes. This is used internally, and should not be modified manually. false true (ByPropertyName)
-UsbN Configure 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). false true (ByPropertyName)
-Vcpus Number of hotplugged vcpus. false true (ByPropertyName) 0
-Vga Configure the VGA hardware. false true (ByPropertyName)
-VirtioN Use 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. false true (ByPropertyName)
-Vmgenid Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0
-Vmstatestorage Default storage for VM state volumes/files. false true (ByPropertyName)
-Watchdog Create a virtual hardware watchdog device. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Name Alias name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Rename Rename an existing alias. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Cidr Network/IP specification in CIDR format. true true (ByPropertyName)
-Comment -- false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Name IP set name. true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Nomatch -- false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Dhcp Enable DHCP. false true (ByPropertyName) False
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Enable Enable/disable firewall rules. false true (ByPropertyName) False
-Ipfilter Enable 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. false true (ByPropertyName) False
-LogLevelIn Log level for incoming traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-LogLevelOut Log level for outgoing traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-Macfilter Enable/disable MAC address filter. false true (ByPropertyName) False
-Ndp Enable NDP (Neighbor Discovery Protocol). false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-PolicyIn Input policy. Enum: ACCEPT,REJECT,DROP false true (ByPropertyName)
-PolicyOut Output policy. Enum: ACCEPT,REJECT,DROP false true (ByPropertyName)
-Radv Allow sending Router Advertisement. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Action Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. false true (ByPropertyName)
-Comment Descriptive comment. false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Dest Restrict 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. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Dport Restrict 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. false true (ByPropertyName)
-Enable Flag to enable/disable a rule. false true (ByPropertyName) 0
-IcmpType Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. false true (ByPropertyName)
-Iface Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. false true (ByPropertyName)
-Log Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog false true (ByPropertyName)
-Macro Use predefined standard macro. false true (ByPropertyName)
-Moveto Move rule to new position <moveto>. Other arguments are ignored. false true (ByPropertyName) 0
-Node The cluster node name. true true (ByPropertyName)
-Pos Update rule at position <pos>. false true (ByPropertyName) 0
-Proto IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. false true (ByPropertyName)
-Source Restrict 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. false true (ByPropertyName)
-Sport Restrict 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. false true (ByPropertyName)
-Type Rule type. Enum: in,out,forward,group false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveNodesQemuResize [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Disk] <String> [-Node] <String> [-Size] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Disk The 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,tpmstate0 true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Size The 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. true true (ByPropertyName)
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveNodesQemuSendkey [[-PveTicket] <PveTicket>] [-Key] <String> [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Key The key (qemu monitor encoding). true true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Aliases

  • Set-PveQemuSnapshot

Syntax

Set-PveNodesQemuSnapshotConfig [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Description A textual description or comment. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Set-PveNodesStorageContent [[-PveTicket] <PveTicket>] [-Node] <String> [[-Notes] <String>] [-Protected] [[-Storage] <String>] [-Volume] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Notes The new notes. false true (ByPropertyName)
-Protected Protection status. Currently only supported for backups. false true (ByPropertyName) False
-Storage The storage identifier. false true (ByPropertyName)
-Volume Volume identifier true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Key Proxmox VE subscription key true true (ByPropertyName)
-Node The cluster node name. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Timezone Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-AllowMove Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one. false true (ByPropertyName) False
-Comment -- false true (ByPropertyName)
-Delete Remove the passed VMIDs and/or storage IDs instead of adding them. false true (ByPropertyName) False
-Poolid -- true true (ByPropertyName)
-Storage List of storage IDs to add or remove from this pool. false true (ByPropertyName)
-Vms List of guest VMIDs to add or remove from this pool. false true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-AllowMove Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one. false true (ByPropertyName) False
-Comment -- false true (ByPropertyName)
-Delete Remove the passed VMIDs and/or storage IDs instead of adding them. false true (ByPropertyName) False
-Poolid -- true true (ByPropertyName)
-Storage List of storage IDs to add or remove from this pool. false true (ByPropertyName)
-Vms List of guest VMIDs to add or remove from this pool. false true (ByPropertyName)

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>] [[-AmdSev] <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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Acpi Enable/disable ACPI. false true (ByPropertyName) False
-Affinity List of host cores used to execute guest processes, for example':' 0,5,8-11 false true (ByPropertyName)
-Agent Enable/disable communication with the QEMU Guest Agent and its properties. false true (ByPropertyName)
-AmdSev Secure Encrypted Virtualization (SEV) features by AMD CPUs false true (ByPropertyName)
-Arch Virtual processor architecture. Defaults to the host. Enum: x86_64,aarch64 false true (ByPropertyName)
-Args_ Arbitrary arguments passed to kvm. false true (ByPropertyName)
-Audio0 Configure a audio device, useful in combination with QXL/Spice. false true (ByPropertyName)
-Autostart Automatic restart after crash (currently ignored). false true (ByPropertyName) False
-Balloon Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. false true (ByPropertyName) 0
-Bios Select BIOS implementation. Enum: seabios,ovmf false true (ByPropertyName)
-Boot Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. false true (ByPropertyName)
-Bootdisk Enable booting from specified disk. Deprecated':' Use 'boot':' order=foo;bar' instead. false true (ByPropertyName)
-Cdrom This is an alias for option -ide2 false true (ByPropertyName)
-Cicustom cloud-init':' Specify custom files to replace the automatically generated ones at start. false true (ByPropertyName)
-Cipassword cloud-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. false true (ByPropertyName)
-Citype Specifies 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,opennebula false true (ByPropertyName)
-Ciupgrade cloud-init':' do an automatic package upgrade after the first boot. false true (ByPropertyName) False
-Ciuser cloud-init':' User name to change ssh keys and password for instead of the image's configured default user. false true (ByPropertyName)
-Cores The number of cores per socket. false true (ByPropertyName) 0
-Cpu Emulated CPU type. false true (ByPropertyName)
-Cpulimit Limit of CPU usage. false true (ByPropertyName) 0
-Cpuunits CPU weight for a VM, will be clamped to \[1, 10000] in cgroup v2. false true (ByPropertyName) 0
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Description Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Efidisk0 Configure 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. false true (ByPropertyName)
-Force Force 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. false true (ByPropertyName) False
-Freeze Freeze CPU at startup (use 'c' monitor command to start execution). false true (ByPropertyName) False
-Hookscript Script that will be executed during various steps in the vms lifetime. false true (ByPropertyName)
-HostpciN Map host PCI devices into guest. false true (ByPropertyName)
-Hotplug Selectively 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. false true (ByPropertyName)
-Hugepages Enable/disable hugepages memory. Enum: any,2,1024 false true (ByPropertyName)
-IdeN Use 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. false true (ByPropertyName)
-IpconfigN cloud-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. false true (ByPropertyName)
-Ivshmem Inter-VM shared memory. Useful for direct communication between VMs, or to the host. false true (ByPropertyName)
-Keephugepages Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. false true (ByPropertyName) False
-Keyboard Keyboard 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,tr false true (ByPropertyName)
-Kvm Enable/disable KVM hardware virtualization. false true (ByPropertyName) False
-Localtime Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. false true (ByPropertyName) False
-Lock Lock/unlock the VM. Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspended false true (ByPropertyName)
-Machine Specify the QEMU machine. false true (ByPropertyName)
-Memory Memory properties. false true (ByPropertyName)
-MigrateDowntime Set maximum tolerated downtime (in seconds) for migrations. Should the migration not be able to converge in the very end, because too much newly dirtied RAM needs to be transferred, the limit will be increased automatically step-by-step until migration can converge. false true (ByPropertyName) 0
-MigrateSpeed Set maximum speed (in MB/s) for migrations. Value 0 is no limit. false true (ByPropertyName) 0
-Name Set a name for the VM. Only used on the configuration web interface. false true (ByPropertyName)
-Nameserver cloud-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. false true (ByPropertyName)
-NetN Specify network devices. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Numa Enable/disable NUMA. false true (ByPropertyName) False
-NumaN NUMA topology. false true (ByPropertyName)
-Onboot Specifies whether a VM will be started during system bootup. false true (ByPropertyName) False
-Ostype Specify guest operating system. Enum: other,wxp,w2k,w2k3,w2k8,wvista,win7,win8,win10,win11,l24,l26,solaris false true (ByPropertyName)
-ParallelN Map host parallel devices (n is 0 to 2). false true (ByPropertyName)
-Protection Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. false true (ByPropertyName) False
-Reboot Allow reboot. If set to '0' the VM exit on reboot. false true (ByPropertyName) False
-Revert Revert a pending change. false true (ByPropertyName)
-Rng0 Configure a VirtIO-based Random Number Generator. false true (ByPropertyName)
-SataN Use 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. false true (ByPropertyName)
-ScsiN Use 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. false true (ByPropertyName)
-Scsihw SCSI controller model Enum: lsi,lsi53c810,virtio-scsi-pci,virtio-scsi-single,megasas,pvscsi false true (ByPropertyName)
-Searchdomain cloud-init':' Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. false true (ByPropertyName)
-SerialN Create a serial device inside the VM (n is 0 to 3) false true (ByPropertyName)
-Shares Amount 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. false true (ByPropertyName) 0
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Smbios1 Specify SMBIOS type 1 fields. false true (ByPropertyName)
-Smp The number of CPUs. Please use option -sockets instead. false true (ByPropertyName) 0
-Sockets The number of CPU sockets. false true (ByPropertyName) 0
-SpiceEnhancements Configure additional enhancements for SPICE. false true (ByPropertyName)
-Sshkeys cloud-init':' Setup public SSH keys (one key per line, OpenSSH format). false true (ByPropertyName)
-Startdate Set the initial date of the real time clock. Valid format for date are':''now' or '2006-06-17T16':'01':'21' or '2006-06-17'. false true (ByPropertyName)
-Startup Startup 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. false true (ByPropertyName)
-Tablet Enable/disable the USB tablet device. false true (ByPropertyName) False
-Tags Tags of the VM. This is only meta information. false true (ByPropertyName)
-Tdf Enable/disable time drift fix. false true (ByPropertyName) False
-Template Enable/disable Template. false true (ByPropertyName) False
-Tpmstate0 Configure 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. false true (ByPropertyName)
-UnusedN Reference to unused volumes. This is used internally, and should not be modified manually. false true (ByPropertyName)
-UsbN Configure 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). false true (ByPropertyName)
-Vcpus Number of hotplugged vcpus. false true (ByPropertyName) 0
-Vga Configure the VGA hardware. false true (ByPropertyName)
-VirtioN Use 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. false true (ByPropertyName)
-Vmgenid Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. false true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0
-Vmstatestorage Default storage for VM state volumes/files. false true (ByPropertyName)
-Watchdog Create a virtual hardware watchdog device. false true (ByPropertyName)

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Description A textual description or comment. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

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] [-SkipCertVerification] [[-Smbversion] <String>] [-Sparse] [-Storage] <String> [[-Subdir] <String>] [-TaggedOnly] [[-Transport] <String>] [[-Username] <String>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Blocksize block size false true (ByPropertyName)
-Bwlimit Set I/O bandwidth limit for various operations (in KiB/s). false true (ByPropertyName)
-ComstarHg host group for comstar views false true (ByPropertyName)
-ComstarTg target group for comstar views false true (ByPropertyName)
-Content Allowed content types.NOTE':' the value 'rootdir' is used for Containers, and value 'images' for VMs. false true (ByPropertyName)
-ContentDirs Overrides for default content type directories. false true (ByPropertyName)
-CreateBasePath Create the base directory if it doesn't exist. false true (ByPropertyName) False
-CreateSubdirs Populate the directory with the default structure. false true (ByPropertyName) False
-DataPool Data Pool (for erasure coding only) false true (ByPropertyName)
-Delete A list of settings you want to delete. false true (ByPropertyName)
-Digest Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. false true (ByPropertyName)
-Disable Flag to disable the storage. false true (ByPropertyName) False
-Domain CIFS domain. false true (ByPropertyName)
-EncryptionKey Encryption key. Use 'autogen' to generate one automatically without passphrase. false true (ByPropertyName)
-Fingerprint Certificate SHA 256 fingerprint. false true (ByPropertyName)
-Format Default image format. false true (ByPropertyName)
-FsName The Ceph filesystem name. false true (ByPropertyName)
-Fuse Mount CephFS through FUSE. false true (ByPropertyName) False
-IsMountpoint Assume 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. false true (ByPropertyName)
-Keyring Client keyring contents (for external clusters). false true (ByPropertyName)
-Krbd Always access rbd through krbd kernel module. false true (ByPropertyName) False
-LioTpg target portal group for Linux LIO targets false true (ByPropertyName)
-MasterPubkey Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. false true (ByPropertyName)
-MaxProtectedBackups Maximal number of protected backups per guest. Use '-1' for unlimited. false true (ByPropertyName) 0
-Maxfiles Deprecated':' use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited. false true (ByPropertyName) 0
-Mkdir Create 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. false true (ByPropertyName) False
-Monhost IP addresses of monitors (for external clusters). false true (ByPropertyName)
-Mountpoint mount point false true (ByPropertyName)
-Namespace Namespace. false true (ByPropertyName)
-Nocow Set 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. false true (ByPropertyName) False
-Nodes List of nodes for which the storage configuration applies. false true (ByPropertyName)
-Nowritecache disable write caching on the target false true (ByPropertyName) False
-Options NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') false true (ByPropertyName)
-Password Password for accessing the share/datastore. false true (ByPropertyName)
-Pool Pool. false true (ByPropertyName)
-Port Use this port to connect to the storage instead of the default one (for example, with PBS or ESXi). For NFS and CIFS, use the 'options' option to configure the port via the mount options. false true (ByPropertyName) 0
-Preallocation Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. Enum: off,metadata,falloc,full false true (ByPropertyName)
-PruneBackups The 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. false true (ByPropertyName)
-Saferemove Zero-out data when removing LVs. false true (ByPropertyName) False
-SaferemoveThroughput Wipe throughput (cstream -t parameter value). false true (ByPropertyName)
-Server Server IP or DNS name. false true (ByPropertyName)
-Server2 Backup volfile server IP or DNS name. false true (ByPropertyName)
-Shared Indicate that this is a single storage with the same contents on all nodes (or all listed in the 'nodes' option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such! false true (ByPropertyName) False
-SkipCertVerification Disable TLS certificate verification, only enable on fully trusted networks! false true (ByPropertyName) False
-Smbversion SMB 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.11 false true (ByPropertyName)
-Sparse use sparse volumes false true (ByPropertyName) False
-Storage The storage identifier. true true (ByPropertyName)
-Subdir Subdir to mount. false true (ByPropertyName)
-TaggedOnly Only use logical volumes tagged with 'pve-vm-ID'. false true (ByPropertyName) False
-Transport Gluster transport':' tcp or rdma Enum: tcp,rdma,unix false true (ByPropertyName)
-Username RBD Id. false true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

Invoke-PveSpice [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Viewer] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByValue, ByPropertyName)
-VmIdOrName The (unique) ID or Name of the VM. true true (ByValue, ByPropertyName)
-Viewer Path of Spice remove viewer.- Linux /usr/bin/remote-viewer- Windows C:\Program Files\VirtViewer v?.?-???\bin\remote-viewer.exe true true (ByValue, ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesLxcStatusShutdown [[-PveTicket] <PveTicket>] [-Forcestop] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Forcestop Make sure the Container stops. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Timeout Wait maximal timeout seconds. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuStatusShutdown [[-PveTicket] <PveTicket>] [-Forcestop] [-Keepactive] [-Node] <String> [-Skiplock] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Forcestop Make sure the VM stops. false true (ByPropertyName) False
-Keepactive Do not deactivate storage volumes. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Timeout Wait maximal timeout seconds. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesLxcStatusStart [[-PveTicket] <PveTicket>] [-Debug_] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Debug_ If set, enables very verbose debug log-level on start. false true (ByPropertyName) False
-Node The cluster node name. true true (ByPropertyName)
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-ForceCpu Override QEMU's -cpu argument with the given string. false true (ByPropertyName)
-Machine Specify the QEMU machine. false true (ByPropertyName)
-Migratedfrom The cluster node name. false true (ByPropertyName)
-MigrationNetwork CIDR of the (sub) network that is used for migration. false true (ByPropertyName)
-MigrationType Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. Enum: secure,insecure false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Stateuri Some command save/restore state from this location. false true (ByPropertyName)
-Targetstorage Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. false true (ByPropertyName)
-Timeout Wait maximal timeout seconds. false true (ByPropertyName) 0
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Start-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByValue, ByPropertyName)
-VmIdOrName The (unique) ID or Name of the VM. true true (ByValue, ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesLxcStatusStop [[-PveTicket] <PveTicket>] [-Node] <String> [-OverruleShutdown] [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-OverruleShutdown Try to abort active 'vzshutdown' tasks before stopping. false true (ByPropertyName) False
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Syntax

Stop-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByValue, ByPropertyName)
-VmIdOrName The (unique) ID or Name of the VM. true true (ByValue, ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesLxcStatusSuspend [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuStatusSuspend [[-PveTicket] <PveTicket>] [-Node] <String> [-Skiplock] [[-Statestorage] <String>] [-Todisk] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Skiplock Ignore locks - only root is allowed to use this option. false true (ByPropertyName) False
-Statestorage The storage for the VM state false true (ByPropertyName)
-Todisk If set, suspends the VM to disk. Will be resumed on next VM start. false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Suspend-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByValue, ByPropertyName)
-VmIdOrName The (unique) ID or Name of the VM. true true (ByValue, ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesLxcSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Start Whether the container should get started after rolling back successfully false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesQemuSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Snapname The name of the snapshot. true true (ByPropertyName)
-Start Whether the VM should get started after rolling back successfully. (Note':' VMs will be automatically started if the snapshot includes RAM.) false true (ByPropertyName) False
-Vmid The (unique) ID of the VM. true true (ByPropertyName) 0

Outputs

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

  • PveResponse. Return response.

Syntax

Undo-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Snapname] <String> [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByValue, ByPropertyName)
-VmIdOrName The (unique) ID or Name of the VM. true true (ByValue, ByPropertyName)
-Snapname The name of the snapshot. true true (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

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByValue, ByPropertyName)
-VmIdOrName The (unique) ID or Name of the VM. true true (ByValue, ByPropertyName)

Outputs

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

  • PveResponse. Return response.

Syntax

New-PveNodesAptUpdate [[-PveTicket] <PveTicket>] [-Node] <String> [-Notify] [-Quiet] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByPropertyName)
-Node The cluster node name. true true (ByPropertyName)
-Notify Send notification about new packages. false true (ByPropertyName) False
-Quiet Only produces output suitable for logging, omitting progress indicators. false true (ByPropertyName) False

Outputs

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

  • PveResponse. Return response.

Parameters

Name Alias Description Required? Pipeline Input Default Value
-Vm None false false
-VmIdOrName None false false

Syntax

Wait-PveTaskIsFinish [[-PveTicket] <PveTicket>] [-Upid] <String> [[-Wait] <Int32>] [[-Timeout] <Int32>] [<CommonParameters>]

Parameters

Name Alias Description Required? Pipeline Input Default Value
-PveTicket Ticket data connection. false true (ByValue, ByPropertyName)
-Upid Upid task e.g UPID:pve1:00004A1A:0964214C:5EECEF11:vzdump:134:root@pam: true true (ByValue, ByPropertyName)
-Wait Millisecond wait next check false true (ByValue, ByPropertyName) 500
-Timeout Millisecond timeout false true (ByValue, ByPropertyName) 10000

Outputs

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

  • Bool. Return tas is running.