cv4pve-api-powershell

PowerShell Gallery Version download

ProxmoxVE Api

PowerShell Gallery

    ______                _                      __
   / ____/___  __________(_)___ _   _____  _____/ /_
  / /   / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/
 / /___/ /_/ / /  (__  ) / / / / |/ /  __(__  ) /_
 \____/\____/_/  /____/_/_/ /_/|___/\___/____/\__/

powerShell for Proxmox VE         (Made in Italy)

cv4pve-api-powershell is a part of suite cv4pve.
For more information visit https://www.corsinvest.it/cv4pve

Copyright: Corsinvest Srl For licensing details please visit LICENSE

🦺 Commercial Support

This software is part of a suite of tools called cv4pve. If you want commercial support, visit the site

Introduction

PowerShell for Proxmox VE.

PowerShell for Proxmox VE

this is a CmdLet for PowerShell to manage Proxmox VE.

🚀 Main features

  • Easy to learn
  • Set ResponseType json, png, extjs, html, text
  • Full class and method generated from documentation (about client)
  • Comment any method and parameters
  • Parameters indexed eg [n] is structured in array index and value
  • Return data Proxmox VE
  • Return result class more information PveResponse
    • Request
    • Response
    • Status
  • Utility
    • ConvertFrom-PveUnixTime
    • Wait-PveTaskIsFinish
    • Get-PveTaskIsRunning
    • Build-PveDocumentation
    • Get-PveVm (from id or name)
    • Unlock-PveVm (from id or name)
    • Start-PveVm (from id or name)
    • Stop-PveVm (from id or name)
    • Suspend-PveVm (from id or name)
    • Resume-PveVm (from id or name)
    • Reset-PveVm (from id or name)
    • And More
  • Method direct access using Invoke-PveRestApi return PveResponse
  • Connect-PveCluster accept multiple hosts for HA
  • Completely written in PowerShell
  • Use native api REST Proxmox VE
  • Independent os (Windows, Linux, Macosx)
  • Installation from PowerShellGallery or download file
  • Not require installation in Proxmox VE
  • Execute out side Proxmox VE
  • Open Source
  • Form Proxmox VE 6.2 support Api Token for user
  • Enter-PveSpice enter Spice VM
  • Login with One-time password for Two-factor authentication

📙 Documentation

Documentation

Tutorial

Tutorial interactive in VSCode notebook

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!

Build documentation

For build documentation use command Build-PveDocumentation

This command accept TemplateFile parameter is a template for generate documentation. The default file.

Syntax

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

Parameters

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.

Aliases

  • Show-PveSpice

Syntax

Enter-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

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-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-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 -- 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-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-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 Vm 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> [-Pciid] <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)
-Pciid -- 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> [-Pciid] <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)
-Pciid The PCI ID to list the mdev types for. true true (ByPropertyName)

Outputs

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

  • PveResponse. Return response.

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.

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.

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-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.

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.

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-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-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-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,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-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 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}

Parameters

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

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. 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>] [[-Id] <String>] [[-Ionice] <Int32>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <String>] [[-NotificationPolicy] <String>] [[-NotificationTarget] <String>] [[-Performance] <String>] [[-Pigz] <Int32>] [[-Pool] <String>] [-Protected] [[-PruneBackups] <String>] [-Quiet] [-Remove] [-RepeatMissed] [[-Schedule] <String>] [[-Script] <String>] [[-Starttime] <String>] [-Stdexcludes] [-Stop] [[-Stopwait] <Int32>] [[-Storage] <String>] [[-Tmpdir] <String>] [[-Vmid] <String>] [[-Zstd] <Int32>] [<CommonParameters>]

Parameters

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)
-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-policy' instead. Enum: always,failure false true (ByPropertyName)
-Mailto Comma-separated list of email addresses or users that should receive email notifications. Has no effect if the 'notification-target' option is set at the same time. 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)
-NotificationPolicy Specify when to send a notification Enum: always,failure,never false true (ByPropertyName)
-NotificationTarget Determine the target to which notifications should be sent. Can either be a notification endpoint or a notification group. This option takes precedence over 'mailto', meaning that if both are set, the 'mailto' option will be ignored. 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, N>0 uses N 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,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,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 -- 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)