cv4pve-api-powershell
______ _ __
/ ____/___ __________(_)___ _ _____ _____/ /_
/ / / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/
/ /___/ /_/ / / (__ ) / / / / |/ / __(__ ) /_
\____/\____/_/ /____/_/_/ /_/|___/\___/____/\__/
powerShell for Proxmox VE (Made in Italy)
cv4pve-api-powershell is a part of suite cv4pve.
For more information visit https://www.corsinvest.it/cv4pve
📰 Copyright
Copyright: Corsinvest Srl For licensing details please visit LICENSE
🦺 Commercial Support
This software is part of a suite of tools called cv4pve. If you want commercial support, visit the site
Introduction
PowerShell for Proxmox VE.
this is a CmdLet for PowerShell to manage Proxmox VE.
🚀 Main features
- Easy to learn
- Set ResponseType json, png, extjs, html, text
- Full class and method generated from documentation (about client)
- Comment any method and parameters
- Parameters indexed eg [n] is structured in array index and value
- Return data Proxmox VE
- Return result class more information PveResponse
- Request
- Response
- Status
- Utility
- ConvertFrom-PveUnixTime
- Wait-PveTaskIsFinish
- Get-PveTaskIsRunning
- Build-PveDocumentation
- Get-PveVm (from id or name)
- Unlock-PveVm (from id or name)
- Start-PveVm (from id or name)
- Stop-PveVm (from id or name)
- Suspend-PveVm (from id or name)
- Resume-PveVm (from id or name)
- Reset-PveVm (from id or name)
- And More
- Method direct access using Invoke-PveRestApi return PveResponse
- Connect-PveCluster accept multiple hosts for HA
- Completely written in PowerShell
- Use native api REST Proxmox VE
- Independent os (Windows, Linux, Macosx)
- Installation from PowerShellGallery or download file
- Not require installation in Proxmox VE
- Execute out side Proxmox VE
- Open Source
- Form Proxmox VE 6.2 support Api Token for user
- Enter-PveSpice enter Spice VM
- Login with One-time password for Two-factor authentication
📙 Documentation
Tutorial
Tutorial interactive in VSCode notebook
Video
Requirement
Minimum version requirement for Powershell is 6.0
Installation
Install PowerShell in your system.
From PowerShell Gallery
Open PowerShell and install module form gallery
PS /home/frank> Install-Module -Name Corsinvest.ProxmoxVE.Api
Manual
Download folder Corsinvest.ProxmoxVE.Api and copy in path module
# show path module
PS /home/frank> [Environment]::GetEnvironmentVariable("PSModulePath")
Api token
From version 6.2 of Proxmox VE is possible to use Api token. This feature permit execute Api without using user and password. If using Privilege Separation when create api token remember specify in permission. Format USER@REALM!TOKENID=UUID
Connect to cluster
For connection use the function Connect-PveCluster. This function generate a Ticket object that refer a PveTicket class. The first connection saved ticket data in the variable $Global:PveTicketLast. In the various functions, the -PveTicket parameter is the connection reference ticket. If not specified will be used $Global:PveTicketLast.
PveTicket Class
This class contain data after connection and login Connect-PveCluster
class PveTicket {
[string] $HostName = ''
[int] $Port = 8006
[bool] $SkipCertificateCheck = $true
[string] $Ticket = ''
[string] $CSRFPreventionToken = ''
[string] $ApiToken = ''
}
PveResponse Class
This class contain data after execution any command
class PveResponse {
#Contain real response of Proxmox VE
#Is converted in object Json response
[PSCustomObject] $Response
[int] $StatusCode = 200
[string] $ReasonPhrase
[bool] $IsSuccessStatusCode = $true
[string] $RequestResource
[hashtable] $Parameters
[string] $Method
[string] $ResponseType
[bool] ResponseInError() { return $null -ne $this.Response.error }
[PSCustomObject] ToTable() { return $this.Response.data | Format-Table -Property * }
[PSCustomObject] ToData() { return $this.Response.data }
[void] ToCsv([string] $filename) { $this.Response.data | Export-Csv $filename }
[void] ToGridView() { $this.Response.data | Out-GridView -Title "View Result Data" }
}
Usage
Example Connect and get version
#Connection to cluster user and password
PS /home/frank> Connect-PveCluster -HostsAndPorts 192.168.190.191:8006,192.168.190.192 -SkipCertificateCheck
PowerShell credential request
Proxmox VE Username and password, username formatted as user@pam, user@pve, user@yourdomain or user (default domain pam).
User: test
Password for user test: ****
#return Ticket, default set $Global:PveTicketLast
#this is useful when connections to multiple clusters are needed use parameter -SkipRefreshPveTicketLast
HostName : 192.168.190.191
Port : 8006
SkipCertificateCheck : True
Ticket : PVE:test@pam:5EFF3CCA::iXhSNb5NTgNUYznf93mBOhj8pqYvAXoecKBHCXa3coYwBWjsWO/x8TO1gIDX0yz9nfHuvY3alJ0+Ew5AouOTZlZl3NODO9Cp4Hl87qnzhsz4wvoYEzvS1NUOTBekt+yAa68jdbhP
OzhOd8ozEEQIK7Fw2lOSa0qBFUTZRoMtnCnlsjk/Nn3kNEnZrkHXRGm46fA+asprvr0nslLxJgPGh94Xxd6jpNDj+xJnp9u6W3PxiAojM9g7IRurbp7ZCJvAgHbA9FqxibpgjaVm4NCd8LdkLDgCROxgYCjI3eR
gjkDvu1P7lLjK9JxSzqnCWWD739DT3P3bW+Ac3SyVqTf8sw==
CSRFPreventionToken : 5EFF3CCA:Cu0NuFiL6CkhFdha2V+HHigMQPk
#Connection to cluster using Api Token
PS /home/frank> Connect-PveCluster -HostsAndPorts 192.168.190.191:8006,192.168.190.192 -SkipCertificateCheck -ApiToken root@pam!qqqqqq=8a8c1cd4-d373-43f1-b366-05ce4cb8061f
HostName : 192.168.190.191
Port : 8006
SkipCertificateCheck : True
Ticket :
CSRFPreventionToken :
ApiToken : root@pam!qqqqqq=8a8c1cd4-d373-43f1-b366-05ce4cb8061f
#For disable output call Connect-PveCluster > $null
#Get version
PS /home/frank> $ret = Get-PveVersion
#$ret return a class PveResponse
#Show data
PS /home/frank> $ret.Response.data
repoid release keyboard version
------ ------- -------- -------
d0ec33c6 15 it 5.4
#Show data 2
PS /home/frank> $ret.ToTable()
repoid release keyboard version
------ ------- -------- -------
d0ec33c6 15 it 5.4
Get snapshots of vm
PS /home/frank> (Get-PveNodesQemuSnapshot -Node pve1 -Vmid 100).ToTable()
vmstate name parent description snaptime
------- ---- ------ ----------- --------
0 autowin10service200221183059 autowin10service200220183012 cv4pve-autosnap 1582306261
0 autowin10service200220183012 autowin10service200219183012 cv4pve-autosnap 1582219813
0 autowin10service200224183012 autowin10service200223183014 cv4pve-autosnap 1582565413
0 autowin10service200223183014 autowin10service200222183019 cv4pve-autosnap 1582479015
0 autowin10service200215183012 autowin10service200214183012 cv4pve-autosnap 1581787814
0 autowin10service200216183017 autowin10service200215183012 cv4pve-autosnap 1581874219
0 autowin10service200218183010 autowin10service200216183017 cv4pve-autosnap 1582047011
0 autowin10service200219183012 autowin10service200218183010 cv4pve-autosnap 1582133413
0 autowin10service200214183012 cv4pve-autosnap 1581701413
0 autowin10service200222183019 autowin10service200221183059 cv4pve-autosnap 1582392621
current autowin10service200224183012 You are here!
Other method
(Get-PveVm -VmIdOrName 100 | Get-PveNodesQemuSnapshot).ToTable()
vmstate name parent description snaptime
------- ---- ------ ----------- --------
0 autowin10service200221183059 autowin10service200220183012 cv4pve-autosnap 1582306261
0 autowin10service200220183012 autowin10service200219183012 cv4pve-autosnap 1582219813
0 autowin10service200224183012 autowin10service200223183014 cv4pve-autosnap 1582565413
0 autowin10service200223183014 autowin10service200222183019 cv4pve-autosnap 1582479015
0 autowin10service200215183012 autowin10service200214183012 cv4pve-autosnap 1581787814
0 autowin10service200216183017 autowin10service200215183012 cv4pve-autosnap 1581874219
0 autowin10service200218183010 autowin10service200216183017 cv4pve-autosnap 1582047011
0 autowin10service200219183012 autowin10service200218183010 cv4pve-autosnap 1582133413
0 autowin10service200214183012 cv4pve-autosnap 1581701413
0 autowin10service200222183019 autowin10service200221183059 cv4pve-autosnap 1582392621
current autowin10service200224183012 You are here!
Indexed data parameter
if you need to pass indexed parameters e.g. (-ScsiN, -IdeN, -NetN) you must use the following way:
#create variabile
$networkConfig = @{ 1 = [uri]::EscapeDataString("model=virtio,bridge=vmbr0") }
$storageConfig = @{ 1 = 'ssdpool:32' }
$bootableIso = @{ 1 = 'local:iso/ubuntu.iso' }
#use variable
New-PveNodesQemu -Node $node -Vmid 105 -Memory 2048 -ScsiN $storageConfig -IdeN $bootableIso -NetN $networkConfig
The [uri]::EscapeDataString escape value to pass.
Build documentation
For build documentation use command Build-PveDocumentation
This command accept TemplateFile parameter is a template for generate documentation. The default file.
Build-PveDocumentation
Build documentation for Power Shell command For Proxmox VE
Syntax
Build-PveDocumentation [[-TemplateFile] <String>] [-OutputFile] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Template file for generation documentation | false | false | https://raw.githubusercontent.com/corsinvest/cv4pve-api-powershell/master/help-out-html.ps1 | ||
| Output file | true | false |
Outputs
The output type is the type of the objects that the cmdlet emits.
- System.Void
Connect-PveCluster
Connect to Proxmox VE Cluster.
Syntax
Connect-PveCluster [-HostsAndPorts] <String[]> [[-Credentials] <PSCredential>] [[-ApiToken] <String>] [[-Otp] <String>] [-SkipCertificateCheck] [-SkipRefreshPveTicketLast] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Host and portsFormat 10.1.1.90:8006,10.1.1.91:8006,10.1.1.92:8006. | true | true (ByValue, ByPropertyName) | |||
| Username and password, username formatted as user@pam, user@pve, user@yourdomain or user (default domain pam). | false | false | |||
| Api Token format USER@REALM!TOKENID=UUID | false | false | |||
| One-time password for Two-factor authentication. | false | false | |||
| Skips certificate validation checks. | false | false | False | ||
| Skip refresh PveTicket Last global variable | false | false | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveTicket. Return ticket connection.
Examples
EXAMPLE 1
$PveTicket = Connect-PveCluster -HostsAndPorts 192.168.128.115 -Credentials (Get-Credential -Username 'root').
ConvertFrom-PveUnixTime
Convert Unix Time in DateTime
Syntax
ConvertFrom-PveUnixTime [-Time] <Int64> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Unix Time | true | false | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- DateTime. Return DateTime from Unix Time.
ConvertTo-PveUnixTime
Convert datetime objects to UNIX time.
Convert System.DateTime objects to UNIX time.
Syntax
ConvertTo-PveUnixTime [-Date] <DateTime> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Date time | true | true (ByValue) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- [Int32]. Return Unix Time.
Enter-PveSpice
Enter Spice VM.
Aliases
- Show-PveSpice
Syntax
Enter-PveSpice [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Viewer] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The (unique) ID or Name of the VM. | true | true (ByValue, ByPropertyName) | |||
| Path of Spice remove viewer.- Linux /usr/bin/remote-viewer- Windows C:\Program Files\VirtViewer v?.?-???\bin\remote-viewer.exe | true | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccess
Directory index.
Syntax
Get-PveAccess [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessAcl
Get Access Control List (ACLs).
Syntax
Get-PveAccessAcl [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessDomains
Authentication domain index.
Syntax
Get-PveAccessDomains [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessDomainsIdx
Get auth server configuration.
Syntax
Get-PveAccessDomainsIdx [[-PveTicket] <PveTicket>] [-Realm] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Authentication domain ID | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessGroups
Group index.
Syntax
Get-PveAccessGroups [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessGroupsIdx
Get group configuration.
Syntax
Get-PveAccessGroupsIdx [[-PveTicket] <PveTicket>] [-Groupid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessOpenid
Directory index.
Syntax
Get-PveAccessOpenid [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessPermissions
Retrieve effective permissions of given user/token.
Syntax
Get-PveAccessPermissions [[-PveTicket] <PveTicket>] [[-Path] <String>] [[-Userid] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only dump this specific path, not the whole tree. | false | true (ByPropertyName) | |||
| User ID or full API token ID | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessRoles
Role index.
Syntax
Get-PveAccessRoles [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessRolesIdx
Get role configuration.
Syntax
Get-PveAccessRolesIdx [[-PveTicket] <PveTicket>] [-Roleid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessTfa
List TFA configurations of users.
Syntax
Get-PveAccessTfa [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessTfaIdx
Fetch a requested TFA entry if present.
Syntax
Get-PveAccessTfaIdx [[-PveTicket] <PveTicket>] [-Id] <String> [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A TFA entry id. | true | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessTicket
Dummy. Useful for formatters which want to provide a login page.
Syntax
Get-PveAccessTicket [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessUsers
User index.
Syntax
Get-PveAccessUsers [[-PveTicket] <PveTicket>] [-Enabled] [-Full] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Optional filter for enable property. | false | true (ByPropertyName) | False | ||
| Include group and token information. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessUsersIdx
Get user configuration.
Syntax
Get-PveAccessUsersIdx [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessUsersTfa
Get user TFA types (Personal and Realm).
Syntax
Get-PveAccessUsersTfa [[-PveTicket] <PveTicket>] [-Multiple] [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Request all entries as an array. | false | true (ByPropertyName) | False | ||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessUsersToken
Get user API tokens.
Syntax
Get-PveAccessUsersToken [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveAccessUsersTokenIdx
Get specific API token information.
Syntax
Get-PveAccessUsersTokenIdx [[-PveTicket] <PveTicket>] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| User-specific token identifier. | true | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveCluster
Cluster index.
Syntax
Get-PveCluster [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcme
ACMEAccount index.
Syntax
Get-PveClusterAcme [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcmeAccount
ACMEAccount index.
Syntax
Get-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcmeAccountIdx
Return existing ACME account information.
Syntax
Get-PveClusterAcmeAccountIdx [[-PveTicket] <PveTicket>] [[-Name] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| ACME account config file name. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcmeChallengeSchema
Get schema of ACME challenge types.
Syntax
Get-PveClusterAcmeChallengeSchema [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcmeDirectories
Get named known ACME directory endpoints.
Syntax
Get-PveClusterAcmeDirectories [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcmeMeta
Retrieve ACME Directory Meta Information
Syntax
Get-PveClusterAcmeMeta [[-PveTicket] <PveTicket>] [[-Directory] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| URL of ACME CA directory endpoint. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcmePlugins
ACME plugin index.
Syntax
Get-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list ACME plugins of a specific type Enum: dns,standalone | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcmePluginsIdx
Get ACME plugin configuration.
Syntax
Get-PveClusterAcmePluginsIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Unique identifier for ACME plugin instance. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterAcmeTos
Retrieve ACME TermsOfService URL from CA. Deprecated, please use /cluster/acme/meta.
Syntax
Get-PveClusterAcmeTos [[-PveTicket] <PveTicket>] [[-Directory] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| URL of ACME CA directory endpoint. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterBackup
List vzdump backup schedule.
Syntax
Get-PveClusterBackup [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterBackupIdx
Read vzdump backup job definition.
Syntax
Get-PveClusterBackupIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The job ID. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterBackupIncludedVolumes
Returns included guests and the backup status of their disks. Optimized to be used in ExtJS tree views.
Syntax
Get-PveClusterBackupIncludedVolumes [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The job ID. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterBackupInfo
Index for backup info related endpoints
Syntax
Get-PveClusterBackupInfo [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterBackupInfoNotBackedUp
Shows all guests which are not covered by any backup job.
Syntax
Get-PveClusterBackupInfoNotBackedUp [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterCeph
Cluster ceph index.
Syntax
Get-PveClusterCeph [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterCephFlags
get the status of all ceph flags
Syntax
Get-PveClusterCephFlags [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterCephFlagsIdx
Get the status of a specific ceph flag.
Syntax
Get-PveClusterCephFlagsIdx [[-PveTicket] <PveTicket>] [-Flag] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The name of the flag name to get. Enum: nobackfill,nodeep-scrub,nodown,noin,noout,norebalance,norecover,noscrub,notieragent,noup,pause | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterCephMetadata
Get ceph metadata.
Syntax
Get-PveClusterCephMetadata [[-PveTicket] <PveTicket>] [[-Scope] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- Enum: all,versions | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterCephStatus
Get ceph status.
Syntax
Get-PveClusterCephStatus [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterConfig
Directory index.
Syntax
Get-PveClusterConfig [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterConfigApiversion
Return the version of the cluster join API available on this node.
Syntax
Get-PveClusterConfigApiversion [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterConfigJoin
Get information needed to join this cluster over the connected node.
Syntax
Get-PveClusterConfigJoin [[-PveTicket] <PveTicket>] [[-Node] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The node for which the joinee gets the nodeinfo. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterConfigNodes
Corosync node list.
Syntax
Get-PveClusterConfigNodes [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterConfigQdevice
Get QDevice status
Syntax
Get-PveClusterConfigQdevice [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterConfigTotem
Get corosync totem protocol settings.
Syntax
Get-PveClusterConfigTotem [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewall
Directory index.
Syntax
Get-PveClusterFirewall [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallAliases
List aliases
Syntax
Get-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallAliasesIdx
Read alias.
Syntax
Get-PveClusterFirewallAliasesIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Alias name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallGroups
List security groups.
Syntax
Get-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallGroupsIdx
Get single rule data.
Syntax
Get-PveClusterFirewallGroupsIdx [[-PveTicket] <PveTicket>] [-Group] <String> [[-Pos] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Security Group name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallIpset
List IPSets
Syntax
Get-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallIpsetIdx
Read IP or Network settings from IPSet.
Syntax
Get-PveClusterFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallMacros
List available macros
Syntax
Get-PveClusterFirewallMacros [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallOptions
Get Firewall options.
Syntax
Get-PveClusterFirewallOptions [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallRefs
Lists possible IPSet/Alias reference which are allowed in source/dest properties.
Syntax
Get-PveClusterFirewallRefs [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list references of specified type. Enum: alias,ipset | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallRules
List rules.
Syntax
Get-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterFirewallRulesIdx
Get single rule data.
Syntax
Get-PveClusterFirewallRulesIdx [[-PveTicket] <PveTicket>] [[-Pos] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterHa
Directory index.
Syntax
Get-PveClusterHa [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterHaGroups
Get HA groups.
Syntax
Get-PveClusterHaGroups [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterHaGroupsIdx
Read ha group configuration.
Syntax
Get-PveClusterHaGroupsIdx [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The HA group identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterHaResources
List HA resources.
Syntax
Get-PveClusterHaResources [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list resources of specific type Enum: ct,vm | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterHaResourcesIdx
Read resource configuration.
Syntax
Get-PveClusterHaResourcesIdx [[-PveTicket] <PveTicket>] [-Sid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100). | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterHaStatus
Directory index.
Syntax
Get-PveClusterHaStatus [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterHaStatusCurrent
Get HA manger status.
Syntax
Get-PveClusterHaStatusCurrent [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterHaStatusManagerStatus
Get full HA manger status, including LRM status.
Syntax
Get-PveClusterHaStatusManagerStatus [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterJobs
Index for jobs related endpoints.
Syntax
Get-PveClusterJobs [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterJobsRealmSync
List configured realm-sync-jobs.
Syntax
Get-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterJobsRealmSyncIdx
Read realm-sync job definition.
Syntax
Get-PveClusterJobsRealmSyncIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterJobsScheduleAnalyze
Returns a list of future schedule runtimes.
Syntax
Get-PveClusterJobsScheduleAnalyze [[-PveTicket] <PveTicket>] [[-Iterations] <Int32>] [-Schedule] <String> [[-Starttime] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Number of event-iteration to simulate and return. | false | true (ByPropertyName) | 0 | ||
| Job schedule. The format is a subset of `systemd` calendar events. | true | true (ByPropertyName) | |||
| UNIX timestamp to start the calculation from. Defaults to the current time. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterLog
Read cluster log
Syntax
Get-PveClusterLog [[-PveTicket] <PveTicket>] [[-Max] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Maximum number of entries. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterMapping
List resource types.
Syntax
Get-PveClusterMapping [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterMappingPci
List PCI Hardware Mapping
Syntax
Get-PveClusterMappingPci [[-PveTicket] <PveTicket>] [[-CheckNode] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| If given, checks the configurations on the given node for correctness, and adds relevant diagnostics for the devices to the response. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterMappingPciIdx
Get PCI Mapping.
Syntax
Get-PveClusterMappingPciIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterMappingUsb
List USB Hardware Mappings
Syntax
Get-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [[-CheckNode] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| If given, checks the configurations on the given node for correctness, and adds relevant errors to the devices. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterMappingUsbIdx
Get USB Mapping.
Syntax
Get-PveClusterMappingUsbIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterMetrics
Metrics index.
Syntax
Get-PveClusterMetrics [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterMetricsServer
List configured metric servers.
Syntax
Get-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterMetricsServerIdx
Read metric server configuration.
Syntax
Get-PveClusterMetricsServerIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNextid
Get next free VMID. Pass a VMID to assert that its free (at time of check).
Syntax
Get-PveClusterNextid [[-PveTicket] <PveTicket>] [[-Vmid] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotifications
Index for notification-related API endpoints.
Syntax
Get-PveClusterNotifications [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsEndpoints
Index for all available endpoint types.
Syntax
Get-PveClusterNotificationsEndpoints [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsEndpointsGotify
Returns a list of all gotify endpoints
Syntax
Get-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsEndpointsGotifyIdx
Return a specific gotify endpoint
Syntax
Get-PveClusterNotificationsEndpointsGotifyIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Name of the endpoint. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsEndpointsSendmail
Returns a list of all sendmail endpoints
Syntax
Get-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsEndpointsSendmailIdx
Return a specific sendmail endpoint
Syntax
Get-PveClusterNotificationsEndpointsSendmailIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsEndpointsSmtp
Returns a list of all smtp endpoints
Syntax
Get-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsEndpointsSmtpIdx
Return a specific smtp endpoint
Syntax
Get-PveClusterNotificationsEndpointsSmtpIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsMatchers
Returns a list of all matchers
Syntax
Get-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsMatchersIdx
Return a specific matcher
Syntax
Get-PveClusterNotificationsMatchersIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterNotificationsTargets
Returns a list of all entities that can be used as notification targets.
Syntax
Get-PveClusterNotificationsTargets [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterOptions
Get datacenter options. Without 'Sys.Audit' on '/' not all options are returned.
Syntax
Get-PveClusterOptions [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterReplication
List replication jobs.
Syntax
Get-PveClusterReplication [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterReplicationIdx
Read replication job configuration.
Syntax
Get-PveClusterReplicationIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterResources
Resources index (cluster wide).
Syntax
Get-PveClusterResources [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- Enum: vm,storage,node,sdn | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdn
Directory index.
Syntax
Get-PveClusterSdn [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnControllers
SDN controllers index.
Syntax
Get-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [-Pending] [-Running] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Display pending config. | false | true (ByPropertyName) | False | ||
| Display running config. | false | true (ByPropertyName) | False | ||
| Only list sdn controllers of specific type Enum: bgp,evpn,faucet,isis | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnControllersIdx
Read sdn controller configuration.
Syntax
Get-PveClusterSdnControllersIdx [[-PveTicket] <PveTicket>] [-Controller] <String> [-Pending] [-Running] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The SDN controller object identifier. | true | true (ByPropertyName) | |||
| Display pending config. | false | true (ByPropertyName) | False | ||
| Display running config. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnDns
SDN dns index.
Syntax
Get-PveClusterSdnDns [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list sdn dns of specific type Enum: powerdns | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnDnsIdx
Read sdn dns configuration.
Syntax
Get-PveClusterSdnDnsIdx [[-PveTicket] <PveTicket>] [-Dns] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The SDN dns object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnIpams
SDN ipams index.
Syntax
Get-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list sdn ipams of specific type Enum: netbox,phpipam,pve | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnIpamsIdx
Read sdn ipam configuration.
Syntax
Get-PveClusterSdnIpamsIdx [[-PveTicket] <PveTicket>] [-Ipam] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The SDN ipam object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnIpamsStatus
List PVE IPAM Entries
Syntax
Get-PveClusterSdnIpamsStatus [[-PveTicket] <PveTicket>] [-Ipam] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The SDN ipam object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnVnets
SDN vnets index.
Syntax
Get-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [-Pending] [-Running] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Display pending config. | false | true (ByPropertyName) | False | ||
| Display running config. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnVnetsIdx
Read sdn vnet configuration.
Syntax
Get-PveClusterSdnVnetsIdx [[-PveTicket] <PveTicket>] [-Pending] [-Running] [-Vnet] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Display pending config. | false | true (ByPropertyName) | False | ||
| Display running config. | false | true (ByPropertyName) | False | ||
| The SDN vnet object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnVnetsSubnets
SDN subnets index.
Syntax
Get-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [-Pending] [-Running] [-Vnet] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Display pending config. | false | true (ByPropertyName) | False | ||
| Display running config. | false | true (ByPropertyName) | False | ||
| The SDN vnet object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnVnetsSubnetsIdx
Read sdn subnet configuration.
Syntax
Get-PveClusterSdnVnetsSubnetsIdx [[-PveTicket] <PveTicket>] [-Pending] [-Running] [-Subnet] <String> [-Vnet] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Display pending config. | false | true (ByPropertyName) | False | ||
| Display running config. | false | true (ByPropertyName) | False | ||
| The SDN subnet object identifier. | true | true (ByPropertyName) | |||
| The SDN vnet object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnZones
SDN zones index.
Syntax
Get-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-Pending] [-Running] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Display pending config. | false | true (ByPropertyName) | False | ||
| Display running config. | false | true (ByPropertyName) | False | ||
| Only list SDN zones of specific type Enum: evpn,faucet,qinq,simple,vlan,vxlan | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterSdnZonesIdx
Read sdn zone configuration.
Syntax
Get-PveClusterSdnZonesIdx [[-PveTicket] <PveTicket>] [-Pending] [-Running] [-Zone] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Display pending config. | false | true (ByPropertyName) | False | ||
| Display running config. | false | true (ByPropertyName) | False | ||
| The SDN zone object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterStatus
Get cluster status information.
Syntax
Get-PveClusterStatus [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveClusterTasks
List recent tasks (cluster wide).
Syntax
Get-PveClusterTasks [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNode
Get nodes
Syntax
Get-PveNode [[-PveTicket] <PveTicket>] [[-Node] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The Name of the node. | false | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PSCustomObject. Return Node/s data.
Get-PveNodes
Cluster node index.
Syntax
Get-PveNodes [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesAplinfo
Get list of appliances.
Syntax
Get-PveNodesAplinfo [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesApt
Directory index for apt (Advanced Package Tool).
Syntax
Get-PveNodesApt [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesAptChangelog
Get package changelogs.
Syntax
Get-PveNodesAptChangelog [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [[-Version] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Package name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Package version. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesAptRepositories
Get APT repository information.
Syntax
Get-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesAptUpdate
List available updates.
Syntax
Get-PveNodesAptUpdate [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesAptVersions
Get package information for important Proxmox packages.
Syntax
Get-PveNodesAptVersions [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCapabilities
Node capabilities index.
Syntax
Get-PveNodesCapabilities [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCapabilitiesQemu
QEMU capabilities index.
Syntax
Get-PveNodesCapabilitiesQemu [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCapabilitiesQemuCpu
List all custom and default CPU models.
Syntax
Get-PveNodesCapabilitiesQemuCpu [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCapabilitiesQemuMachines
Get available QEMU/KVM machine types.
Syntax
Get-PveNodesCapabilitiesQemuMachines [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCeph
Directory index.
Syntax
Get-PveNodesCeph [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephCfg
Directory index.
Syntax
Get-PveNodesCephCfg [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephCfgDb
Get the Ceph configuration database.
Syntax
Get-PveNodesCephCfgDb [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephCfgRaw
Get the Ceph configuration file.
Syntax
Get-PveNodesCephCfgRaw [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephCfgValue
Get configured values from either the config file or config DB.
Syntax
Get-PveNodesCephCfgValue [[-PveTicket] <PveTicket>] [-ConfigKeys] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| List of <section>':'<config key> items. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephCmdSafety
Heuristical check if it is safe to perform an action.
Syntax
Get-PveNodesCephCmdSafety [[-PveTicket] <PveTicket>] [-Action] <String> [-Id] <String> [-Node] <String> [-Service] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Action to check Enum: stop,destroy | true | true (ByPropertyName) | |||
| ID of the service | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Service type Enum: osd,mon,mds | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephCrush
Get OSD crush map
Syntax
Get-PveNodesCephCrush [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephFs
Directory index.
Syntax
Get-PveNodesCephFs [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephLog
Read ceph log
Syntax
Get-PveNodesCephLog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Start] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephMds
MDS directory index.
Syntax
Get-PveNodesCephMds [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephMgr
MGR directory index.
Syntax
Get-PveNodesCephMgr [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephMon
Get Ceph monitor list.
Syntax
Get-PveNodesCephMon [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephOsd
Get Ceph osd list/tree.
Syntax
Get-PveNodesCephOsd [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephOsdIdx
OSD index.
Syntax
Get-PveNodesCephOsdIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| OSD ID | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephOsdLvInfo
Get OSD volume details
Syntax
Get-PveNodesCephOsdLvInfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| OSD ID | true | true (ByPropertyName) | 0 | ||
| OSD device type Enum: block,db,wal | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephOsdMetadata
Get OSD details
Syntax
Get-PveNodesCephOsdMetadata [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| OSD ID | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephPool
List all pools and their settings (which are settable by the POST/PUT endpoints).
Syntax
Get-PveNodesCephPool [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephPoolIdx
Pool index.
Syntax
Get-PveNodesCephPoolIdx [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The name of the pool. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephPoolStatus
Show the current pool status.
Syntax
Get-PveNodesCephPoolStatus [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [-Verbose_] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The name of the pool. It must be unique. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| If enabled, will display additional data(eg. statistics). | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephRules
List ceph rules.
Syntax
Get-PveNodesCephRules [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCephStatus
Get ceph status.
Syntax
Get-PveNodesCephStatus [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCertificates
Node index.
Syntax
Get-PveNodesCertificates [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCertificatesAcme
ACME index.
Syntax
Get-PveNodesCertificatesAcme [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesCertificatesInfo
Get information about node's certificates.
Syntax
Get-PveNodesCertificatesInfo [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesConfig
Get node configuration options.
Syntax
Get-PveNodesConfig [[-PveTicket] <PveTicket>] [-Node] <String> [[-Property] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Return only a specific property from the node configuration. Enum: acme,acmedomain0,acmedomain1,acmedomain2,acmedomain3,acmedomain4,acmedomain5,description,startall-onboot-delay,wakeonlan | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDisks
Node index.
Syntax
Get-PveNodesDisks [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDisksDirectory
PVE Managed Directory storages.
Syntax
Get-PveNodesDisksDirectory [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDisksList
List local disks.
Syntax
Get-PveNodesDisksList [[-PveTicket] <PveTicket>] [-IncludePartitions] [-Node] <String> [-Skipsmart] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Also include partitions. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Skip smart checks. | false | true (ByPropertyName) | False | ||
| Only list specific types of disks. Enum: unused,journal_disks | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDisksLvm
List LVM Volume Groups
Syntax
Get-PveNodesDisksLvm [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDisksLvmthin
List LVM thinpools
Syntax
Get-PveNodesDisksLvmthin [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDisksSmart
Get SMART Health of a disk.
Syntax
Get-PveNodesDisksSmart [[-PveTicket] <PveTicket>] [-Disk] <String> [-Healthonly] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Block device name | true | true (ByPropertyName) | |||
| If true returns only the health status | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDisksZfs
List Zpools.
Syntax
Get-PveNodesDisksZfs [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDisksZfsIdx
Get details about a zpool.
Syntax
Get-PveNodesDisksZfsIdx [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesDns
Read DNS settings.
Syntax
Get-PveNodesDns [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesFirewall
Directory index.
Syntax
Get-PveNodesFirewall [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesFirewallLog
Read firewall log
Syntax
Get-PveNodesFirewallLog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Start] <Int32>] [[-Until] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Display log since this UNIX epoch. | false | true (ByPropertyName) | 0 | ||
| -- | false | true (ByPropertyName) | 0 | ||
| Display log until this UNIX epoch. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesFirewallOptions
Get host firewall options.
Syntax
Get-PveNodesFirewallOptions [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesFirewallRules
List rules.
Syntax
Get-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesFirewallRulesIdx
Get single rule data.
Syntax
Get-PveNodesFirewallRulesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Pos] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesHardware
Index of hardware types
Syntax
Get-PveNodesHardware [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesHardwarePci
List local PCI devices.
Syntax
Get-PveNodesHardwarePci [[-PveTicket] <PveTicket>] [-Node] <String> [[-PciClassBlacklist] <String>] [-Verbose_] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| A list of blacklisted PCI classes, which will not be returned. Following are filtered by default':' Memory Controller (05), Bridge (06) and Processor (0b). | false | true (ByPropertyName) | |||
| If disabled, does only print the PCI IDs. Otherwise, additional information like vendor and device will be returned. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesHardwarePciIdx
Index of available pci methods
Syntax
Get-PveNodesHardwarePciIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Pciid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesHardwarePciMdev
List mediated device types for given PCI device.
Syntax
Get-PveNodesHardwarePciMdev [[-PveTicket] <PveTicket>] [-Node] <String> [-Pciid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The PCI ID to list the mdev types for. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesHardwareUsb
List local USB devices.
Syntax
Get-PveNodesHardwareUsb [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesHosts
Get the content of /etc/hosts.
Syntax
Get-PveNodesHosts [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesIdx
Node index.
Syntax
Get-PveNodesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesJournal
Read Journal
Syntax
Get-PveNodesJournal [[-PveTicket] <PveTicket>] [[-Endcursor] <String>] [[-Lastentries] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Startcursor] <String>] [[-Until] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| End before the given Cursor. Conflicts with 'until' | false | true (ByPropertyName) | |||
| Limit to the last X lines. Conflicts with a range. | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Display all log since this UNIX epoch. Conflicts with 'startcursor'. | false | true (ByPropertyName) | 0 | ||
| Start after the given Cursor. Conflicts with 'since' | false | true (ByPropertyName) | |||
| Display all log until this UNIX epoch. Conflicts with 'endcursor'. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxc
LXC container index (per node).
Syntax
Get-PveNodesLxc [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcConfig
Get container configuration.
Syntax
Get-PveNodesLxcConfig [[-PveTicket] <PveTicket>] [-Current] [-Node] <String> [[-Snapshot] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Get current values (instead of pending values). | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Fetch config values from given snapshot. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFeature
Check if feature for virtual machine is available.
Syntax
Get-PveNodesLxcFeature [[-PveTicket] <PveTicket>] [-Feature] <String> [-Node] <String> [[-Snapname] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Feature to check. Enum: snapshot,clone,copy | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewall
Directory index.
Syntax
Get-PveNodesLxcFirewall [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallAliases
List aliases
Syntax
Get-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallAliasesIdx
Read alias.
Syntax
Get-PveNodesLxcFirewallAliasesIdx [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Alias name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallIpset
List IPSets
Syntax
Get-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallIpsetIdx
Read IP or Network settings from IPSet.
Syntax
Get-PveNodesLxcFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallLog
Read firewall log
Syntax
Get-PveNodesLxcFirewallLog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Start] <Int32>] [[-Until] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Display log since this UNIX epoch. | false | true (ByPropertyName) | 0 | ||
| -- | false | true (ByPropertyName) | 0 | ||
| Display log until this UNIX epoch. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallOptions
Get VM firewall options.
Syntax
Get-PveNodesLxcFirewallOptions [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallRefs
Lists possible IPSet/Alias reference which are allowed in source/dest properties.
Syntax
Get-PveNodesLxcFirewallRefs [[-PveTicket] <PveTicket>] [-Node] <String> [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Only list references of specified type. Enum: alias,ipset | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallRules
List rules.
Syntax
Get-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcFirewallRulesIdx
Get single rule data.
Syntax
Get-PveNodesLxcFirewallRulesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcIdx
Directory index
Syntax
Get-PveNodesLxcIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcInterfaces
Get IP addresses of the specified container interface.
Syntax
Get-PveNodesLxcInterfaces [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcMtunnelwebsocket
Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration.
Syntax
Get-PveNodesLxcMtunnelwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Socket] <String> [-Ticket] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| unix socket to forward to | true | true (ByPropertyName) | |||
| ticket return by initial 'mtunnel' API call, or retrieved via 'ticket' tunnel command | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcPending
Get container configuration, including pending changes.
Syntax
Get-PveNodesLxcPending [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcRrd
Read VM RRD statistics (returns PNG)
Syntax
Get-PveNodesLxcRrd [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Ds] <String> [-Node] <String> [-Timeframe] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The RRD consolidation function Enum: AVERAGE,MAX | false | true (ByPropertyName) | |||
| The list of datasources you want to display. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Specify the time frame you are interested in. Enum: hour,day,week,month,year | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcRrddata
Read VM RRD statistics
Syntax
Get-PveNodesLxcRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Timeframe] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The RRD consolidation function Enum: AVERAGE,MAX | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Specify the time frame you are interested in. Enum: hour,day,week,month,year | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcSnapshot
List all snapshots.
Syntax
Get-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcSnapshotConfig
Get snapshot configuration
Syntax
Get-PveNodesLxcSnapshotConfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcSnapshotIdx
--
Syntax
Get-PveNodesLxcSnapshotIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcStatus
Directory index
Syntax
Get-PveNodesLxcStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcStatusCurrent
Get virtual machine status.
Syntax
Get-PveNodesLxcStatusCurrent [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesLxcVncwebsocket
Opens a weksocket for VNC traffic.
Syntax
Get-PveNodesLxcVncwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Port] <Int32> [-Vmid] <Int32> [-Vncticket] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Port number returned by previous vncproxy call. | true | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 | ||
| Ticket from previous call to vncproxy. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesNetstat
Read tap/vm network device interface counters
Syntax
Get-PveNodesNetstat [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesNetwork
List available networks
Syntax
Get-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Only list specific interface types. Enum: bridge,bond,eth,alias,vlan,OVSBridge,OVSBond,OVSPort,OVSIntPort,any_bridge,any_local_bridge | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesNetworkIdx
Read network device configuration
Syntax
Get-PveNodesNetworkIdx [[-PveTicket] <PveTicket>] [-Iface] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network interface name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemu
Virtual machine index (per node).
Syntax
Get-PveNodesQemu [[-PveTicket] <PveTicket>] [-Full] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Determine the full status of active VMs. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgent
QEMU Guest Agent command index.
Syntax
Get-PveNodesQemuAgent [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentExecStatus
Gets the status of the given pid started by the guest-agent
Syntax
Get-PveNodesQemuAgentExecStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Pid_] <Int32> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The PID to query | true | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentFileRead
Reads the given file via guest agent. Is limited to 16777216 bytes.
Syntax
Get-PveNodesQemuAgentFileRead [[-PveTicket] <PveTicket>] [-File] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The path to the file | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetFsinfo
Execute get-fsinfo.
Syntax
Get-PveNodesQemuAgentGetFsinfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetHostName
Execute get-host-name.
Syntax
Get-PveNodesQemuAgentGetHostName [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetMemoryBlockInfo
Execute get-memory-block-info.
Syntax
Get-PveNodesQemuAgentGetMemoryBlockInfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetMemoryBlocks
Execute get-memory-blocks.
Syntax
Get-PveNodesQemuAgentGetMemoryBlocks [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetOsinfo
Execute get-osinfo.
Syntax
Get-PveNodesQemuAgentGetOsinfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetTime
Execute get-time.
Syntax
Get-PveNodesQemuAgentGetTime [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetTimezone
Execute get-timezone.
Syntax
Get-PveNodesQemuAgentGetTimezone [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetUsers
Execute get-users.
Syntax
Get-PveNodesQemuAgentGetUsers [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentGetVcpus
Execute get-vcpus.
Syntax
Get-PveNodesQemuAgentGetVcpus [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentInfo
Execute info.
Syntax
Get-PveNodesQemuAgentInfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuAgentNetworkGetInterfaces
Execute network-get-interfaces.
Syntax
Get-PveNodesQemuAgentNetworkGetInterfaces [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuCloudinit
Get the cloudinit configuration with both current and pending values.
Syntax
Get-PveNodesQemuCloudinit [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuCloudinitDump
Get automatically generated cloudinit config.
Syntax
Get-PveNodesQemuCloudinitDump [[-PveTicket] <PveTicket>] [-Node] <String> [-Type] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Config type. Enum: user,network,meta | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuConfig
Get the virtual machine configuration with pending configuration changes applied. Set the 'current' parameter to get the current configuration instead.
Syntax
Get-PveNodesQemuConfig [[-PveTicket] <PveTicket>] [-Current] [-Node] <String> [[-Snapshot] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Get current values (instead of pending values). | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Fetch config values from given snapshot. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFeature
Check if feature for virtual machine is available.
Syntax
Get-PveNodesQemuFeature [[-PveTicket] <PveTicket>] [-Feature] <String> [-Node] <String> [[-Snapname] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Feature to check. Enum: snapshot,clone,copy | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewall
Directory index.
Syntax
Get-PveNodesQemuFirewall [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallAliases
List aliases
Syntax
Get-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallAliasesIdx
Read alias.
Syntax
Get-PveNodesQemuFirewallAliasesIdx [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Alias name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallIpset
List IPSets
Syntax
Get-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallIpsetIdx
Read IP or Network settings from IPSet.
Syntax
Get-PveNodesQemuFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallLog
Read firewall log
Syntax
Get-PveNodesQemuFirewallLog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Start] <Int32>] [[-Until] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Display log since this UNIX epoch. | false | true (ByPropertyName) | 0 | ||
| -- | false | true (ByPropertyName) | 0 | ||
| Display log until this UNIX epoch. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallOptions
Get VM firewall options.
Syntax
Get-PveNodesQemuFirewallOptions [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallRefs
Lists possible IPSet/Alias reference which are allowed in source/dest properties.
Syntax
Get-PveNodesQemuFirewallRefs [[-PveTicket] <PveTicket>] [-Node] <String> [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Only list references of specified type. Enum: alias,ipset | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallRules
List rules.
Syntax
Get-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuFirewallRulesIdx
Get single rule data.
Syntax
Get-PveNodesQemuFirewallRulesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuIdx
Directory index
Syntax
Get-PveNodesQemuIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuMigrate
Get preconditions for migration.
Syntax
Get-PveNodesQemuMigrate [[-PveTicket] <PveTicket>] [-Node] <String> [[-Target] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Target node. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuMtunnelwebsocket
Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration.
Syntax
Get-PveNodesQemuMtunnelwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Socket] <String> [-Ticket] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| unix socket to forward to | true | true (ByPropertyName) | |||
| ticket return by initial 'mtunnel' API call, or retrieved via 'ticket' tunnel command | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuPending
Get the virtual machine configuration with both current and pending values.
Syntax
Get-PveNodesQemuPending [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuRrd
Read VM RRD statistics (returns PNG)
Syntax
Get-PveNodesQemuRrd [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Ds] <String> [-Node] <String> [-Timeframe] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The RRD consolidation function Enum: AVERAGE,MAX | false | true (ByPropertyName) | |||
| The list of datasources you want to display. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Specify the time frame you are interested in. Enum: hour,day,week,month,year | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuRrddata
Read VM RRD statistics
Syntax
Get-PveNodesQemuRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Timeframe] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The RRD consolidation function Enum: AVERAGE,MAX | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Specify the time frame you are interested in. Enum: hour,day,week,month,year | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuSnapshot
List all snapshots.
Syntax
Get-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuSnapshotConfig
Get snapshot configuration
Syntax
Get-PveNodesQemuSnapshotConfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuSnapshotIdx
--
Syntax
Get-PveNodesQemuSnapshotIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuStatus
Directory index
Syntax
Get-PveNodesQemuStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuStatusCurrent
Get virtual machine status.
Syntax
Get-PveNodesQemuStatusCurrent [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQemuVncwebsocket
Opens a weksocket for VNC traffic.
Syntax
Get-PveNodesQemuVncwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Port] <Int32> [-Vmid] <Int32> [-Vncticket] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Port number returned by previous vncproxy call. | true | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 | ||
| Ticket from previous call to vncproxy. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesQueryUrlMetadata
Query metadata of an URL':' file size, file name and mime type.
Syntax
Get-PveNodesQueryUrlMetadata [[-PveTicket] <PveTicket>] [-Node] <String> [-Url] <String> [-VerifyCertificates] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The URL to query the metadata from. | true | true (ByPropertyName) | |||
| If false, no SSL/TLS certificates will be verified. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesReplication
List status of all replication jobs on this node.
Syntax
Get-PveNodesReplication [[-PveTicket] <PveTicket>] [[-Guest] <Int32>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list replication jobs for this guest. | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesReplicationIdx
Directory index.
Syntax
Get-PveNodesReplicationIdx [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesReplicationLog
Read replication job log.
Syntax
Get-PveNodesReplicationLog [[-PveTicket] <PveTicket>] [-Id] <String> [[-Limit] <Int32>] [-Node] <String> [[-Start] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesReplicationStatus
Get replication job status.
Syntax
Get-PveNodesReplicationStatus [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesReport
Gather various systems information about a node
Syntax
Get-PveNodesReport [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesRrd
Read node RRD statistics (returns PNG)
Syntax
Get-PveNodesRrd [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Ds] <String> [-Node] <String> [-Timeframe] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The RRD consolidation function Enum: AVERAGE,MAX | false | true (ByPropertyName) | |||
| The list of datasources you want to display. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Specify the time frame you are interested in. Enum: hour,day,week,month,year | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesRrddata
Read node RRD statistics
Syntax
Get-PveNodesRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Timeframe] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The RRD consolidation function Enum: AVERAGE,MAX | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Specify the time frame you are interested in. Enum: hour,day,week,month,year | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScan
Index of available scan methods
Syntax
Get-PveNodesScan [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScanCifs
Scan remote CIFS server.
Syntax
Get-PveNodesScanCifs [[-PveTicket] <PveTicket>] [[-Domain] <String>] [-Node] <String> [[-Password] <SecureString>] [-Server] <String> [[-Username] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| SMB domain (Workgroup). | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| User password. | false | true (ByPropertyName) | |||
| The server address (name or IP). | true | true (ByPropertyName) | |||
| User name. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScanGlusterfs
Scan remote GlusterFS server.
Syntax
Get-PveNodesScanGlusterfs [[-PveTicket] <PveTicket>] [-Node] <String> [-Server] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The server address (name or IP). | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScanIscsi
Scan remote iSCSI server.
Syntax
Get-PveNodesScanIscsi [[-PveTicket] <PveTicket>] [-Node] <String> [-Portal] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The iSCSI portal (IP or DNS name with optional port). | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScanLvm
List local LVM volume groups.
Syntax
Get-PveNodesScanLvm [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScanLvmthin
List local LVM Thin Pools.
Syntax
Get-PveNodesScanLvmthin [[-PveTicket] <PveTicket>] [-Node] <String> [-Vg] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScanNfs
Scan remote NFS server.
Syntax
Get-PveNodesScanNfs [[-PveTicket] <PveTicket>] [-Node] <String> [-Server] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The server address (name or IP). | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScanPbs
Scan remote Proxmox Backup Server.
Syntax
Get-PveNodesScanPbs [[-PveTicket] <PveTicket>] [[-Fingerprint] <String>] [-Node] <String> [-Password] <SecureString> [[-Port] <Int32>] [-Server] <String> [-Username] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Certificate SHA 256 fingerprint. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| User password or API token secret. | true | true (ByPropertyName) | |||
| Optional port. | false | true (ByPropertyName) | 0 | ||
| The server address (name or IP). | true | true (ByPropertyName) | |||
| User-name or API token-ID. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesScanZfs
Scan zfs pool list on local node.
Syntax
Get-PveNodesScanZfs [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesSdn
SDN index.
Syntax
Get-PveNodesSdn [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesSdnZones
Get status for all zones.
Syntax
Get-PveNodesSdnZones [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesSdnZonesContent
List zone content.
Syntax
Get-PveNodesSdnZonesContent [[-PveTicket] <PveTicket>] [-Node] <String> [-Zone] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The SDN zone object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesSdnZonesIdx
--
Syntax
Get-PveNodesSdnZonesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Zone] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The SDN zone object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesServices
Service list.
Syntax
Get-PveNodesServices [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesServicesIdx
Directory index
Syntax
Get-PveNodesServicesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesServicesState
Read service properties
Syntax
Get-PveNodesServicesState [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStatus
Read node status
Syntax
Get-PveNodesStatus [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStorage
Get status for all datastores.
Syntax
Get-PveNodesStorage [[-PveTicket] <PveTicket>] [[-Content] <String>] [-Enabled] [-Format] [-Node] <String> [[-Storage] <String>] [[-Target] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list stores which support this content type. | false | true (ByPropertyName) | |||
| Only list stores which are enabled (not disabled in config). | false | true (ByPropertyName) | False | ||
| Include information about formats | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Only list status for specified storage | false | true (ByPropertyName) | |||
| If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStorageContent
List storage content.
Syntax
Get-PveNodesStorageContent [[-PveTicket] <PveTicket>] [[-Content] <String>] [-Node] <String> [-Storage] <String> [[-Vmid] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list content of this type. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| Only list images for this VM | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStorageContentIdx
Get volume attributes
Syntax
Get-PveNodesStorageContentIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Storage] <String>] [-Volume] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | false | true (ByPropertyName) | |||
| Volume identifier | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStorageIdx
--
Syntax
Get-PveNodesStorageIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Storage] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStorageImportMetadata
Get the base parameters for creating a guest which imports data from a foreign importable guest, like an ESXi VM
Syntax
Get-PveNodesStorageImportMetadata [[-PveTicket] <PveTicket>] [-Node] <String> [-Storage] <String> [-Volume] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| Volume identifier for the guest archive/entry. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStoragePrunebackups
Get prune information for backups. NOTE':' this is only a preview and might not be what a subsequent prune call does if backups are removed/added in the meantime.
Syntax
Get-PveNodesStoragePrunebackups [[-PveTicket] <PveTicket>] [-Node] <String> [[-PruneBackups] <String>] [-Storage] <String> [[-Type] <String>] [[-Vmid] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Use these retention options instead of those from the storage configuration. | false | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| Either 'qemu' or 'lxc'. Only consider backups for guests of this type. Enum: qemu,lxc | false | true (ByPropertyName) | |||
| Only consider backups for this guest. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStorageRrd
Read storage RRD statistics (returns PNG).
Syntax
Get-PveNodesStorageRrd [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Ds] <String> [-Node] <String> [-Storage] <String> [-Timeframe] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The RRD consolidation function Enum: AVERAGE,MAX | false | true (ByPropertyName) | |||
| The list of datasources you want to display. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| Specify the time frame you are interested in. Enum: hour,day,week,month,year | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStorageRrddata
Read storage RRD statistics.
Syntax
Get-PveNodesStorageRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Storage] <String> [-Timeframe] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The RRD consolidation function Enum: AVERAGE,MAX | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| Specify the time frame you are interested in. Enum: hour,day,week,month,year | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesStorageStatus
Read storage status.
Syntax
Get-PveNodesStorageStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Storage] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesSubscription
Read subscription info.
Syntax
Get-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesSyslog
Read system log
Syntax
Get-PveNodesSyslog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Service] <String>] [[-Since] <String>] [[-Start] <Int32>] [[-Until] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Service ID | false | true (ByPropertyName) | |||
| Display all log since this date-time string. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| Display all log until this date-time string. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesTasks
Read task list for one node (finished tasks).
Syntax
Get-PveNodesTasks [[-PveTicket] <PveTicket>] [-Errors] [[-Limit] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Source] <String>] [[-Start] <Int32>] [[-Statusfilter] <String>] [[-Typefilter] <String>] [[-Until] <Int32>] [[-Userfilter] <String>] [[-Vmid] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list tasks with a status of ERROR. | false | true (ByPropertyName) | False | ||
| Only list this amount of tasks. | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Only list tasks since this UNIX epoch. | false | true (ByPropertyName) | 0 | ||
| List archived, active or all tasks. Enum: archive,active,all | false | true (ByPropertyName) | |||
| List tasks beginning from this offset. | false | true (ByPropertyName) | 0 | ||
| List of Task States that should be returned. | false | true (ByPropertyName) | |||
| Only list tasks of this type (e.g., vzstart, vzdump). | false | true (ByPropertyName) | |||
| Only list tasks until this UNIX epoch. | false | true (ByPropertyName) | 0 | ||
| Only list tasks from this user. | false | true (ByPropertyName) | |||
| Only list tasks for this VM. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesTasksIdx
--
Syntax
Get-PveNodesTasksIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesTasksLog
Read task log.
Syntax
Get-PveNodesTasksLog [[-PveTicket] <PveTicket>] [-Download] [[-Limit] <Int32>] [-Node] <String> [[-Start] <Int32>] [-Upid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Whether the tasklog file should be downloaded. This parameter can't be used in conjunction with other parameters | false | true (ByPropertyName) | False | ||
| The amount of lines to read from the tasklog. | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Start at this line when reading the tasklog | false | true (ByPropertyName) | 0 | ||
| The task's unique ID. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesTasksStatus
Read task status.
Aliases
- Get-PveTasksStatus
Syntax
Get-PveNodesTasksStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The task's unique ID. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesTime
Read server time and time zone settings.
Syntax
Get-PveNodesTime [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesVersion
API version details
Syntax
Get-PveNodesVersion [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesVncwebsocket
Opens a websocket for VNC traffic.
Syntax
Get-PveNodesVncwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Port] <Int32> [-Vncticket] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Port number returned by previous vncproxy call. | true | true (ByPropertyName) | 0 | ||
| Ticket from previous call to vncproxy. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesVzdumpDefaults
Get the currently configured vzdump defaults.
Syntax
Get-PveNodesVzdumpDefaults [[-PveTicket] <PveTicket>] [-Node] <String> [[-Storage] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveNodesVzdumpExtractconfig
Extract configuration from vzdump backup archive.
Syntax
Get-PveNodesVzdumpExtractconfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Volume] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Volume identifier | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PvePools
List pools or get pool configuration.
Syntax
Get-PvePools [[-PveTicket] <PveTicket>] [[-Poolid] <String>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| -- Enum: qemu,lxc,storage | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PvePoolsIdx
Get pool configuration (deprecated, no support for nested pools, use 'GET /pools/?poolid={poolid}').
Syntax
Get-PvePoolsIdx [[-PveTicket] <PveTicket>] [-Poolid] <String> [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) | |||
| -- Enum: qemu,lxc,storage | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveStorage
Storage index.
Syntax
Get-PveStorage [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Only list storage of specific type Enum: btrfs,cephfs,cifs,dir,esxi,glusterfs,iscsi,iscsidirect,lvm,lvmthin,nfs,pbs,rbd,zfs,zfspool | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveStorageIdx
Read storage configuration.
Syntax
Get-PveStorageIdx [[-PveTicket] <PveTicket>] [-Storage] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveTaskIsRunning
Get task is running.
Syntax
Get-PveTaskIsRunning [[-PveTicket] <PveTicket>] [-Upid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| Upid task e.g UPID:pve1:00004A1A:0964214C:5EECEF11:vzdump:134:root@pam: | true | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- Bool. Return tas is running.
Get-PveVersion
API version details, including some parts of the global datacenter config.
Syntax
Get-PveVersion [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Get-PveVm
Get VMs/CTs from id or name.
Syntax
Get-PveVm [[-PveTicket] <PveTicket>] [[-VmIdOrName] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The id or name VM/CT comma separated (eg. 100,101,102,TestDebian)-vmid or -name exclude (e.g. -200,-TestUbuntu)range 100:107,-105,200:204'@pool-???' for all VM/CT in specific pool (e.g. @pool-customer1),'@tag-???' for all VM/CT in specific tags (e.g. @tag-customerA),'@node-???' for all VM/CT in specific node (e.g. @node-pve1, @node-\$(hostname)),'@all-???' for all VM/CT in specific host (e.g. @all-pve1, @all-\$(hostname)),'@all' for all VM/CT in cluster"; | false | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PSCustomObject. Return Vm/s data.
Get-PveVmSnapshot
Get snapshots VM.
Syntax
Get-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The (unique) ID or Name of the VM. | true | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Invoke-PveRestApi
Invoke Proxmox VE Rest API
Syntax
Invoke-PveRestApi [[-PveTicket] <PveTicket>] [-Resource] <String> [[-Method] <String>] [[-ResponseType] <String>] [[-Parameters] <Hashtable>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data | false | true (ByValue, ByPropertyName) | |||
| Resource Request | true | false | |||
| Method request | false | false | Get | ||
| Type request | false | false | json | ||
| Parameters request | false | false |
Outputs
The output type is the type of the objects that the cmdlet emits.
- Return object request
Note
This must be used before any other cmdlets are used
Examples
EXAMPLE 1
$PveTicket = Connect-PveCluster -HostsAndPorts '192.168.128.115' -Credentials (Get-Credential -Username 'root').
(Invoke-PveRestApi -PveTicket $PveTicket -Method Get -Resource '/version').Resonse.data
data----@{version=5.4; release=15; repoid=d0ec33c6; keyboard=it}
Invoke-PveSpice
Enter Spice VM.
Syntax
Invoke-PveSpice [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Viewer] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The (unique) ID or Name of the VM. | true | true (ByValue, ByPropertyName) | |||
| Path of Spice remove viewer.- Linux /usr/bin/remote-viewer- Windows C:\Program Files\VirtViewer v?.?-???\bin\remote-viewer.exe | true | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
IsNumeric
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| None | false | false |
New-PveAccessDomains
Add an authentication server.
Syntax
New-PveAccessDomains [[-PveTicket] <PveTicket>] [[-AcrValues] <String>] [-Autocreate] [[-BaseDn] <String>] [[-BindDn] <String>] [[-Capath] <String>] [-CaseSensitive] [[-Cert] <String>] [[-Certkey] <String>] [-CheckConnection] [[-ClientId] <String>] [[-ClientKey] <String>] [[-Comment] <String>] [-Default] [[-Domain] <String>] [[-Filter] <String>] [[-GroupClasses] <String>] [[-GroupDn] <String>] [[-GroupFilter] <String>] [[-GroupNameAttr] <String>] [[-IssuerUrl] <String>] [[-Mode] <String>] [[-Password] <SecureString>] [[-Port] <Int32>] [[-Prompt] <String>] [-Realm] <String> [[-Scopes] <String>] [-Secure] [[-Server1] <String>] [[-Server2] <String>] [[-Sslversion] <String>] [[-SyncDefaultsOptions] <String>] [[-SyncAttributes] <String>] [[-Tfa] <String>] [-Type] <String> [[-UserAttr] <String>] [[-UserClasses] <String>] [[-UsernameClaim] <String>] [-Verify] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. | false | true (ByPropertyName) | |||
| Automatically create users if they do not exist. | false | true (ByPropertyName) | False | ||
| LDAP base domain name | false | true (ByPropertyName) | |||
| LDAP bind domain name | false | true (ByPropertyName) | |||
| Path to the CA certificate store | false | true (ByPropertyName) | |||
| username is case-sensitive | false | true (ByPropertyName) | False | ||
| Path to the client certificate | false | true (ByPropertyName) | |||
| Path to the client certificate key | false | true (ByPropertyName) | |||
| Check bind connection to the server. | false | true (ByPropertyName) | False | ||
| OpenID Client ID | false | true (ByPropertyName) | |||
| OpenID Client Key | false | true (ByPropertyName) | |||
| Description. | false | true (ByPropertyName) | |||
| Use this as default realm | false | true (ByPropertyName) | False | ||
| AD domain name | false | true (ByPropertyName) | |||
| LDAP filter for user sync. | false | true (ByPropertyName) | |||
| The objectclasses for groups. | false | true (ByPropertyName) | |||
| LDAP base domain name for group sync. If not set, the base_dn will be used. | false | true (ByPropertyName) | |||
| LDAP filter for group sync. | false | true (ByPropertyName) | |||
| LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name. | false | true (ByPropertyName) | |||
| OpenID Issuer Url | false | true (ByPropertyName) | |||
| LDAP protocol mode. Enum: ldap,ldaps,ldap+starttls | false | true (ByPropertyName) | |||
| LDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'. | false | true (ByPropertyName) | |||
| Server port. | false | true (ByPropertyName) | 0 | ||
| Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. | false | true (ByPropertyName) | |||
| Authentication domain ID | true | true (ByPropertyName) | |||
| Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. | false | true (ByPropertyName) | |||
| Use secure LDAPS protocol. DEPRECATED':' use 'mode' instead. | false | true (ByPropertyName) | False | ||
| Server IP address (or DNS name) | false | true (ByPropertyName) | |||
| Fallback Server IP address (or DNS name) | false | true (ByPropertyName) | |||
| LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! Enum: tlsv1,tlsv1_1,tlsv1_2,tlsv1_3 | false | true (ByPropertyName) | |||
| The default options for behavior of synchronizations. | false | true (ByPropertyName) | |||
| Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name. | false | true (ByPropertyName) | |||
| Use Two-factor authentication. | false | true (ByPropertyName) | |||
| Realm type. Enum: ad,ldap,openid,pam,pve | true | true (ByPropertyName) | |||
| LDAP user attribute name | false | true (ByPropertyName) | |||
| The objectclasses for users. | false | true (ByPropertyName) | |||
| OpenID claim used to generate the unique username. | false | true (ByPropertyName) | |||
| Verify the server's SSL certificate | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessDomainsSync
Syncs users and/or groups from the configured LDAP to user.cfg. NOTE':' Synced groups will have the name 'name-$realm', so make sure those groups do not exist to prevent overwriting.
Syntax
New-PveAccessDomainsSync [[-PveTicket] <PveTicket>] [-DryRun] [-EnableNew] [-Full] [-Purge] [-Realm] <String> [[-RemoveVanished] <String>] [[-Scope] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| If set, does not write anything. | false | true (ByPropertyName) | False | ||
| Enable newly synced users immediately. | false | true (ByPropertyName) | False | ||
| DEPRECATED':' use 'remove-vanished' instead. If set, uses the LDAP Directory as source of truth, deleting users or groups not returned from the sync and removing all locally modified properties of synced users. If not set, only syncs information which is present in the synced data, and does not delete or modify anything else. | false | true (ByPropertyName) | False | ||
| DEPRECATED':' use 'remove-vanished' instead. Remove ACLs for users or groups which were removed from the config during a sync. | false | true (ByPropertyName) | False | ||
| Authentication domain ID | true | true (ByPropertyName) | |||
| A semicolon-seperated list of things to remove when they or the user vanishes during a sync. The following values are possible':' 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default). | false | true (ByPropertyName) | |||
| Select what to sync. Enum: users,groups,both | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessGroups
Create new group.
Syntax
New-PveAccessGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Groupid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessOpenidAuthUrl
Get the OpenId Authorization Url for the specified realm.
Syntax
New-PveAccessOpenidAuthUrl [[-PveTicket] <PveTicket>] [-Realm] <String> [-RedirectUrl] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Authentication domain ID | true | true (ByPropertyName) | |||
| Redirection Url. The client should set this to the used server url (location.origin). | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessOpenidLogin
Verify OpenID authorization code and create a ticket.
Syntax
New-PveAccessOpenidLogin [[-PveTicket] <PveTicket>] [-Code] <String> [-RedirectUrl] <String> [-State] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| OpenId authorization code. | true | true (ByPropertyName) | |||
| Redirection Url. The client should set this to the used server url (location.origin). | true | true (ByPropertyName) | |||
| OpenId state. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessRoles
Create new role.
Syntax
New-PveAccessRoles [[-PveTicket] <PveTicket>] [[-Privs] <String>] [-Roleid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessTfa
Add a TFA entry for a user.
Syntax
New-PveAccessTfa [[-PveTicket] <PveTicket>] [[-Challenge] <String>] [[-Description] <String>] [[-Password] <SecureString>] [[-Totp] <String>] [-Type] <String> [-Userid] <String> [[-Value] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| When responding to a u2f challenge':' the original challenge string | false | true (ByPropertyName) | |||
| A description to distinguish multiple entries from one another | false | true (ByPropertyName) | |||
| The current password of the user performing the change. | false | true (ByPropertyName) | |||
| A totp URI. | false | true (ByPropertyName) | |||
| TFA Entry Type. Enum: totp,u2f,webauthn,recovery,yubico | true | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) | |||
| The current value for the provided totp URI, or a Webauthn/U2F challenge response | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessTicket
Create or verify authentication ticket.
Syntax
New-PveAccessTicket [[-PveTicket] <PveTicket>] [-NewFormat] [[-Otp] <String>] [-Password] <SecureString> [[-Path] <String>] [[-Privs] <String>] [[-Realm] <String>] [[-TfaChallenge] <String>] [-Username] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| This parameter is now ignored and assumed to be 1. | false | true (ByPropertyName) | False | ||
| One-time password for Two-factor authentication. | false | true (ByPropertyName) | |||
| The secret password. This can also be a valid ticket. | true | true (ByPropertyName) | |||
| Verify ticket, and check if user have access 'privs' on 'path' | false | true (ByPropertyName) | |||
| Verify ticket, and check if user have access 'privs' on 'path' | false | true (ByPropertyName) | |||
| You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>. | false | true (ByPropertyName) | |||
| The signed TFA challenge string the user wants to respond to. | false | true (ByPropertyName) | |||
| User name | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessUsers
Create new user.
Syntax
New-PveAccessUsers [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Email] <String>] [-Enable] [[-Expire] <Int32>] [[-Firstname] <String>] [[-Groups] <String>] [[-Keys] <String>] [[-Lastname] <String>] [[-Password] <SecureString>] [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Enable the account (default). You can set this to '0' to disable the account | false | true (ByPropertyName) | False | ||
| Account expiration date (seconds since epoch). '0' means no expiration date. | false | true (ByPropertyName) | 0 | ||
| -- | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Keys for two factor auth (yubico). | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Initial password. | false | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveAccessUsersToken
Generate a new API token for a specific user. NOTE':' returns API token value, which needs to be stored as it cannot be retrieved afterwards!
Syntax
New-PveAccessUsersToken [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Expire] <Int32>] [-Privsep] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| API token expiration date (seconds since epoch). '0' means no expiration date. | false | true (ByPropertyName) | 0 | ||
| Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. | false | true (ByPropertyName) | False | ||
| User-specific token identifier. | true | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterAcmeAccount
Register a new ACME account with CA.
Syntax
New-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [-Contact] <String> [[-Directory] <String>] [[-EabHmacKey] <String>] [[-EabKid] <String>] [[-Name] <String>] [[-TosUrl] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Contact email addresses. | true | true (ByPropertyName) | |||
| URL of ACME CA directory endpoint. | false | true (ByPropertyName) | |||
| HMAC key for External Account Binding. | false | true (ByPropertyName) | |||
| Key Identifier for External Account Binding. | false | true (ByPropertyName) | |||
| ACME account config file name. | false | true (ByPropertyName) | |||
| URL of CA TermsOfService - setting this indicates agreement. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterAcmePlugins
Add ACME plugin configuration.
Syntax
New-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [[-Api] <String>] [[-Data] <String>] [-Disable] [-Id] <String> [[-Nodes] <String>] [-Type] <String> [[-ValidationDelay] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| API plugin name Enum: 1984hosting,acmedns,acmeproxy,active24,ad,ali,anx,artfiles,arvan,aurora,autodns,aws,azion,azure,bookmyname,bunny,cf,clouddns,cloudns,cn,conoha,constellix,cpanel,curanet,cyon,da,ddnss,desec,df,dgon,dnsexit,dnshome,dnsimple,dnsservices,do,doapi,domeneshop,dp,dpi,dreamhost,duckdns,durabledns,dyn,dynu,dynv6,easydns,edgedns,euserv,exoscale,fornex,freedns,gandi_livedns,gcloud,gcore,gd,geoscaling,googledomains,he,hetzner,hexonet,hostingde,huaweicloud,infoblox,infomaniak,internetbs,inwx,ionos,ipv64,ispconfig,jd,joker,kappernet,kas,kinghost,knot,la,leaseweb,lexicon,linode,linode_v4,loopia,lua,maradns,me,miab,misaka,myapi,mydevil,mydnsjp,mythic_beasts,namecheap,namecom,namesilo,nanelo,nederhost,neodigit,netcup,netlify,nic,njalla,nm,nsd,nsone,nsupdate,nw,oci,one,online,openprovider,openstack,opnsense,ovh,pdns,pleskxml,pointhq,porkbun,rackcorp,rackspace,rage4,rcode0,regru,scaleway,schlundtech,selectel,selfhost,servercow,simply,tele3,tencent,transip,udr,ultra,unoeuro,variomedia,veesp,vercel,vscale,vultr,websupport,world4you,yandex,yc,zilore,zone,zonomi | false | true (ByPropertyName) | |||
| DNS plugin data. (base64 encoded) | false | true (ByPropertyName) | |||
| Flag to disable the config. | false | true (ByPropertyName) | False | ||
| ACME Plugin ID name | true | true (ByPropertyName) | |||
| List of cluster node names. | false | true (ByPropertyName) | |||
| ACME challenge type. Enum: dns,standalone | true | true (ByPropertyName) | |||
| Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterBackup
Create new vzdump backup job.
Syntax
New-PveClusterBackup [[-PveTicket] <PveTicket>] [-All] [[-Bwlimit] <Int32>] [[-Comment] <String>] [[-Compress] <String>] [[-Dow] <String>] [[-Dumpdir] <String>] [-Enabled] [[-Exclude] <String>] [[-ExcludePath] <Array>] [[-Fleecing] <String>] [[-Id] <String>] [[-Ionice] <Int32>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <String>] [[-NotificationMode] <String>] [[-NotificationPolicy] <String>] [[-NotificationTarget] <String>] [[-Performance] <String>] [[-Pigz] <Int32>] [[-Pool] <String>] [-Protected] [[-PruneBackups] <String>] [-Quiet] [-Remove] [-RepeatMissed] [[-Schedule] <String>] [[-Script] <String>] [[-Starttime] <String>] [-Stdexcludes] [-Stop] [[-Stopwait] <Int32>] [[-Storage] <String>] [[-Tmpdir] <String>] [[-Vmid] <String>] [[-Zstd] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Backup all known guest systems on this host. | false | true (ByPropertyName) | False | ||
| Limit I/O bandwidth (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| Description for the Job. | false | true (ByPropertyName) | |||
| Compress dump file. Enum: 0,1,gzip,lzo,zstd | false | true (ByPropertyName) | |||
| Day of week selection. | false | true (ByPropertyName) | |||
| Store resulting files to specified directory. | false | true (ByPropertyName) | |||
| Enable or disable the job. | false | true (ByPropertyName) | False | ||
| Exclude specified guest systems (assumes --all) | false | true (ByPropertyName) | |||
| Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. | false | true (ByPropertyName) | |||
| Options for backup fleecing (VM only). | false | true (ByPropertyName) | |||
| Job ID (will be autogenerated). | false | true (ByPropertyName) | |||
| Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. | false | true (ByPropertyName) | 0 | ||
| Maximal time to wait for the global lock (minutes). | false | true (ByPropertyName) | 0 | ||
| Deprecated':' use notification targets/matchers instead. Specify when to send a notification mail Enum: always,failure | false | true (ByPropertyName) | |||
| Deprecated':' Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications. | false | true (ByPropertyName) | |||
| Deprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system. | false | true (ByPropertyName) | 0 | ||
| Backup mode. Enum: snapshot,suspend,stop | false | true (ByPropertyName) | |||
| Only run if executed on this node. | false | true (ByPropertyName) | |||
| Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. | false | true (ByPropertyName) | |||
| Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. Enum: auto,legacy-sendmail,notification-system | false | true (ByPropertyName) | |||
| Deprecated':' Do not use Enum: always,failure,never | false | true (ByPropertyName) | |||
| Deprecated':' Do not use | false | true (ByPropertyName) | |||
| Other performance-related settings. | false | true (ByPropertyName) | |||
| Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. | false | true (ByPropertyName) | 0 | ||
| Backup all known guest systems included in the specified pool. | false | true (ByPropertyName) | |||
| If true, mark backup(s) as protected. | false | true (ByPropertyName) | False | ||
| Use these retention options instead of those from the storage configuration. | false | true (ByPropertyName) | |||
| Be quiet. | false | true (ByPropertyName) | False | ||
| Prune older backups according to 'prune-backups'. | false | true (ByPropertyName) | False | ||
| If true, the job will be run as soon as possible if it was missed while the scheduler was not running. | false | true (ByPropertyName) | False | ||
| Backup schedule. The format is a subset of `systemd` calendar events. | false | true (ByPropertyName) | |||
| Use specified hook script. | false | true (ByPropertyName) | |||
| Job Start time. | false | true (ByPropertyName) | |||
| Exclude temporary files and logs. | false | true (ByPropertyName) | False | ||
| Stop running backup jobs on this host. | false | true (ByPropertyName) | False | ||
| Maximal time to wait until a guest system is stopped (minutes). | false | true (ByPropertyName) | 0 | ||
| Store resulting file to this storage. | false | true (ByPropertyName) | |||
| Store temporary files to specified directory. | false | true (ByPropertyName) | |||
| The ID of the guest system you want to backup. | false | true (ByPropertyName) | |||
| Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterConfig
Generate new cluster configuration. If no links given, default to local IP address as link0.
Syntax
New-PveClusterConfig [[-PveTicket] <PveTicket>] [-Clustername] <String> [[-LinkN] <Hashtable>] [[-Nodeid] <Int32>] [[-Votes] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The name of the cluster. | true | true (ByPropertyName) | |||
| Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) | false | true (ByPropertyName) | |||
| Node id for this node. | false | true (ByPropertyName) | 0 | ||
| Number of votes for this node. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterConfigJoin
Joins this node into an existing cluster. If no links are given, default to IP resolved by node's hostname on single link (fallback fails for clusters with multiple links).
Syntax
New-PveClusterConfigJoin [[-PveTicket] <PveTicket>] [-Fingerprint] <String> [-Force] [-Hostname] <String> [[-LinkN] <Hashtable>] [[-Nodeid] <Int32>] [-Password] <SecureString> [[-Votes] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Certificate SHA 256 fingerprint. | true | true (ByPropertyName) | |||
| Do not throw error if node already exists. | false | true (ByPropertyName) | False | ||
| Hostname (or IP) of an existing cluster member. | true | true (ByPropertyName) | |||
| Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) | false | true (ByPropertyName) | |||
| Node id for this node. | false | true (ByPropertyName) | 0 | ||
| Superuser (root) password of peer node. | true | true (ByPropertyName) | |||
| Number of votes for this node | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterConfigNodes
Adds a node to the cluster configuration. This call is for internal use.
Syntax
New-PveClusterConfigNodes [[-PveTicket] <PveTicket>] [[-Apiversion] <Int32>] [-Force] [[-LinkN] <Hashtable>] [[-NewNodeIp] <String>] [-Node] <String> [[-Nodeid] <Int32>] [[-Votes] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The JOIN_API_VERSION of the new node. | false | true (ByPropertyName) | 0 | ||
| Do not throw error if node already exists. | false | true (ByPropertyName) | False | ||
| Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) | false | true (ByPropertyName) | |||
| IP Address of node to add. Used as fallback if no links are given. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Node id for this node. | false | true (ByPropertyName) | 0 | ||
| Number of votes for this node | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterFirewallAliases
Create IP or Network Alias.
Syntax
New-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Alias name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterFirewallGroups
Create new security group.
Syntax
New-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Digest] <String>] [-Group] <String> [[-Rename] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Security Group name. | true | true (ByPropertyName) | |||
| 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.
New-PveClusterFirewallGroupsIdx
Create new rule.
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 |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. | true | true (ByPropertyName) | |||
| Descriptive comment. | false | true (ByPropertyName) | |||
| 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) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| 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) | |||
| Flag to enable/disable a rule. | false | true (ByPropertyName) | 0 | ||
| Security Group name. | true | true (ByPropertyName) | |||
| Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. | false | true (ByPropertyName) | |||
| 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 level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Use predefined standard macro. | false | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 | ||
| IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. | false | true (ByPropertyName) | |||
| 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) | |||
| 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) | |||
| 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.
New-PveClusterFirewallIpset
Create new IPSet
Syntax
New-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [[-Rename] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) | |||
| 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.
New-PveClusterFirewallIpsetIdx
Add IP or Network to IPSet.
Syntax
New-PveClusterFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Nomatch] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterFirewallRules
Create new rule.
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 |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. | true | true (ByPropertyName) | |||
| Descriptive comment. | false | true (ByPropertyName) | |||
| 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) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| 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) | |||
| Flag to enable/disable a rule. | false | true (ByPropertyName) | 0 | ||
| Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. | false | true (ByPropertyName) | |||
| 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 level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Use predefined standard macro. | false | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 | ||
| IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. | false | true (ByPropertyName) | |||
| 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) | |||
| 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) | |||
| 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.
New-PveClusterHaGroups
Create a new HA group.
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 |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Description. | false | true (ByPropertyName) | |||
| The HA group identifier. | true | true (ByPropertyName) | |||
| List of cluster node names with optional priority. | true | true (ByPropertyName) | |||
| 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 | ||
| Resources bound to restricted groups may only run on nodes defined by the group. | false | true (ByPropertyName) | False | ||
| Group type. Enum: group | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterHaResources
Create a new HA resource.
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 |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Description. | false | true (ByPropertyName) | |||
| The HA group identifier. | false | true (ByPropertyName) | |||
| Maximal number of service relocate tries when a service failes to start. | false | true (ByPropertyName) | 0 | ||
| Maximal number of tries to restart the service on a node after its start failed. | false | true (ByPropertyName) | 0 | ||
| 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) | |||
| Requested resource state. Enum: started,stopped,enabled,disabled,ignored | false | true (ByPropertyName) | |||
| 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.
New-PveClusterHaResourcesMigrate
Request resource migration (online) to another node.
Syntax
New-PveClusterHaResourcesMigrate [[-PveTicket] <PveTicket>] [-Node] <String> [-Sid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Target node. | true | true (ByPropertyName) | |||
| HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100). | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterHaResourcesRelocate
Request resource relocatzion to another node. This stops the service on the old node, and restarts it on the target node.
Syntax
New-PveClusterHaResourcesRelocate [[-PveTicket] <PveTicket>] [-Node] <String> [-Sid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Target node. | true | true (ByPropertyName) | |||
| HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100). | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterJobsRealmSync
Create new realm-sync job.
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 |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Description for the Job. | false | true (ByPropertyName) | |||
| Enable newly synced users immediately. | false | true (ByPropertyName) | False | ||
| Determines if the job is enabled. | false | true (ByPropertyName) | False | ||
| The ID of the job. | true | true (ByPropertyName) | |||
| Authentication domain ID | false | true (ByPropertyName) | |||
| A semicolon-seperated list of things to remove when they or the user vanishes during a sync. The following values are possible':' 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default). | false | true (ByPropertyName) | |||
| Backup schedule. The format is a subset of `systemd` calendar events. | true | true (ByPropertyName) | |||
| Select what to sync. Enum: users,groups,both | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterMappingPci
Create a new hardware mapping.
Syntax
New-PveClusterMappingPci [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Id] <String> [-Map] <Array> [-Mdev] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Description of the logical PCI device. | false | true (ByPropertyName) | |||
| The ID of the logical PCI mapping. | true | true (ByPropertyName) | |||
| A list of maps for the cluster nodes. | true | true (ByPropertyName) | |||
| Marks the device(s) as being capable of providing mediated devices. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterMappingUsb
Create a new hardware mapping.
Syntax
New-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Id] <String> [-Map] <Array> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Description of the logical USB device. | false | true (ByPropertyName) | |||
| The ID of the logical USB mapping. | true | true (ByPropertyName) | |||
| 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.
New-PveClusterMetricsServer
Create a new external metric server config
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 |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| 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) | |||
| The InfluxDB bucket/db. Only necessary when using the http v2 api. | false | true (ByPropertyName) | |||
| Flag to disable the plugin. | false | true (ByPropertyName) | False | ||
| The ID of the entry. | true | true (ByPropertyName) | |||
| -- Enum: udp,http,https | false | true (ByPropertyName) | |||
| InfluxDB max-body-size in bytes. Requests are batched up to this size. | false | true (ByPropertyName) | 0 | ||
| MTU for metrics transmission over UDP | false | true (ByPropertyName) | 0 | ||
| The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api. | false | true (ByPropertyName) | |||
| root graphite path (ex':' proxmox.mycluster.mykey) | false | true (ByPropertyName) | |||
| server network port | true | true (ByPropertyName) | 0 | ||
| Protocol to send graphite data. TCP or UDP (default) Enum: udp,tcp | false | true (ByPropertyName) | |||
| server dns name or IP address | true | true (ByPropertyName) | |||
| graphite TCP socket timeout (default=1) | false | true (ByPropertyName) | 0 | ||
| 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) | |||
| Plugin type. Enum: graphite,influxdb | true | true (ByPropertyName) | |||
| 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.
New-PveClusterNotificationsEndpointsGotify
Create a new gotify endpoint
Syntax
New-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Disable] [-Name] <String> [-Server] <String> [-Token] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Comment | false | true (ByPropertyName) | |||
| Disable this target | false | true (ByPropertyName) | False | ||
| The name of the endpoint. | true | true (ByPropertyName) | |||
| Server URL | true | true (ByPropertyName) | |||
| Secret token | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterNotificationsEndpointsSendmail
Create a new sendmail endpoint
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 |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Author of the mail | false | true (ByPropertyName) | |||
| Comment | false | true (ByPropertyName) | |||
| Disable this target | false | true (ByPropertyName) | False | ||
| `From` address for the mail | false | true (ByPropertyName) | |||
| List of email recipients | false | true (ByPropertyName) | |||
| List of users | false | true (ByPropertyName) | |||
| 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.
New-PveClusterNotificationsEndpointsSmtp
Create a new smtp endpoint
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 |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Author of the mail. Defaults to 'Proxmox VE'. | false | true (ByPropertyName) | |||
| Comment | false | true (ByPropertyName) | |||
| Disable this target | false | true (ByPropertyName) | False | ||
| `From` address for the mail | true | true (ByPropertyName) | |||
| List of email recipients | false | true (ByPropertyName) | |||
| List of users | false | true (ByPropertyName) | |||
| Determine which encryption method shall be used for the connection. Enum: insecure,starttls,tls | false | true (ByPropertyName) | |||
| The name of the endpoint. | true | true (ByPropertyName) | |||
| Password for SMTP authentication | false | true (ByPropertyName) | |||
| The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections. | false | true (ByPropertyName) | 0 | ||
| The address of the SMTP server. | true | true (ByPropertyName) | |||
| Username for SMTP authentication | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterNotificationsMatchers
Create a new matcher
Syntax
New-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Disable] [-InvertMatch] [[-MatchCalendar] <Array>] [[-MatchField] <Array>] [[-MatchSeverity] <Array>] [[-Mode] <String>] [-Name] <String> [[-Target] <Array>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Comment | false | true (ByPropertyName) | |||
| Disable this matcher | false | true (ByPropertyName) | False | ||
| Invert match of the whole matcher | false | true (ByPropertyName) | False | ||
| Match notification timestamp | false | true (ByPropertyName) | |||
| Metadata fields to match (regex or exact match). Must be in the form (regex|exact)':'<field>=<value> | false | true (ByPropertyName) | |||
| Notification severities to match | false | true (ByPropertyName) | |||
| Choose between 'all' and 'any' for when multiple properties are specified Enum: all,any | false | true (ByPropertyName) | |||
| Name of the matcher. | true | true (ByPropertyName) | |||
| Targets to notify on match | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterReplication
Create a new replication job
Syntax
New-PveClusterReplication [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Disable] [-Id] <String> [[-Rate] <Single>] [[-RemoveJob] <String>] [[-Schedule] <String>] [[-Source] <String>] [-Target] <String> [-Type] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Description. | false | true (ByPropertyName) | |||
| Flag to disable/deactivate the entry. | false | true (ByPropertyName) | False | ||
| Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. | true | true (ByPropertyName) | |||
| Rate limit in mbps (megabytes per second) as floating point number. | false | true (ByPropertyName) | 0 | ||
| Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. Enum: local,full | false | true (ByPropertyName) | |||
| Storage replication schedule. The format is a subset of `systemd` calendar events. | false | true (ByPropertyName) | |||
| For internal use, to detect if the guest was stolen. | false | true (ByPropertyName) | |||
| Target node. | true | true (ByPropertyName) | |||
| Section type. Enum: local | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterSdnControllers
Create a new sdn controller object.
Syntax
New-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [[-Asn] <Int32>] [-BgpMultipathAsPathRelax] [-Controller] <String> [-Ebgp] [[-EbgpMultihop] <Int32>] [[-IsisDomain] <String>] [[-IsisIfaces] <String>] [[-IsisNet] <String>] [[-Loopback] <String>] [[-Node] <String>] [[-Peers] <String>] [-Type] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| autonomous system number | false | true (ByPropertyName) | 0 | ||
| -- | false | true (ByPropertyName) | False | ||
| The SDN controller object identifier. | true | true (ByPropertyName) | |||
| Enable ebgp. (remote-as external) | false | true (ByPropertyName) | False | ||
| -- | false | true (ByPropertyName) | 0 | ||
| ISIS domain. | false | true (ByPropertyName) | |||
| ISIS interface. | false | true (ByPropertyName) | |||
| ISIS network entity title. | false | true (ByPropertyName) | |||
| source loopback interface. | false | true (ByPropertyName) | |||
| The cluster node name. | false | true (ByPropertyName) | |||
| peers address list. | false | true (ByPropertyName) | |||
| Plugin type. Enum: bgp,evpn,faucet,isis | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterSdnDns
Create a new sdn dns object.
Syntax
New-PveClusterSdnDns [[-PveTicket] <PveTicket>] [-Dns] <String> [-Key] <String> [[-Reversemaskv6] <Int32>] [[-Reversev6mask] <Int32>] [[-Ttl] <Int32>] [-Type] <String> [-Url] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The SDN dns object identifier. | true | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| -- | false | true (ByPropertyName) | 0 | ||
| -- | false | true (ByPropertyName) | 0 | ||
| Plugin type. Enum: powerdns | true | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterSdnIpams
Create a new sdn ipam object.
Syntax
New-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [-Ipam] <String> [[-Section] <Int32>] [[-Token] <String>] [-Type] <String> [[-Url] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The SDN ipam object identifier. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| -- | false | true (ByPropertyName) | |||
| Plugin type. Enum: netbox,phpipam,pve | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterSdnVnets
Create a new sdn vnet object.
Syntax
New-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [[-Alias] <String>] [[-Tag] <Int32>] [[-Type] <String>] [-Vlanaware] [-Vnet] <String> [-Zone] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| alias name of the vnet | false | true (ByPropertyName) | |||
| vlan or vxlan id | false | true (ByPropertyName) | 0 | ||
| Type Enum: vnet | false | true (ByPropertyName) | |||
| Allow vm VLANs to pass through this vnet. | false | true (ByPropertyName) | False | ||
| The SDN vnet object identifier. | true | true (ByPropertyName) | |||
| zone id | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterSdnVnetsIps
Create IP Mapping in a VNet
Syntax
New-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The IP address to associate with the given MAC address | true | true (ByPropertyName) | |||
| Unicast MAC address. | false | true (ByPropertyName) | |||
| The SDN vnet object identifier. | true | true (ByPropertyName) | |||
| The SDN zone object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterSdnVnetsSubnets
Create a new sdn subnet object.
Syntax
New-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [[-DhcpDnsServer] <String>] [[-DhcpRange] <Array>] [[-Dnszoneprefix] <String>] [[-Gateway] <String>] [-Snat] [-Subnet] <String> [-Type] <String> [-Vnet] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| IP address for the DNS server | false | true (ByPropertyName) | |||
| A list of DHCP ranges for this subnet | false | true (ByPropertyName) | |||
| dns domain zone prefix ex':' 'adm' -> <hostname>.adm.mydomain.com | false | true (ByPropertyName) | |||
| Subnet Gateway':' Will be assign on vnet for layer3 zones | false | true (ByPropertyName) | |||
| enable masquerade for this subnet if pve-firewall | false | true (ByPropertyName) | False | ||
| The SDN subnet object identifier. | true | true (ByPropertyName) | |||
| -- Enum: subnet | true | true (ByPropertyName) | |||
| associated vnet | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveClusterSdnZones
Create a new sdn zone object.
Syntax
New-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-AdvertiseSubnets] [[-Bridge] <String>] [-BridgeDisableMacLearning] [[-Controller] <String>] [[-Dhcp] <String>] [-DisableArpNdSuppression] [[-Dns] <String>] [[-Dnszone] <String>] [[-DpId] <Int32>] [[-Exitnodes] <String>] [-ExitnodesLocalRouting] [[-ExitnodesPrimary] <String>] [[-Ipam] <String>] [[-Mac] <String>] [[-Mtu] <Int32>] [[-Nodes] <String>] [[-Peers] <String>] [[-Reversedns] <String>] [[-RtImport] <String>] [[-Tag] <Int32>] [-Type] <String> [[-VlanProtocol] <String>] [[-VrfVxlan] <Int32>] [[-VxlanPort] <Int32>] [-Zone] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Advertise evpn subnets if you have silent hosts | false | true (ByPropertyName) | False | ||
| -- | false | true (ByPropertyName) | |||
| Disable auto mac learning. | false | true (ByPropertyName) | False | ||
| Frr router name | false | true (ByPropertyName) | |||
| Type of the DHCP backend for this zone Enum: dnsmasq | false | true (ByPropertyName) | |||
| Disable ipv4 arp && ipv6 neighbour discovery suppression | false | true (ByPropertyName) | False | ||
| dns api server | false | true (ByPropertyName) | |||
| dns domain zone ex':' mydomain.com | false | true (ByPropertyName) | |||
| Faucet dataplane id | false | true (ByPropertyName) | 0 | ||
| List of cluster node names. | false | true (ByPropertyName) | |||
| Allow exitnodes to connect to evpn guests | false | true (ByPropertyName) | False | ||
| Force traffic to this exitnode first. | false | true (ByPropertyName) | |||
| use a specific ipam | false | true (ByPropertyName) | |||
| Anycast logical router mac address | false | true (ByPropertyName) | |||
| MTU | false | true (ByPropertyName) | 0 | ||
| List of cluster node names. | false | true (ByPropertyName) | |||
| peers address list. | false | true (ByPropertyName) | |||
| reverse dns api server | false | true (ByPropertyName) | |||
| Route-Target import | false | true (ByPropertyName) | |||
| Service-VLAN Tag | false | true (ByPropertyName) | 0 | ||
| Plugin type. Enum: evpn,faucet,qinq,simple,vlan,vxlan | true | true (ByPropertyName) | |||
| -- Enum: 802.1q,802.1ad | false | true (ByPropertyName) | |||
| l3vni. | false | true (ByPropertyName) | 0 | ||
| Vxlan tunnel udp port (default 4789). | false | true (ByPropertyName) | 0 | ||
| 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.
New-PveNodesAplinfo
Download appliance templates.
Syntax
New-PveNodesAplinfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Storage] <String> [-Template] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage where the template will be stored | true | true (ByPropertyName) | |||
| The template which will downloaded | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesAptRepositories
Change the properties of a repository. Currently only allows enabling/disabling.
Syntax
New-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Enabled] [-Index] <Int32> [-Node] <String> [-Path] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Digest to detect modifications. | false | true (ByPropertyName) | |||
| Whether the repository should be enabled or not. | false | true (ByPropertyName) | False | ||
| Index within the file (starting from 0). | true | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Path to the containing file. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesAptUpdate
This is used to resynchronize the package index files from their sources (apt-get update).
Aliases
- Update-PveNode
Syntax
New-PveNodesAptUpdate [[-PveTicket] <PveTicket>] [-Node] <String> [-Notify] [-Quiet] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Send notification about new packages. | false | true (ByPropertyName) | False | ||
| Only produces output suitable for logging, omitting progress indicators. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesCephFs
Create a Ceph filesystem
Syntax
New-PveNodesCephFs [[-PveTicket] <PveTicket>] [-AddStorage] [[-Name] <String>] [-Node] <String> [[-PgNum] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Configure the created CephFS as storage for this cluster. | false | true (ByPropertyName) | False | ||
| The ceph filesystem name. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Number of placement groups for the backing data pool. The metadata pool will use a quarter of this. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesCephInit
Create initial ceph default configuration and setup symlinks.
Syntax
New-PveNodesCephInit [[-PveTicket] <PveTicket>] [[-ClusterNetwork] <String>] [-DisableCephx] [[-MinSize] <Int32>] [[-Network] <String>] [-Node] <String> [[-PgBits] <Int32>] [[-Size] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it | false | true (ByPropertyName) | |||
| Disable cephx authentication.WARNING':' cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private! | false | true (ByPropertyName) | False | ||
| Minimum number of available replicas per object to allow I/O | false | true (ByPropertyName) | 0 | ||
| Use specific network for all ceph related traffic | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Placement group bits, used to specify the default number of placement groups.Depreacted. This setting was deprecated in recent Ceph versions. | false | true (ByPropertyName) | 0 | ||
| Targeted number of replicas per object | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesCephMds
Create Ceph Metadata Server (MDS)
Syntax
New-PveNodesCephMds [[-PveTicket] <PveTicket>] [-Hotstandby] [[-Name] <String>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Determines whether a ceph-mds daemon should poll and replay the log of an active MDS. Faster switch on MDS failure, but needs more idle resources. | false | true (ByPropertyName) | False | ||
| The ID for the mds, when omitted the same as the nodename | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesCephMgr
Create Ceph Manager
Syntax
New-PveNodesCephMgr [[-PveTicket] <PveTicket>] [[-Id] <String>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The ID for the manager, when omitted the same as the nodename | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesCephMon
Create Ceph Monitor and Manager
Syntax
New-PveNodesCephMon [[-PveTicket] <PveTicket>] [[-MonAddress] <String>] [[-Monid] <String>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Overwrites autodetected monitor IP address(es). Must be in the public network(s) of Ceph. | false | true (ByPropertyName) | |||
| The ID for the monitor, when omitted the same as the nodename | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesCephOsd
Create OSD
Syntax
New-PveNodesCephOsd [[-PveTicket] <PveTicket>] [[-CrushDeviceClass] <String>] [[-DbDev] <String>] [[-DbDevSize] <Single>] [-Dev] <String> [-Encrypted] [-Node] <String> [[-OsdsPerDevice] <Int32>] [[-WalDev] <String>] [[-WalDevSize] <Single>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Set the device class of the OSD in crush. | false | true (ByPropertyName) | |||
| Block device name for block.db. | false | true (ByPropertyName) | |||
| Size in GiB for block.db. | false | true (ByPropertyName) | 0 | ||
| Block device name. | true | true (ByPropertyName) | |||
| Enables encryption of the OSD. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| OSD services per physical device. Only useful for fast NVMe devices" ." to utilize their performance better. | false | true (ByPropertyName) | 0 | ||
| Block device name for block.wal. | false | true (ByPropertyName) | |||
| Size in GiB for block.wal. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesCephOsdIn
ceph osd in
Syntax
New-PveNodesCephOsdIn [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| OSD ID | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesCephOsdOut
ceph osd out
Syntax
New-PveNodesCephOsdOut [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| OSD ID | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesCephOsdScrub
Instruct the OSD to scrub.
Syntax
New-PveNodesCephOsdScrub [[-PveTicket] <PveTicket>] [-Deep] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| If set, instructs a deep scrub instead of a normal one. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| OSD ID | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesCephPool
Create Ceph pool
Syntax
New-PveNodesCephPool [[-PveTicket] <PveTicket>] [-AddStorages] [[-Application] <String>] [[-CrushRule] <String>] [[-ErasureCoding] <String>] [[-MinSize] <Int32>] [-Name] <String> [-Node] <String> [[-PgAutoscaleMode] <String>] [[-PgNum] <Int32>] [[-PgNumMin] <Int32>] [[-Size] <Int32>] [[-TargetSize] <String>] [[-TargetSizeRatio] <Single>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Configure VM and CT storage using the new pool. | false | true (ByPropertyName) | False | ||
| The application of the pool. Enum: rbd,cephfs,rgw | false | true (ByPropertyName) | |||
| The rule to use for mapping object placement in the cluster. | false | true (ByPropertyName) | |||
| Create an erasure coded pool for RBD with an accompaning replicated pool for metadata storage. With EC, the common ceph options 'size', 'min_size' and 'crush_rule' parameters will be applied to the metadata pool. | false | true (ByPropertyName) | |||
| Minimum number of replicas per object | false | true (ByPropertyName) | 0 | ||
| The name of the pool. It must be unique. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The automatic PG scaling mode of the pool. Enum: on,off,warn | false | true (ByPropertyName) | |||
| Number of placement groups. | false | true (ByPropertyName) | 0 | ||
| Minimal number of placement groups. | false | true (ByPropertyName) | 0 | ||
| Number of replicas per object | false | true (ByPropertyName) | 0 | ||
| The estimated target size of the pool for the PG autoscaler. | false | true (ByPropertyName) | |||
| The estimated target ratio of the pool for the PG autoscaler. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesCephRestart
Restart ceph services.
Syntax
New-PveNodesCephRestart [[-PveTicket] <PveTicket>] [-Node] <String> [[-Service] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Ceph service name. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesCephStart
Start ceph services.
Syntax
New-PveNodesCephStart [[-PveTicket] <PveTicket>] [-Node] <String> [[-Service] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Ceph service name. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesCephStop
Stop ceph services.
Syntax
New-PveNodesCephStop [[-PveTicket] <PveTicket>] [-Node] <String> [[-Service] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Ceph service name. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesCertificatesAcmeCertificate
Order a new certificate from ACME-compatible CA.
Syntax
New-PveNodesCertificatesAcmeCertificate [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Overwrite existing custom certificate. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesCertificatesCustom
Upload or update custom certificate chain and key.
Syntax
New-PveNodesCertificatesCustom [[-PveTicket] <PveTicket>] [-Certificates] <String> [-Force] [[-Key] <String>] [-Node] <String> [-Restart] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| PEM encoded certificate (chain). | true | true (ByPropertyName) | |||
| Overwrite existing custom or ACME certificate files. | false | true (ByPropertyName) | False | ||
| PEM encoded private key. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Restart pveproxy. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesDisksDirectory
Create a Filesystem on an unused disk. Will be mounted under '/mnt/pve/NAME'.
Syntax
New-PveNodesDisksDirectory [[-PveTicket] <PveTicket>] [-AddStorage] [-Device] <String> [[-Filesystem] <String>] [-Name] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Configure storage using the directory. | false | true (ByPropertyName) | False | ||
| The block device you want to create the filesystem on. | true | true (ByPropertyName) | |||
| The desired filesystem. Enum: ext4,xfs | false | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesDisksInitgpt
Initialize Disk with GPT
Syntax
New-PveNodesDisksInitgpt [[-PveTicket] <PveTicket>] [-Disk] <String> [-Node] <String> [[-Uuid] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Block device name | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| UUID for the GPT table | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesDisksLvm
Create an LVM Volume Group
Syntax
New-PveNodesDisksLvm [[-PveTicket] <PveTicket>] [-AddStorage] [-Device] <String> [-Name] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Configure storage using the Volume Group | false | true (ByPropertyName) | False | ||
| The block device you want to create the volume group on | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesDisksLvmthin
Create an LVM thinpool
Syntax
New-PveNodesDisksLvmthin [[-PveTicket] <PveTicket>] [-AddStorage] [-Device] <String> [-Name] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Configure storage using the thinpool. | false | true (ByPropertyName) | False | ||
| The block device you want to create the thinpool on. | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesDisksZfs
Create a ZFS pool.
Syntax
New-PveNodesDisksZfs [[-PveTicket] <PveTicket>] [-AddStorage] [[-Ashift] <Int32>] [[-Compression] <String>] [-Devices] <String> [[-DraidConfig] <String>] [-Name] <String> [-Node] <String> [-Raidlevel] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Configure storage using the zpool. | false | true (ByPropertyName) | False | ||
| Pool sector size exponent. | false | true (ByPropertyName) | 0 | ||
| The compression algorithm to use. Enum: on,off,gzip,lz4,lzjb,zle,zstd | false | true (ByPropertyName) | |||
| The block devices you want to create the zpool on. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The RAID level to use. Enum: single,mirror,raid10,raidz,raidz2,raidz3,draid,draid2,draid3 | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesExecute
Execute multiple commands in order, root only.
Syntax
New-PveNodesExecute [[-PveTicket] <PveTicket>] [-Commands] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| JSON encoded array of commands. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesFirewallRules
Create new rule.
Syntax
New-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [-Action] <String> [[-Comment] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [-Type] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. | true | true (ByPropertyName) | |||
| Descriptive comment. | false | true (ByPropertyName) | |||
| 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) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| 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) | |||
| Flag to enable/disable a rule. | false | true (ByPropertyName) | 0 | ||
| Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. | false | true (ByPropertyName) | |||
| 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 level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Use predefined standard macro. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 | ||
| IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. | false | true (ByPropertyName) | |||
| 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) | |||
| 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) | |||
| 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.
New-PveNodesHosts
Write /etc/hosts.
Syntax
New-PveNodesHosts [[-PveTicket] <PveTicket>] [-Data] <String> [[-Digest] <String>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The target content of /etc/hosts. | true | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxc
Create or restore a container.
Syntax
New-PveNodesLxc [[-PveTicket] <PveTicket>] [[-Arch] <String>] [[-Bwlimit] <Single>] [[-Cmode] <String>] [-Console] [[-Cores] <Int32>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [-Debug_] [[-Description] <String>] [[-DevN] <Hashtable>] [[-Features] <String>] [-Force] [[-Hookscript] <String>] [[-Hostname] <String>] [-IgnoreUnpackErrors] [[-Lock] <String>] [[-Memory] <Int32>] [[-MpN] <Hashtable>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Onboot] [-Ostemplate] <String> [[-Ostype] <String>] [[-Password] <SecureString>] [[-Pool] <String>] [-Protection] [-Restore] [[-Rootfs] <String>] [[-Searchdomain] <String>] [[-SshPublicKeys] <String>] [-Start] [[-Startup] <String>] [[-Storage] <String>] [[-Swap] <Int32>] [[-Tags] <String>] [-Template] [[-Timezone] <String>] [[-Tty] <Int32>] [-Unique] [-Unprivileged] [[-UnusedN] <Hashtable>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| OS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64 | false | true (ByPropertyName) | |||
| Override I/O bandwidth limit (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). Enum: shell,console,tty | false | true (ByPropertyName) | |||
| Attach a console device (/dev/console) to the container. | false | true (ByPropertyName) | False | ||
| The number of cores assigned to the container. A container can use all available cores by default. | false | true (ByPropertyName) | 0 | ||
| Limit of CPU usage.NOTE':' If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. | false | true (ByPropertyName) | 0 | ||
| CPU weight for a container, will be clamped to \[1, 10000] in cgroup v2. | false | true (ByPropertyName) | 0 | ||
| Try to be more verbose. For now this only enables debug log-level on start. | false | true (ByPropertyName) | False | ||
| Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. | false | true (ByPropertyName) | |||
| Device to pass through to the container | false | true (ByPropertyName) | |||
| Allow containers access to advanced features. | false | true (ByPropertyName) | |||
| Allow to overwrite existing container. | false | true (ByPropertyName) | False | ||
| Script that will be exectued during various steps in the containers lifetime. | false | true (ByPropertyName) | |||
| Set a host name for the container. | false | true (ByPropertyName) | |||
| Ignore errors when extracting the template. | false | true (ByPropertyName) | False | ||
| Lock/unlock the container. Enum: backup,create,destroyed,disk,fstrim,migrate,mounted,rollback,snapshot,snapshot-delete | false | true (ByPropertyName) | |||
| Amount of RAM for the container in MB. | false | true (ByPropertyName) | 0 | ||
| Use volume as container mount point. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. | false | true (ByPropertyName) | |||
| Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. | false | true (ByPropertyName) | |||
| Specifies network interfaces for the container. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Specifies whether a container will be started during system bootup. | false | true (ByPropertyName) | False | ||
| The OS template or backup file. | true | true (ByPropertyName) | |||
| OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. Enum: debian,devuan,ubuntu,centos,fedora,opensuse,archlinux,alpine,gentoo,nixos,unmanaged | false | true (ByPropertyName) | |||
| Sets root password inside container. | false | true (ByPropertyName) | |||
| Add the VM to the specified pool. | false | true (ByPropertyName) | |||
| Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. | false | true (ByPropertyName) | False | ||
| Mark this as restore task. | false | true (ByPropertyName) | False | ||
| Use volume as container root. | false | true (ByPropertyName) | |||
| Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. | false | true (ByPropertyName) | |||
| Setup public SSH keys (one key per line, OpenSSH format). | false | true (ByPropertyName) | |||
| Start the CT after its creation finished successfully. | false | true (ByPropertyName) | False | ||
| Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. | false | true (ByPropertyName) | |||
| Default Storage. | false | true (ByPropertyName) | |||
| Amount of SWAP for the container in MB. | false | true (ByPropertyName) | 0 | ||
| Tags of the Container. This is only meta information. | false | true (ByPropertyName) | |||
| Enable/disable Template. | false | true (ByPropertyName) | False | ||
| Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab | false | true (ByPropertyName) | |||
| Specify the number of tty available to the container | false | true (ByPropertyName) | 0 | ||
| Assign a unique random ethernet address. | false | true (ByPropertyName) | False | ||
| Makes the container run as unprivileged user. (Should not be modified manually.) | false | true (ByPropertyName) | False | ||
| Reference to unused volumes. This is used internally, and should not be modified manually. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcClone
Create a container clone/copy
Aliases
- Copy-PveLxc
Syntax
New-PveNodesLxcClone [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [[-Description] <String>] [-Full] [[-Hostname] <String>] [-Newid] <Int32> [-Node] <String> [[-Pool] <String>] [[-Snapname] <String>] [[-Storage] <String>] [[-Target] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Override I/O bandwidth limit (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| Description for the new CT. | false | true (ByPropertyName) | |||
| Create a full copy of all disks. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default. | false | true (ByPropertyName) | False | ||
| Set a hostname for the new CT. | false | true (ByPropertyName) | |||
| VMID for the clone. | true | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Add the new CT to the specified pool. | false | true (ByPropertyName) | |||
| The name of the snapshot. | false | true (ByPropertyName) | |||
| Target storage for full clone. | false | true (ByPropertyName) | |||
| Target node. Only allowed if the original VM is on shared storage. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcFirewallAliases
Create IP or Network Alias.
Syntax
New-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Alias name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcFirewallIpset
Create new IPSet
Syntax
New-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| 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) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcFirewallIpsetIdx
Add IP or Network to IPSet.
Syntax
New-PveNodesLxcFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | False | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcFirewallRules
Create new rule.
Syntax
New-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [-Action] <String> [[-Comment] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [-Type] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. | true | true (ByPropertyName) | |||
| Descriptive comment. | false | true (ByPropertyName) | |||
| 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) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| 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) | |||
| Flag to enable/disable a rule. | false | true (ByPropertyName) | 0 | ||
| Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. | false | true (ByPropertyName) | |||
| 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 level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Use predefined standard macro. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 | ||
| IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. | false | true (ByPropertyName) | |||
| 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) | |||
| 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) | |||
| Rule type. Enum: in,out,group | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcMigrate
Migrate the container to another node. Creates a new migration task.
Aliases
- Move-PveLxc
Syntax
New-PveNodesLxcMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [-Node] <String> [-Online] [-Restart] [-Target] <String> [[-TargetStorage] <String>] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Override I/O bandwidth limit (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Use online/live migration. | false | true (ByPropertyName) | False | ||
| Use restart migration | false | true (ByPropertyName) | False | ||
| Target node. | true | true (ByPropertyName) | |||
| Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. | false | true (ByPropertyName) | |||
| Timeout in seconds for shutdown for restart migration | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcMoveVolume
Move a rootfs-/mp-volume to a different storage or to a different container.
Syntax
New-PveNodesLxcMoveVolume [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [-Delete] [[-Digest] <String>] [-Node] <String> [[-Storage] <String>] [[-TargetDigest] <String>] [[-TargetVmid] <Int32>] [[-TargetVolume] <String>] [-Vmid] <Int32> [-Volume] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Override I/O bandwidth limit (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| Delete the original volume after successful copy. By default the original is kept as an unused volume entry. | false | true (ByPropertyName) | False | ||
| Prevent changes if current configuration file has different SHA1 " . "digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Target Storage. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file of the target " . "container has a different SHA1 digest. This can be used to prevent " . "concurrent modifications. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | false | true (ByPropertyName) | 0 | ||
| The config key the volume will be moved to. Default is the source volume key. Enum: rootfs,mp0,mp1,mp2,mp3,mp4,mp5,mp6,mp7,mp8,mp9,mp10,mp11,mp12,mp13,mp14,mp15,mp16,mp17,mp18,mp19,mp20,mp21,mp22,mp23,mp24,mp25,mp26,mp27,mp28,mp29,mp30,mp31,mp32,mp33,mp34,mp35,mp36,mp37,mp38,mp39,mp40,mp41,mp42,mp43,mp44,mp45,mp46,mp47,mp48,mp49,mp50,mp51,mp52,mp53,mp54,mp55,mp56,mp57,mp58,mp59,mp60,mp61,mp62,mp63,mp64,mp65,mp66,mp67,mp68,mp69,mp70,mp71,mp72,mp73,mp74,mp75,mp76,mp77,mp78,mp79,mp80,mp81,mp82,mp83,mp84,mp85,mp86,mp87,mp88,mp89,mp90,mp91,mp92,mp93,mp94,mp95,mp96,mp97,mp98,mp99,mp100,mp101,mp102,mp103,mp104,mp105,mp106,mp107,mp108,mp109,mp110,mp111,mp112,mp113,mp114,mp115,mp116,mp117,mp118,mp119,mp120,mp121,mp122,mp123,mp124,mp125,mp126,mp127,mp128,mp129,mp130,mp131,mp132,mp133,mp134,mp135,mp136,mp137,mp138,mp139,mp140,mp141,mp142,mp143,mp144,mp145,mp146,mp147,mp148,mp149,mp150,mp151,mp152,mp153,mp154,mp155,mp156,mp157,mp158,mp159,mp160,mp161,mp162,mp163,mp164,mp165,mp166,mp167,mp168,mp169,mp170,mp171,mp172,mp173,mp174,mp175,mp176,mp177,mp178,mp179,mp180,mp181,mp182,mp183,mp184,mp185,mp186,mp187,mp188,mp189,mp190,mp191,mp192,mp193,mp194,mp195,mp196,mp197,mp198,mp199,mp200,mp201,mp202,mp203,mp204,mp205,mp206,mp207,mp208,mp209,mp210,mp211,mp212,mp213,mp214,mp215,mp216,mp217,mp218,mp219,mp220,mp221,mp222,mp223,mp224,mp225,mp226,mp227,mp228,mp229,mp230,mp231,mp232,mp233,mp234,mp235,mp236,mp237,mp238,mp239,mp240,mp241,mp242,mp243,mp244,mp245,mp246,mp247,mp248,mp249,mp250,mp251,mp252,mp253,mp254,mp255,unused0,unused1,unused2,unused3,unused4,unused5,unused6,unused7,unused8,unused9,unused10,unused11,unused12,unused13,unused14,unused15,unused16,unused17,unused18,unused19,unused20,unused21,unused22,unused23,unused24,unused25,unused26,unused27,unused28,unused29,unused30,unused31,unused32,unused33,unused34,unused35,unused36,unused37,unused38,unused39,unused40,unused41,unused42,unused43,unused44,unused45,unused46,unused47,unused48,unused49,unused50,unused51,unused52,unused53,unused54,unused55,unused56,unused57,unused58,unused59,unused60,unused61,unused62,unused63,unused64,unused65,unused66,unused67,unused68,unused69,unused70,unused71,unused72,unused73,unused74,unused75,unused76,unused77,unused78,unused79,unused80,unused81,unused82,unused83,unused84,unused85,unused86,unused87,unused88,unused89,unused90,unused91,unused92,unused93,unused94,unused95,unused96,unused97,unused98,unused99,unused100,unused101,unused102,unused103,unused104,unused105,unused106,unused107,unused108,unused109,unused110,unused111,unused112,unused113,unused114,unused115,unused116,unused117,unused118,unused119,unused120,unused121,unused122,unused123,unused124,unused125,unused126,unused127,unused128,unused129,unused130,unused131,unused132,unused133,unused134,unused135,unused136,unused137,unused138,unused139,unused140,unused141,unused142,unused143,unused144,unused145,unused146,unused147,unused148,unused149,unused150,unused151,unused152,unused153,unused154,unused155,unused156,unused157,unused158,unused159,unused160,unused161,unused162,unused163,unused164,unused165,unused166,unused167,unused168,unused169,unused170,unused171,unused172,unused173,unused174,unused175,unused176,unused177,unused178,unused179,unused180,unused181,unused182,unused183,unused184,unused185,unused186,unused187,unused188,unused189,unused190,unused191,unused192,unused193,unused194,unused195,unused196,unused197,unused198,unused199,unused200,unused201,unused202,unused203,unused204,unused205,unused206,unused207,unused208,unused209,unused210,unused211,unused212,unused213,unused214,unused215,unused216,unused217,unused218,unused219,unused220,unused221,unused222,unused223,unused224,unused225,unused226,unused227,unused228,unused229,unused230,unused231,unused232,unused233,unused234,unused235,unused236,unused237,unused238,unused239,unused240,unused241,unused242,unused243,unused244,unused245,unused246,unused247,unused248,unused249,unused250,unused251,unused252,unused253,unused254,unused255 | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 | ||
| Volume which will be moved. Enum: rootfs,mp0,mp1,mp2,mp3,mp4,mp5,mp6,mp7,mp8,mp9,mp10,mp11,mp12,mp13,mp14,mp15,mp16,mp17,mp18,mp19,mp20,mp21,mp22,mp23,mp24,mp25,mp26,mp27,mp28,mp29,mp30,mp31,mp32,mp33,mp34,mp35,mp36,mp37,mp38,mp39,mp40,mp41,mp42,mp43,mp44,mp45,mp46,mp47,mp48,mp49,mp50,mp51,mp52,mp53,mp54,mp55,mp56,mp57,mp58,mp59,mp60,mp61,mp62,mp63,mp64,mp65,mp66,mp67,mp68,mp69,mp70,mp71,mp72,mp73,mp74,mp75,mp76,mp77,mp78,mp79,mp80,mp81,mp82,mp83,mp84,mp85,mp86,mp87,mp88,mp89,mp90,mp91,mp92,mp93,mp94,mp95,mp96,mp97,mp98,mp99,mp100,mp101,mp102,mp103,mp104,mp105,mp106,mp107,mp108,mp109,mp110,mp111,mp112,mp113,mp114,mp115,mp116,mp117,mp118,mp119,mp120,mp121,mp122,mp123,mp124,mp125,mp126,mp127,mp128,mp129,mp130,mp131,mp132,mp133,mp134,mp135,mp136,mp137,mp138,mp139,mp140,mp141,mp142,mp143,mp144,mp145,mp146,mp147,mp148,mp149,mp150,mp151,mp152,mp153,mp154,mp155,mp156,mp157,mp158,mp159,mp160,mp161,mp162,mp163,mp164,mp165,mp166,mp167,mp168,mp169,mp170,mp171,mp172,mp173,mp174,mp175,mp176,mp177,mp178,mp179,mp180,mp181,mp182,mp183,mp184,mp185,mp186,mp187,mp188,mp189,mp190,mp191,mp192,mp193,mp194,mp195,mp196,mp197,mp198,mp199,mp200,mp201,mp202,mp203,mp204,mp205,mp206,mp207,mp208,mp209,mp210,mp211,mp212,mp213,mp214,mp215,mp216,mp217,mp218,mp219,mp220,mp221,mp222,mp223,mp224,mp225,mp226,mp227,mp228,mp229,mp230,mp231,mp232,mp233,mp234,mp235,mp236,mp237,mp238,mp239,mp240,mp241,mp242,mp243,mp244,mp245,mp246,mp247,mp248,mp249,mp250,mp251,mp252,mp253,mp254,mp255,unused0,unused1,unused2,unused3,unused4,unused5,unused6,unused7,unused8,unused9,unused10,unused11,unused12,unused13,unused14,unused15,unused16,unused17,unused18,unused19,unused20,unused21,unused22,unused23,unused24,unused25,unused26,unused27,unused28,unused29,unused30,unused31,unused32,unused33,unused34,unused35,unused36,unused37,unused38,unused39,unused40,unused41,unused42,unused43,unused44,unused45,unused46,unused47,unused48,unused49,unused50,unused51,unused52,unused53,unused54,unused55,unused56,unused57,unused58,unused59,unused60,unused61,unused62,unused63,unused64,unused65,unused66,unused67,unused68,unused69,unused70,unused71,unused72,unused73,unused74,unused75,unused76,unused77,unused78,unused79,unused80,unused81,unused82,unused83,unused84,unused85,unused86,unused87,unused88,unused89,unused90,unused91,unused92,unused93,unused94,unused95,unused96,unused97,unused98,unused99,unused100,unused101,unused102,unused103,unused104,unused105,unused106,unused107,unused108,unused109,unused110,unused111,unused112,unused113,unused114,unused115,unused116,unused117,unused118,unused119,unused120,unused121,unused122,unused123,unused124,unused125,unused126,unused127,unused128,unused129,unused130,unused131,unused132,unused133,unused134,unused135,unused136,unused137,unused138,unused139,unused140,unused141,unused142,unused143,unused144,unused145,unused146,unused147,unused148,unused149,unused150,unused151,unused152,unused153,unused154,unused155,unused156,unused157,unused158,unused159,unused160,unused161,unused162,unused163,unused164,unused165,unused166,unused167,unused168,unused169,unused170,unused171,unused172,unused173,unused174,unused175,unused176,unused177,unused178,unused179,unused180,unused181,unused182,unused183,unused184,unused185,unused186,unused187,unused188,unused189,unused190,unused191,unused192,unused193,unused194,unused195,unused196,unused197,unused198,unused199,unused200,unused201,unused202,unused203,unused204,unused205,unused206,unused207,unused208,unused209,unused210,unused211,unused212,unused213,unused214,unused215,unused216,unused217,unused218,unused219,unused220,unused221,unused222,unused223,unused224,unused225,unused226,unused227,unused228,unused229,unused230,unused231,unused232,unused233,unused234,unused235,unused236,unused237,unused238,unused239,unused240,unused241,unused242,unused243,unused244,unused245,unused246,unused247,unused248,unused249,unused250,unused251,unused252,unused253,unused254,unused255 | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcMtunnel
Migration tunnel endpoint - only for internal use by CT migration.
Syntax
New-PveNodesLxcMtunnel [[-PveTicket] <PveTicket>] [[-Bridges] <String>] [-Node] <String> [[-Storages] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| List of network bridges to check availability. Will be checked again for actually used bridges during migration. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| List of storages to check permission and availability. Will be checked again for all actually used storages during migration. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcRemoteMigrate
Migrate the container to another cluster. Creates a new migration task. EXPERIMENTAL feature!
Syntax
New-PveNodesLxcRemoteMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [-Delete] [-Node] <String> [-Online] [-Restart] [-TargetBridge] <String> [-TargetEndpoint] <String> [-TargetStorage] <String> [[-TargetVmid] <Int32>] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Override I/O bandwidth limit (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| Delete the original CT and related data after successful migration. By default the original CT is kept on the source cluster in a stopped state. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Use online/live migration. | false | true (ByPropertyName) | False | ||
| Use restart migration | false | true (ByPropertyName) | False | ||
| Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself. | true | true (ByPropertyName) | |||
| Remote target endpoint | true | true (ByPropertyName) | |||
| Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | false | true (ByPropertyName) | 0 | ||
| Timeout in seconds for shutdown for restart migration | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcSnapshot
Snapshot a container.
Syntax
New-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A textual description or comment. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcSnapshotRollback
Rollback LXC state to specified snapshot.
Syntax
New-PveNodesLxcSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| Whether the container should get started after rolling back successfully | false | true (ByPropertyName) | False | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcSpiceproxy
Returns a SPICE configuration to connect to the CT.
Syntax
New-PveNodesLxcSpiceproxy [[-PveTicket] <PveTicket>] [-Node] <String> [[-Proxy] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI). | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcStatusReboot
Reboot the container by shutting it down, and starting it again. Applies pending changes.
Aliases
- Restart-PveLxc
Syntax
New-PveNodesLxcStatusReboot [[-PveTicket] <PveTicket>] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Wait maximal timeout seconds for the shutdown. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcStatusResume
Resume the container.
Aliases
- Resume-PveLxc
Syntax
New-PveNodesLxcStatusResume [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcStatusShutdown
Shutdown the container. This will trigger a clean shutdown of the container, see lxc-stop(1) for details.
Syntax
New-PveNodesLxcStatusShutdown [[-PveTicket] <PveTicket>] [-Forcestop] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Make sure the Container stops. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Wait maximal timeout seconds. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcStatusStart
Start the container.
Aliases
- Start-PveLxc
Syntax
New-PveNodesLxcStatusStart [[-PveTicket] <PveTicket>] [-Debug_] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| If set, enables very verbose debug log-level on start. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Ignore locks - only root is allowed to use this option. | false | true (ByPropertyName) | False | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcStatusStop
Stop the container. This will abruptly stop all processes running in the container.
Aliases
- Stop-PveLxc
Syntax
New-PveNodesLxcStatusStop [[-PveTicket] <PveTicket>] [-Node] <String> [-OverruleShutdown] [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Try to abort active 'vzshutdown' tasks before stopping. | false | true (ByPropertyName) | False | ||
| Ignore locks - only root is allowed to use this option. | false | true (ByPropertyName) | False | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcStatusSuspend
Suspend the container. This is experimental.
Aliases
- Suspend-PveLxc
Syntax
New-PveNodesLxcStatusSuspend [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcTemplate
Create a Template.
Syntax
New-PveNodesLxcTemplate [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcTermproxy
Creates a TCP proxy connection.
Syntax
New-PveNodesLxcTermproxy [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesLxcVncproxy
Creates a TCP VNC proxy connections.
Syntax
New-PveNodesLxcVncproxy [[-PveTicket] <PveTicket>] [[-Height] <Int32>] [-Node] <String> [-Vmid] <Int32> [-Websocket] [[-Width] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| sets the height of the console in pixels. | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 | ||
| use websocket instead of standard VNC. | false | true (ByPropertyName) | False | ||
| sets the width of the console in pixels. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesMigrateall
Migrate all VMs and Containers.
Syntax
New-PveNodesMigrateall [[-PveTicket] <PveTicket>] [[-Maxworkers] <Int32>] [-Node] <String> [-Target] <String> [[-Vms] <String>] [-WithLocalDisks] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg. One of both must be set! | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Target node. | true | true (ByPropertyName) | |||
| Only consider Guests with these IDs. | false | true (ByPropertyName) | |||
| Enable live storage migration for local disk | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesNetwork
Create network device configuration
Syntax
New-PveNodesNetwork [[-PveTicket] <PveTicket>] [[-Address] <String>] [[-Address6] <String>] [-Autostart] [[-BondPrimary] <String>] [[-BondMode] <String>] [[-BondXmitHashPolicy] <String>] [[-BridgePorts] <String>] [-BridgeVlanAware] [[-Cidr] <String>] [[-Cidr6] <String>] [[-Comments] <String>] [[-Comments6] <String>] [[-Gateway] <String>] [[-Gateway6] <String>] [-Iface] <String> [[-Mtu] <Int32>] [[-Netmask] <String>] [[-Netmask6] <Int32>] [-Node] <String> [[-OvsBonds] <String>] [[-OvsBridge] <String>] [[-OvsOptions] <String>] [[-OvsPorts] <String>] [[-OvsTag] <Int32>] [[-Slaves] <String>] [-Type] <String> [[-VlanId] <Int32>] [[-VlanRawDevice] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| IP address. | false | true (ByPropertyName) | |||
| IP address. | false | true (ByPropertyName) | |||
| Automatically start interface on boot. | false | true (ByPropertyName) | False | ||
| Specify the primary interface for active-backup bond. | false | true (ByPropertyName) | |||
| Bonding mode. Enum: balance-rr,active-backup,balance-xor,broadcast,802.3ad,balance-tlb,balance-alb,balance-slb,lacp-balance-slb,lacp-balance-tcp | false | true (ByPropertyName) | |||
| Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. Enum: layer2,layer2+3,layer3+4 | false | true (ByPropertyName) | |||
| Specify the interfaces you want to add to your bridge. | false | true (ByPropertyName) | |||
| Enable bridge vlan support. | false | true (ByPropertyName) | False | ||
| IPv4 CIDR. | false | true (ByPropertyName) | |||
| IPv6 CIDR. | false | true (ByPropertyName) | |||
| Comments | false | true (ByPropertyName) | |||
| Comments | false | true (ByPropertyName) | |||
| Default gateway address. | false | true (ByPropertyName) | |||
| Default ipv6 gateway address. | false | true (ByPropertyName) | |||
| Network interface name. | true | true (ByPropertyName) | |||
| MTU. | false | true (ByPropertyName) | 0 | ||
| Network mask. | false | true (ByPropertyName) | |||
| Network mask. | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Specify the interfaces used by the bonding device. | false | true (ByPropertyName) | |||
| The OVS bridge associated with a OVS port. This is required when you create an OVS port. | false | true (ByPropertyName) | |||
| OVS interface options. | false | true (ByPropertyName) | |||
| Specify the interfaces you want to add to your bridge. | false | true (ByPropertyName) | |||
| Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond) | false | true (ByPropertyName) | 0 | ||
| Specify the interfaces used by the bonding device. | false | true (ByPropertyName) | |||
| Network interface type Enum: bridge,bond,eth,alias,vlan,OVSBridge,OVSBond,OVSPort,OVSIntPort,unknown | true | true (ByPropertyName) | |||
| vlan-id for a custom named vlan interface (ifupdown2 only). | false | true (ByPropertyName) | 0 | ||
| Specify the raw interface for the vlan interface. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemu
Create or restore a virtual machine.
Aliases
- New-PveQemu
Syntax
New-PveNodesQemu [[-PveTicket] <PveTicket>] [-Acpi] [[-Affinity] <String>] [[-Agent] <String>] [[-Arch] <String>] [[-Archive] <String>] [[-Args_] <String>] [[-Audio0] <String>] [-Autostart] [[-Balloon] <Int32>] [[-Bios] <String>] [[-Boot] <String>] [[-Bootdisk] <String>] [[-Bwlimit] <Int32>] [[-Cdrom] <String>] [[-Cicustom] <String>] [[-Cipassword] <SecureString>] [[-Citype] <String>] [-Ciupgrade] [[-Ciuser] <String>] [[-Cores] <Int32>] [[-Cpu] <String>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [[-Description] <String>] [[-Efidisk0] <String>] [-Force] [-Freeze] [[-Hookscript] <String>] [[-HostpciN] <Hashtable>] [[-Hotplug] <String>] [[-Hugepages] <String>] [[-IdeN] <Hashtable>] [[-IpconfigN] <Hashtable>] [[-Ivshmem] <String>] [-Keephugepages] [[-Keyboard] <String>] [-Kvm] [-LiveRestore] [-Localtime] [[-Lock] <String>] [[-Machine] <String>] [[-Memory] <String>] [[-MigrateDowntime] <Single>] [[-MigrateSpeed] <Int32>] [[-Name] <String>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Numa] [[-NumaN] <Hashtable>] [-Onboot] [[-Ostype] <String>] [[-ParallelN] <Hashtable>] [[-Pool] <String>] [-Protection] [-Reboot] [[-Rng0] <String>] [[-SataN] <Hashtable>] [[-ScsiN] <Hashtable>] [[-Scsihw] <String>] [[-Searchdomain] <String>] [[-SerialN] <Hashtable>] [[-Shares] <Int32>] [[-Smbios1] <String>] [[-Smp] <Int32>] [[-Sockets] <Int32>] [[-SpiceEnhancements] <String>] [[-Sshkeys] <String>] [-Start] [[-Startdate] <String>] [[-Startup] <String>] [[-Storage] <String>] [-Tablet] [[-Tags] <String>] [-Tdf] [-Template] [[-Tpmstate0] <String>] [-Unique] [[-UnusedN] <Hashtable>] [[-UsbN] <Hashtable>] [[-Vcpus] <Int32>] [[-Vga] <String>] [[-VirtioN] <Hashtable>] [[-Vmgenid] <String>] [-Vmid] <Int32> [[-Vmstatestorage] <String>] [[-Watchdog] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Enable/disable ACPI. | false | true (ByPropertyName) | False | ||
| List of host cores used to execute guest processes, for example':' 0,5,8-11 | false | true (ByPropertyName) | |||
| Enable/disable communication with the QEMU Guest Agent and its properties. | false | true (ByPropertyName) | |||
| Virtual processor architecture. Defaults to the host. Enum: x86_64,aarch64 | false | true (ByPropertyName) | |||
| The backup archive. Either the file system path to a .tar or .vma file (use '-' to pipe data from stdin) or a proxmox storage backup volume identifier. | false | true (ByPropertyName) | |||
| Arbitrary arguments passed to kvm. | false | true (ByPropertyName) | |||
| Configure a audio device, useful in combination with QXL/Spice. | false | true (ByPropertyName) | |||
| Automatic restart after crash (currently ignored). | false | true (ByPropertyName) | False | ||
| Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. | false | true (ByPropertyName) | 0 | ||
| Select BIOS implementation. Enum: seabios,ovmf | false | true (ByPropertyName) | |||
| Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. | false | true (ByPropertyName) | |||
| Enable booting from specified disk. Deprecated':' Use 'boot':' order=foo;bar' instead. | false | true (ByPropertyName) | |||
| Override I/O bandwidth limit (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| This is an alias for option -ide2 | false | true (ByPropertyName) | |||
| cloud-init':' Specify custom files to replace the automatically generated ones at start. | false | true (ByPropertyName) | |||
| cloud-init':' Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. | false | true (ByPropertyName) | |||
| Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. Enum: configdrive2,nocloud,opennebula | false | true (ByPropertyName) | |||
| cloud-init':' do an automatic package upgrade after the first boot. | false | true (ByPropertyName) | False | ||
| cloud-init':' User name to change ssh keys and password for instead of the image's configured default user. | false | true (ByPropertyName) | |||
| The number of cores per socket. | false | true (ByPropertyName) | 0 | ||
| Emulated CPU type. | false | true (ByPropertyName) | |||
| Limit of CPU usage. | false | true (ByPropertyName) | 0 | ||
| CPU weight for a VM, will be clamped to \[1, 10000] in cgroup v2. | false | true (ByPropertyName) | 0 | ||
| Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. | false | true (ByPropertyName) | |||
| Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| Allow to overwrite existing VM. | false | true (ByPropertyName) | False | ||
| Freeze CPU at startup (use 'c' monitor command to start execution). | false | true (ByPropertyName) | False | ||
| Script that will be executed during various steps in the vms lifetime. | false | true (ByPropertyName) | |||
| Map host PCI devices into guest. | false | true (ByPropertyName) | |||
| Selectively enable hotplug features. This is a comma separated list of hotplug features':' 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7. | false | true (ByPropertyName) | |||
| Enable/disable hugepages memory. Enum: any,2,1024 | false | true (ByPropertyName) | |||
| Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| cloud-init':' Specify IP addresses and gateways for the corresponding interface.IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicitgateway should be provided.For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requirescloud-init 19.4 or newer.If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to usingdhcp on IPv4. | false | true (ByPropertyName) | |||
| Inter-VM shared memory. Useful for direct communication between VMs, or to the host. | false | true (ByPropertyName) | |||
| Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. | false | true (ByPropertyName) | False | ||
| Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. Enum: de,de-ch,da,en-gb,en-us,es,fi,fr,fr-be,fr-ca,fr-ch,hu,is,it,ja,lt,mk,nl,no,pl,pt,pt-br,sv,sl,tr | false | true (ByPropertyName) | |||
| Enable/disable KVM hardware virtualization. | false | true (ByPropertyName) | False | ||
| Start the VM immediately while importing or restoring in the background. | false | true (ByPropertyName) | False | ||
| Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. | false | true (ByPropertyName) | False | ||
| Lock/unlock the VM. Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspended | false | true (ByPropertyName) | |||
| Specify the QEMU machine. | false | true (ByPropertyName) | |||
| Memory properties. | false | true (ByPropertyName) | |||
| Set maximum tolerated downtime (in seconds) for migrations. | false | true (ByPropertyName) | 0 | ||
| Set maximum speed (in MB/s) for migrations. Value 0 is no limit. | false | true (ByPropertyName) | 0 | ||
| Set a name for the VM. Only used on the configuration web interface. | false | true (ByPropertyName) | |||
| cloud-init':' Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. | false | true (ByPropertyName) | |||
| Specify network devices. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Enable/disable NUMA. | false | true (ByPropertyName) | False | ||
| NUMA topology. | false | true (ByPropertyName) | |||
| Specifies whether a VM will be started during system bootup. | false | true (ByPropertyName) | False | ||
| Specify guest operating system. Enum: other,wxp,w2k,w2k3,w2k8,wvista,win7,win8,win10,win11,l24,l26,solaris | false | true (ByPropertyName) | |||
| Map host parallel devices (n is 0 to 2). | false | true (ByPropertyName) | |||
| Add the VM to the specified pool. | false | true (ByPropertyName) | |||
| Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. | false | true (ByPropertyName) | False | ||
| Allow reboot. If set to '0' the VM exit on reboot. | false | true (ByPropertyName) | False | ||
| Configure a VirtIO-based Random Number Generator. | false | true (ByPropertyName) | |||
| Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| SCSI controller model Enum: lsi,lsi53c810,virtio-scsi-pci,virtio-scsi-single,megasas,pvscsi | false | true (ByPropertyName) | |||
| cloud-init':' Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. | false | true (ByPropertyName) | |||
| Create a serial device inside the VM (n is 0 to 3) | false | true (ByPropertyName) | |||
| Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. | false | true (ByPropertyName) | 0 | ||
| Specify SMBIOS type 1 fields. | false | true (ByPropertyName) | |||
| The number of CPUs. Please use option -sockets instead. | false | true (ByPropertyName) | 0 | ||
| The number of CPU sockets. | false | true (ByPropertyName) | 0 | ||
| Configure additional enhancements for SPICE. | false | true (ByPropertyName) | |||
| cloud-init':' Setup public SSH keys (one key per line, OpenSSH format). | false | true (ByPropertyName) | |||
| Start VM after it was created successfully. | false | true (ByPropertyName) | False | ||
| Set the initial date of the real time clock. Valid format for date are':''now' or '2006-06-17T16':'01':'21' or '2006-06-17'. | false | true (ByPropertyName) | |||
| Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. | false | true (ByPropertyName) | |||
| Default storage. | false | true (ByPropertyName) | |||
| Enable/disable the USB tablet device. | false | true (ByPropertyName) | False | ||
| Tags of the VM. This is only meta information. | false | true (ByPropertyName) | |||
| Enable/disable time drift fix. | false | true (ByPropertyName) | False | ||
| Enable/disable Template. | false | true (ByPropertyName) | False | ||
| Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| Assign a unique random ethernet address. | false | true (ByPropertyName) | False | ||
| Reference to unused volumes. This is used internally, and should not be modified manually. | false | true (ByPropertyName) | |||
| Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). | false | true (ByPropertyName) | |||
| Number of hotplugged vcpus. | false | true (ByPropertyName) | 0 | ||
| Configure the VGA hardware. | false | true (ByPropertyName) | |||
| Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 | ||
| Default storage for VM state volumes/files. | false | true (ByPropertyName) | |||
| Create a virtual hardware watchdog device. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuAgent
Execute QEMU Guest Agent commands.
Syntax
New-PveNodesQemuAgent [[-PveTicket] <PveTicket>] [-Command] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The QGA command. Enum: fsfreeze-freeze,fsfreeze-status,fsfreeze-thaw,fstrim,get-fsinfo,get-host-name,get-memory-block-info,get-memory-blocks,get-osinfo,get-time,get-timezone,get-users,get-vcpus,info,network-get-interfaces,ping,shutdown,suspend-disk,suspend-hybrid,suspend-ram | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuAgentExec
Executes the given command in the vm via the guest-agent and returns an object with the pid.
Syntax
New-PveNodesQemuAgentExec [[-PveTicket] <PveTicket>] [-Command] <Array> [[-InputData] <String>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The command as a list of program + arguments. | true | true (ByPropertyName) | |||
| Data to pass as 'input-data' to the guest. Usually treated as STDIN to 'command'. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuAgentFileWrite
Writes the given file via guest agent.
Syntax
New-PveNodesQemuAgentFileWrite [[-PveTicket] <PveTicket>] [-Content] <String> [-Encode] [-File] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The content to write into the file. | true | true (ByPropertyName) | |||
| If set, the content will be encoded as base64 (required by QEMU).Otherwise the content needs to be encoded beforehand - defaults to true. | false | true (ByPropertyName) | False | ||
| The path to the file. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuAgentFsfreezeFreeze
Execute fsfreeze-freeze.
Syntax
New-PveNodesQemuAgentFsfreezeFreeze [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuAgentFsfreezeStatus
Execute fsfreeze-status.
Syntax
New-PveNodesQemuAgentFsfreezeStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuAgentFsfreezeThaw
Execute fsfreeze-thaw.
Syntax
New-PveNodesQemuAgentFsfreezeThaw [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuAgentFstrim
Execute fstrim.
Syntax
New-PveNodesQemuAgentFstrim [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuAgentPing
Execute ping.
Syntax
New-PveNodesQemuAgentPing [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuAgentSetUserPassword
Sets the password for the given user to the given password
Syntax
New-PveNodesQemuAgentSetUserPassword [[-PveTicket] <PveTicket>] [-Crypted] [-Node] <String> [-Password] <SecureString> [-Username] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| set to 1 if the password has already been passed through crypt() | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| The new password. | true | true (ByPropertyName) | |||
| The user to set the password for. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuAgentShutdown
Execute shutdown.
Syntax
New-PveNodesQemuAgentShutdown [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuAgentSuspendDisk
Execute suspend-disk.
Syntax
New-PveNodesQemuAgentSuspendDisk [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuAgentSuspendHybrid
Execute suspend-hybrid.
Syntax
New-PveNodesQemuAgentSuspendHybrid [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuAgentSuspendRam
Execute suspend-ram.
Syntax
New-PveNodesQemuAgentSuspendRam [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuClone
Create a copy of virtual machine/template.
Aliases
- Copy-PveQemu
Syntax
New-PveNodesQemuClone [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [[-Description] <String>] [[-Format] <String>] [-Full] [[-Name] <String>] [-Newid] <Int32> [-Node] <String> [[-Pool] <String>] [[-Snapname] <String>] [[-Storage] <String>] [[-Target] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Override I/O bandwidth limit (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| Description for the new VM. | false | true (ByPropertyName) | |||
| Target format for file storage. Only valid for full clone. Enum: raw,qcow2,vmdk | false | true (ByPropertyName) | |||
| Create a full copy of all disks. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default. | false | true (ByPropertyName) | False | ||
| Set a name for the new VM. | false | true (ByPropertyName) | |||
| VMID for the clone. | true | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Add the new VM to the specified pool. | false | true (ByPropertyName) | |||
| The name of the snapshot. | false | true (ByPropertyName) | |||
| Target storage for full clone. | false | true (ByPropertyName) | |||
| Target node. Only allowed if the original VM is on shared storage. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuConfig
Set virtual machine options (asynchrounous API).
Syntax
New-PveNodesQemuConfig [[-PveTicket] <PveTicket>] [-Acpi] [[-Affinity] <String>] [[-Agent] <String>] [[-Arch] <String>] [[-Args_] <String>] [[-Audio0] <String>] [-Autostart] [[-BackgroundDelay] <Int32>] [[-Balloon] <Int32>] [[-Bios] <String>] [[-Boot] <String>] [[-Bootdisk] <String>] [[-Cdrom] <String>] [[-Cicustom] <String>] [[-Cipassword] <SecureString>] [[-Citype] <String>] [-Ciupgrade] [[-Ciuser] <String>] [[-Cores] <Int32>] [[-Cpu] <String>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [[-Efidisk0] <String>] [-Force] [-Freeze] [[-Hookscript] <String>] [[-HostpciN] <Hashtable>] [[-Hotplug] <String>] [[-Hugepages] <String>] [[-IdeN] <Hashtable>] [[-IpconfigN] <Hashtable>] [[-Ivshmem] <String>] [-Keephugepages] [[-Keyboard] <String>] [-Kvm] [-Localtime] [[-Lock] <String>] [[-Machine] <String>] [[-Memory] <String>] [[-MigrateDowntime] <Single>] [[-MigrateSpeed] <Int32>] [[-Name] <String>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Numa] [[-NumaN] <Hashtable>] [-Onboot] [[-Ostype] <String>] [[-ParallelN] <Hashtable>] [-Protection] [-Reboot] [[-Revert] <String>] [[-Rng0] <String>] [[-SataN] <Hashtable>] [[-ScsiN] <Hashtable>] [[-Scsihw] <String>] [[-Searchdomain] <String>] [[-SerialN] <Hashtable>] [[-Shares] <Int32>] [-Skiplock] [[-Smbios1] <String>] [[-Smp] <Int32>] [[-Sockets] <Int32>] [[-SpiceEnhancements] <String>] [[-Sshkeys] <String>] [[-Startdate] <String>] [[-Startup] <String>] [-Tablet] [[-Tags] <String>] [-Tdf] [-Template] [[-Tpmstate0] <String>] [[-UnusedN] <Hashtable>] [[-UsbN] <Hashtable>] [[-Vcpus] <Int32>] [[-Vga] <String>] [[-VirtioN] <Hashtable>] [[-Vmgenid] <String>] [-Vmid] <Int32> [[-Vmstatestorage] <String>] [[-Watchdog] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Enable/disable ACPI. | false | true (ByPropertyName) | False | ||
| List of host cores used to execute guest processes, for example':' 0,5,8-11 | false | true (ByPropertyName) | |||
| Enable/disable communication with the QEMU Guest Agent and its properties. | false | true (ByPropertyName) | |||
| Virtual processor architecture. Defaults to the host. Enum: x86_64,aarch64 | false | true (ByPropertyName) | |||
| Arbitrary arguments passed to kvm. | false | true (ByPropertyName) | |||
| Configure a audio device, useful in combination with QXL/Spice. | false | true (ByPropertyName) | |||
| Automatic restart after crash (currently ignored). | false | true (ByPropertyName) | False | ||
| Time to wait for the task to finish. We return 'null' if the task finish within that time. | false | true (ByPropertyName) | 0 | ||
| Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. | false | true (ByPropertyName) | 0 | ||
| Select BIOS implementation. Enum: seabios,ovmf | false | true (ByPropertyName) | |||
| Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. | false | true (ByPropertyName) | |||
| Enable booting from specified disk. Deprecated':' Use 'boot':' order=foo;bar' instead. | false | true (ByPropertyName) | |||
| This is an alias for option -ide2 | false | true (ByPropertyName) | |||
| cloud-init':' Specify custom files to replace the automatically generated ones at start. | false | true (ByPropertyName) | |||
| cloud-init':' Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. | false | true (ByPropertyName) | |||
| Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. Enum: configdrive2,nocloud,opennebula | false | true (ByPropertyName) | |||
| cloud-init':' do an automatic package upgrade after the first boot. | false | true (ByPropertyName) | False | ||
| cloud-init':' User name to change ssh keys and password for instead of the image's configured default user. | false | true (ByPropertyName) | |||
| The number of cores per socket. | false | true (ByPropertyName) | 0 | ||
| Emulated CPU type. | false | true (ByPropertyName) | |||
| Limit of CPU usage. | false | true (ByPropertyName) | 0 | ||
| CPU weight for a VM, will be clamped to \[1, 10000] in cgroup v2. | false | true (ByPropertyName) | 0 | ||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused\[n]', which contains the volume ID. Unlink of unused\[n] always cause physical removal. | false | true (ByPropertyName) | False | ||
| Freeze CPU at startup (use 'c' monitor command to start execution). | false | true (ByPropertyName) | False | ||
| Script that will be executed during various steps in the vms lifetime. | false | true (ByPropertyName) | |||
| Map host PCI devices into guest. | false | true (ByPropertyName) | |||
| Selectively enable hotplug features. This is a comma separated list of hotplug features':' 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7. | false | true (ByPropertyName) | |||
| Enable/disable hugepages memory. Enum: any,2,1024 | false | true (ByPropertyName) | |||
| Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| cloud-init':' Specify IP addresses and gateways for the corresponding interface.IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicitgateway should be provided.For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requirescloud-init 19.4 or newer.If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to usingdhcp on IPv4. | false | true (ByPropertyName) | |||
| Inter-VM shared memory. Useful for direct communication between VMs, or to the host. | false | true (ByPropertyName) | |||
| Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. | false | true (ByPropertyName) | False | ||
| Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. Enum: de,de-ch,da,en-gb,en-us,es,fi,fr,fr-be,fr-ca,fr-ch,hu,is,it,ja,lt,mk,nl,no,pl,pt,pt-br,sv,sl,tr | false | true (ByPropertyName) | |||
| Enable/disable KVM hardware virtualization. | false | true (ByPropertyName) | False | ||
| Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. | false | true (ByPropertyName) | False | ||
| Lock/unlock the VM. Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspended | false | true (ByPropertyName) | |||
| Specify the QEMU machine. | false | true (ByPropertyName) | |||
| Memory properties. | false | true (ByPropertyName) | |||
| Set maximum tolerated downtime (in seconds) for migrations. | false | true (ByPropertyName) | 0 | ||
| Set maximum speed (in MB/s) for migrations. Value 0 is no limit. | false | true (ByPropertyName) | 0 | ||
| Set a name for the VM. Only used on the configuration web interface. | false | true (ByPropertyName) | |||
| cloud-init':' Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. | false | true (ByPropertyName) | |||
| Specify network devices. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Enable/disable NUMA. | false | true (ByPropertyName) | False | ||
| NUMA topology. | false | true (ByPropertyName) | |||
| Specifies whether a VM will be started during system bootup. | false | true (ByPropertyName) | False | ||
| Specify guest operating system. Enum: other,wxp,w2k,w2k3,w2k8,wvista,win7,win8,win10,win11,l24,l26,solaris | false | true (ByPropertyName) | |||
| Map host parallel devices (n is 0 to 2). | false | true (ByPropertyName) | |||
| Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. | false | true (ByPropertyName) | False | ||
| Allow reboot. If set to '0' the VM exit on reboot. | false | true (ByPropertyName) | False | ||
| Revert a pending change. | false | true (ByPropertyName) | |||
| Configure a VirtIO-based Random Number Generator. | false | true (ByPropertyName) | |||
| Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| SCSI controller model Enum: lsi,lsi53c810,virtio-scsi-pci,virtio-scsi-single,megasas,pvscsi | false | true (ByPropertyName) | |||
| cloud-init':' Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. | false | true (ByPropertyName) | |||
| Create a serial device inside the VM (n is 0 to 3) | false | true (ByPropertyName) | |||
| Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. | false | true (ByPropertyName) | 0 | ||
| Ignore locks - only root is allowed to use this option. | false | true (ByPropertyName) | False | ||
| Specify SMBIOS type 1 fields. | false | true (ByPropertyName) | |||
| The number of CPUs. Please use option -sockets instead. | false | true (ByPropertyName) | 0 | ||
| The number of CPU sockets. | false | true (ByPropertyName) | 0 | ||
| Configure additional enhancements for SPICE. | false | true (ByPropertyName) | |||
| cloud-init':' Setup public SSH keys (one key per line, OpenSSH format). | false | true (ByPropertyName) | |||
| Set the initial date of the real time clock. Valid format for date are':''now' or '2006-06-17T16':'01':'21' or '2006-06-17'. | false | true (ByPropertyName) | |||
| Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. | false | true (ByPropertyName) | |||
| Enable/disable the USB tablet device. | false | true (ByPropertyName) | False | ||
| Tags of the VM. This is only meta information. | false | true (ByPropertyName) | |||
| Enable/disable time drift fix. | false | true (ByPropertyName) | False | ||
| Enable/disable Template. | false | true (ByPropertyName) | False | ||
| Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| Reference to unused volumes. This is used internally, and should not be modified manually. | false | true (ByPropertyName) | |||
| Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). | false | true (ByPropertyName) | |||
| Number of hotplugged vcpus. | false | true (ByPropertyName) | 0 | ||
| Configure the VGA hardware. | false | true (ByPropertyName) | |||
| Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 | ||
| Default storage for VM state volumes/files. | false | true (ByPropertyName) | |||
| Create a virtual hardware watchdog device. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuFirewallAliases
Create IP or Network Alias.
Syntax
New-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Alias name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuFirewallIpset
Create new IPSet
Syntax
New-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| 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) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuFirewallIpsetIdx
Add IP or Network to IPSet.
Syntax
New-PveNodesQemuFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | False | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuFirewallRules
Create new rule.
Syntax
New-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [-Action] <String> [[-Comment] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [-Type] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. | true | true (ByPropertyName) | |||
| Descriptive comment. | false | true (ByPropertyName) | |||
| 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) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| 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) | |||
| Flag to enable/disable a rule. | false | true (ByPropertyName) | 0 | ||
| Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. | false | true (ByPropertyName) | |||
| 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 level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Use predefined standard macro. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 | ||
| IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. | false | true (ByPropertyName) | |||
| 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) | |||
| 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) | |||
| Rule type. Enum: in,out,group | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuMigrate
Migrate virtual machine. Creates a new migration task.
Aliases
- Move-PveQemu
Syntax
New-PveNodesQemuMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [-Force] [[-MigrationNetwork] <String>] [[-MigrationType] <String>] [-Node] <String> [-Online] [-Target] <String> [[-Targetstorage] <String>] [-Vmid] <Int32> [-WithLocalDisks] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Override I/O bandwidth limit (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| Allow to migrate VMs which use local devices. Only root may use this option. | false | true (ByPropertyName) | False | ||
| CIDR of the (sub) network that is used for migration. | false | true (ByPropertyName) | |||
| Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. Enum: secure,insecure | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Use online/live migration if VM is running. Ignored if VM is stopped. | false | true (ByPropertyName) | False | ||
| Target node. | true | true (ByPropertyName) | |||
| Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 | ||
| Enable live storage migration for local disk | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuMonitor
Execute QEMU monitor commands.
Syntax
New-PveNodesQemuMonitor [[-PveTicket] <PveTicket>] [-Command] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The monitor command. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuMoveDisk
Move volume to different storage or to a different VM.
Syntax
New-PveNodesQemuMoveDisk [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [-Delete] [[-Digest] <String>] [-Disk] <String> [[-Format] <String>] [-Node] <String> [[-Storage] <String>] [[-TargetDigest] <String>] [[-TargetDisk] <String>] [[-TargetVmid] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Override I/O bandwidth limit (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| Delete the original disk after successful copy. By default the original disk is kept as unused disk. | false | true (ByPropertyName) | False | ||
| Prevent changes if current configuration file has different SHA1" ." digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| The disk you want to move. Enum: ide0,ide1,ide2,ide3,scsi0,scsi1,scsi2,scsi3,scsi4,scsi5,scsi6,scsi7,scsi8,scsi9,scsi10,scsi11,scsi12,scsi13,scsi14,scsi15,scsi16,scsi17,scsi18,scsi19,scsi20,scsi21,scsi22,scsi23,scsi24,scsi25,scsi26,scsi27,scsi28,scsi29,scsi30,virtio0,virtio1,virtio2,virtio3,virtio4,virtio5,virtio6,virtio7,virtio8,virtio9,virtio10,virtio11,virtio12,virtio13,virtio14,virtio15,sata0,sata1,sata2,sata3,sata4,sata5,efidisk0,tpmstate0,unused0,unused1,unused2,unused3,unused4,unused5,unused6,unused7,unused8,unused9,unused10,unused11,unused12,unused13,unused14,unused15,unused16,unused17,unused18,unused19,unused20,unused21,unused22,unused23,unused24,unused25,unused26,unused27,unused28,unused29,unused30,unused31,unused32,unused33,unused34,unused35,unused36,unused37,unused38,unused39,unused40,unused41,unused42,unused43,unused44,unused45,unused46,unused47,unused48,unused49,unused50,unused51,unused52,unused53,unused54,unused55,unused56,unused57,unused58,unused59,unused60,unused61,unused62,unused63,unused64,unused65,unused66,unused67,unused68,unused69,unused70,unused71,unused72,unused73,unused74,unused75,unused76,unused77,unused78,unused79,unused80,unused81,unused82,unused83,unused84,unused85,unused86,unused87,unused88,unused89,unused90,unused91,unused92,unused93,unused94,unused95,unused96,unused97,unused98,unused99,unused100,unused101,unused102,unused103,unused104,unused105,unused106,unused107,unused108,unused109,unused110,unused111,unused112,unused113,unused114,unused115,unused116,unused117,unused118,unused119,unused120,unused121,unused122,unused123,unused124,unused125,unused126,unused127,unused128,unused129,unused130,unused131,unused132,unused133,unused134,unused135,unused136,unused137,unused138,unused139,unused140,unused141,unused142,unused143,unused144,unused145,unused146,unused147,unused148,unused149,unused150,unused151,unused152,unused153,unused154,unused155,unused156,unused157,unused158,unused159,unused160,unused161,unused162,unused163,unused164,unused165,unused166,unused167,unused168,unused169,unused170,unused171,unused172,unused173,unused174,unused175,unused176,unused177,unused178,unused179,unused180,unused181,unused182,unused183,unused184,unused185,unused186,unused187,unused188,unused189,unused190,unused191,unused192,unused193,unused194,unused195,unused196,unused197,unused198,unused199,unused200,unused201,unused202,unused203,unused204,unused205,unused206,unused207,unused208,unused209,unused210,unused211,unused212,unused213,unused214,unused215,unused216,unused217,unused218,unused219,unused220,unused221,unused222,unused223,unused224,unused225,unused226,unused227,unused228,unused229,unused230,unused231,unused232,unused233,unused234,unused235,unused236,unused237,unused238,unused239,unused240,unused241,unused242,unused243,unused244,unused245,unused246,unused247,unused248,unused249,unused250,unused251,unused252,unused253,unused254,unused255 | true | true (ByPropertyName) | |||
| Target Format. Enum: raw,qcow2,vmdk | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Target storage. | false | true (ByPropertyName) | |||
| Prevent changes if the current config file of the target VM has a" ." different SHA1 digest. This can be used to detect concurrent modifications. | false | true (ByPropertyName) | |||
| The config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key. Enum: ide0,ide1,ide2,ide3,scsi0,scsi1,scsi2,scsi3,scsi4,scsi5,scsi6,scsi7,scsi8,scsi9,scsi10,scsi11,scsi12,scsi13,scsi14,scsi15,scsi16,scsi17,scsi18,scsi19,scsi20,scsi21,scsi22,scsi23,scsi24,scsi25,scsi26,scsi27,scsi28,scsi29,scsi30,virtio0,virtio1,virtio2,virtio3,virtio4,virtio5,virtio6,virtio7,virtio8,virtio9,virtio10,virtio11,virtio12,virtio13,virtio14,virtio15,sata0,sata1,sata2,sata3,sata4,sata5,efidisk0,tpmstate0,unused0,unused1,unused2,unused3,unused4,unused5,unused6,unused7,unused8,unused9,unused10,unused11,unused12,unused13,unused14,unused15,unused16,unused17,unused18,unused19,unused20,unused21,unused22,unused23,unused24,unused25,unused26,unused27,unused28,unused29,unused30,unused31,unused32,unused33,unused34,unused35,unused36,unused37,unused38,unused39,unused40,unused41,unused42,unused43,unused44,unused45,unused46,unused47,unused48,unused49,unused50,unused51,unused52,unused53,unused54,unused55,unused56,unused57,unused58,unused59,unused60,unused61,unused62,unused63,unused64,unused65,unused66,unused67,unused68,unused69,unused70,unused71,unused72,unused73,unused74,unused75,unused76,unused77,unused78,unused79,unused80,unused81,unused82,unused83,unused84,unused85,unused86,unused87,unused88,unused89,unused90,unused91,unused92,unused93,unused94,unused95,unused96,unused97,unused98,unused99,unused100,unused101,unused102,unused103,unused104,unused105,unused106,unused107,unused108,unused109,unused110,unused111,unused112,unused113,unused114,unused115,unused116,unused117,unused118,unused119,unused120,unused121,unused122,unused123,unused124,unused125,unused126,unused127,unused128,unused129,unused130,unused131,unused132,unused133,unused134,unused135,unused136,unused137,unused138,unused139,unused140,unused141,unused142,unused143,unused144,unused145,unused146,unused147,unused148,unused149,unused150,unused151,unused152,unused153,unused154,unused155,unused156,unused157,unused158,unused159,unused160,unused161,unused162,unused163,unused164,unused165,unused166,unused167,unused168,unused169,unused170,unused171,unused172,unused173,unused174,unused175,unused176,unused177,unused178,unused179,unused180,unused181,unused182,unused183,unused184,unused185,unused186,unused187,unused188,unused189,unused190,unused191,unused192,unused193,unused194,unused195,unused196,unused197,unused198,unused199,unused200,unused201,unused202,unused203,unused204,unused205,unused206,unused207,unused208,unused209,unused210,unused211,unused212,unused213,unused214,unused215,unused216,unused217,unused218,unused219,unused220,unused221,unused222,unused223,unused224,unused225,unused226,unused227,unused228,unused229,unused230,unused231,unused232,unused233,unused234,unused235,unused236,unused237,unused238,unused239,unused240,unused241,unused242,unused243,unused244,unused245,unused246,unused247,unused248,unused249,unused250,unused251,unused252,unused253,unused254,unused255 | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuMtunnel
Migration tunnel endpoint - only for internal use by VM migration.
Syntax
New-PveNodesQemuMtunnel [[-PveTicket] <PveTicket>] [[-Bridges] <String>] [-Node] <String> [[-Storages] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| List of network bridges to check availability. Will be checked again for actually used bridges during migration. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| List of storages to check permission and availability. Will be checked again for all actually used storages during migration. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuRemoteMigrate
Migrate virtual machine to a remote cluster. Creates a new migration task. EXPERIMENTAL feature!
Syntax
New-PveNodesQemuRemoteMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [-Delete] [-Node] <String> [-Online] [-TargetBridge] <String> [-TargetEndpoint] <String> [-TargetStorage] <String> [[-TargetVmid] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Override I/O bandwidth limit (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| Delete the original VM and related data after successful migration. By default the original VM is kept on the source cluster in a stopped state. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Use online/live migration if VM is running. Ignored if VM is stopped. | false | true (ByPropertyName) | False | ||
| Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself. | true | true (ByPropertyName) | |||
| Remote target endpoint | true | true (ByPropertyName) | |||
| Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuSnapshot
Snapshot a VM.
Syntax
New-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [-Vmstate] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A textual description or comment. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 | ||
| Save the vmstate | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuSnapshotRollback
Rollback VM state to specified snapshot.
Syntax
New-PveNodesQemuSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| Whether the VM should get started after rolling back successfully. (Note':' VMs will be automatically started if the snapshot includes RAM.) | false | true (ByPropertyName) | False | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuSpiceproxy
Returns a SPICE configuration to connect to the VM.
Syntax
New-PveNodesQemuSpiceproxy [[-PveTicket] <PveTicket>] [-Node] <String> [[-Proxy] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI). | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuStatusReboot
Reboot the VM by shutting it down, and starting it again. Applies pending changes.
Aliases
- Restart-PveQemu
Syntax
New-PveNodesQemuStatusReboot [[-PveTicket] <PveTicket>] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Wait maximal timeout seconds for the shutdown. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuStatusReset
Reset virtual machine.
Aliases
- Reset-PveQemu
Syntax
New-PveNodesQemuStatusReset [[-PveTicket] <PveTicket>] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Ignore locks - only root is allowed to use this option. | false | true (ByPropertyName) | False | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuStatusResume
Resume virtual machine.
Aliases
- Resume-PveQemu
Syntax
New-PveNodesQemuStatusResume [[-PveTicket] <PveTicket>] [-Nocheck] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Ignore locks - only root is allowed to use this option. | false | true (ByPropertyName) | False | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuStatusShutdown
Shutdown virtual machine. This is similar to pressing the power button on a physical machine. This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown.
Syntax
New-PveNodesQemuStatusShutdown [[-PveTicket] <PveTicket>] [-Forcestop] [-Keepactive] [-Node] <String> [-Skiplock] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Make sure the VM stops. | false | true (ByPropertyName) | False | ||
| Do not deactivate storage volumes. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Ignore locks - only root is allowed to use this option. | false | true (ByPropertyName) | False | ||
| Wait maximal timeout seconds. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuStatusStart
Start virtual machine.
Aliases
- Start-PveQemu
Syntax
New-PveNodesQemuStatusStart [[-PveTicket] <PveTicket>] [[-ForceCpu] <String>] [[-Machine] <String>] [[-Migratedfrom] <String>] [[-MigrationNetwork] <String>] [[-MigrationType] <String>] [-Node] <String> [-Skiplock] [[-Stateuri] <String>] [[-Targetstorage] <String>] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Override QEMU's -cpu argument with the given string. | false | true (ByPropertyName) | |||
| Specify the QEMU machine. | false | true (ByPropertyName) | |||
| The cluster node name. | false | true (ByPropertyName) | |||
| CIDR of the (sub) network that is used for migration. | false | true (ByPropertyName) | |||
| Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. Enum: secure,insecure | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Ignore locks - only root is allowed to use this option. | false | true (ByPropertyName) | False | ||
| Some command save/restore state from this location. | false | true (ByPropertyName) | |||
| Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. | false | true (ByPropertyName) | |||
| Wait maximal timeout seconds. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuStatusStop
Stop virtual machine. The qemu process will exit immediately. This is akin to pulling the power plug of a running computer and may damage the VM data.
Syntax
New-PveNodesQemuStatusStop [[-PveTicket] <PveTicket>] [-Keepactive] [[-Migratedfrom] <String>] [-Node] <String> [-OverruleShutdown] [-Skiplock] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Do not deactivate storage volumes. | false | true (ByPropertyName) | False | ||
| The cluster node name. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Try to abort active 'qmshutdown' tasks before stopping. | false | true (ByPropertyName) | False | ||
| Ignore locks - only root is allowed to use this option. | false | true (ByPropertyName) | False | ||
| Wait maximal timeout seconds. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuStatusSuspend
Suspend virtual machine.
Aliases
- Suspend-PveQemu
Syntax
New-PveNodesQemuStatusSuspend [[-PveTicket] <PveTicket>] [-Node] <String> [-Skiplock] [[-Statestorage] <String>] [-Todisk] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Ignore locks - only root is allowed to use this option. | false | true (ByPropertyName) | False | ||
| The storage for the VM state | false | true (ByPropertyName) | |||
| If set, suspends the VM to disk. Will be resumed on next VM start. | false | true (ByPropertyName) | False | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuTemplate
Create a Template.
Syntax
New-PveNodesQemuTemplate [[-PveTicket] <PveTicket>] [[-Disk] <String>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| If you want to convert only 1 disk to base image. Enum: ide0,ide1,ide2,ide3,scsi0,scsi1,scsi2,scsi3,scsi4,scsi5,scsi6,scsi7,scsi8,scsi9,scsi10,scsi11,scsi12,scsi13,scsi14,scsi15,scsi16,scsi17,scsi18,scsi19,scsi20,scsi21,scsi22,scsi23,scsi24,scsi25,scsi26,scsi27,scsi28,scsi29,scsi30,virtio0,virtio1,virtio2,virtio3,virtio4,virtio5,virtio6,virtio7,virtio8,virtio9,virtio10,virtio11,virtio12,virtio13,virtio14,virtio15,sata0,sata1,sata2,sata3,sata4,sata5,efidisk0,tpmstate0 | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuTermproxy
Creates a TCP proxy connections.
Syntax
New-PveNodesQemuTermproxy [[-PveTicket] <PveTicket>] [-Node] <String> [[-Serial] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| opens a serial terminal (defaults to display) Enum: serial0,serial1,serial2,serial3 | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesQemuVncproxy
Creates a TCP VNC proxy connections.
Syntax
New-PveNodesQemuVncproxy [[-PveTicket] <PveTicket>] [-GeneratePassword] [-Node] <String> [-Vmid] <Int32> [-Websocket] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Generates a random password to be used as ticket instead of the API ticket. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 | ||
| Prepare for websocket upgrade (only required when using serial terminal, otherwise upgrade is always possible). | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesReplicationScheduleNow
Schedule replication job to start as soon as possible.
Syntax
New-PveNodesReplicationScheduleNow [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesServicesReload
Reload service. Falls back to restart if service cannot be reloaded.
Syntax
New-PveNodesServicesReload [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesServicesRestart
Hard restart service. Use reload if you want to reduce interruptions.
Syntax
New-PveNodesServicesRestart [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesServicesStart
Start service.
Syntax
New-PveNodesServicesStart [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesServicesStop
Stop service.
Syntax
New-PveNodesServicesStop [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesSpiceshell
Creates a SPICE shell.
Syntax
New-PveNodesSpiceshell [[-PveTicket] <PveTicket>] [[-Cmd] <String>] [[-CmdOpts] <String>] [-Node] <String> [[-Proxy] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Run specific command or default to login (requires 'root@pam') Enum: upgrade,ceph_install,login | false | true (ByPropertyName) | |||
| Add parameters to a command. Encoded as null terminated strings. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI). | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesStartall
Start all VMs and containers located on this node (by default only those with onboot=1).
Syntax
New-PveNodesStartall [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [[-Vms] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Issue start command even if virtual guest have 'onboot' not set or set to off. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Only consider guests from this comma separated list of VMIDs. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesStatus
Reboot or shutdown a node.
Syntax
New-PveNodesStatus [[-PveTicket] <PveTicket>] [-Command] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Specify the command. Enum: reboot,shutdown | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesStopall
Stop all VMs and Containers.
Syntax
New-PveNodesStopall [[-PveTicket] <PveTicket>] [-ForceStop] [-Node] <String> [[-Timeout] <Int32>] [[-Vms] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Force a hard-stop after the timeout. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Timeout for each guest shutdown task. Depending on `force-stop`, the shutdown gets then simply aborted or a hard-stop is forced. | false | true (ByPropertyName) | 0 | ||
| Only consider Guests with these IDs. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesStorageContent
Allocate disk images.
Syntax
New-PveNodesStorageContent [[-PveTicket] <PveTicket>] [-Filename] <String> [[-Format] <String>] [-Node] <String> [-Size] <String> [-Storage] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The name of the file to create. | true | true (ByPropertyName) | |||
| -- Enum: raw,qcow2,subvol | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M) | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| Specify owner VM | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesStorageContentIdx
Copy a volume. This is experimental code - do not use.
Syntax
New-PveNodesStorageContentIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Storage] <String>] [-Target] <String> [[-TargetNode] <String>] [-Volume] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | false | true (ByPropertyName) | |||
| Target volume identifier | true | true (ByPropertyName) | |||
| Target node. Default is local node. | false | true (ByPropertyName) | |||
| Source volume identifier | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesStorageDownloadUrl
Download templates and ISO images by using an URL.
Syntax
New-PveNodesStorageDownloadUrl [[-PveTicket] <PveTicket>] [[-Checksum] <String>] [[-ChecksumAlgorithm] <String>] [[-Compression] <String>] [-Content] <String> [-Filename] <String> [-Node] <String> [-Storage] <String> [-Url] <String> [-VerifyCertificates] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The expected checksum of the file. | false | true (ByPropertyName) | |||
| The algorithm to calculate the checksum of the file. Enum: md5,sha1,sha224,sha256,sha384,sha512 | false | true (ByPropertyName) | |||
| Decompress the downloaded file using the specified compression algorithm. | false | true (ByPropertyName) | |||
| Content type. Enum: iso,vztmpl | true | true (ByPropertyName) | |||
| The name of the file to create. Caution':' This will be normalized! | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| The URL to download the file from. | true | true (ByPropertyName) | |||
| If false, no SSL/TLS certificates will be verified. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesStorageUpload
Upload templates and ISO images.
Syntax
New-PveNodesStorageUpload [[-PveTicket] <PveTicket>] [[-Checksum] <String>] [[-ChecksumAlgorithm] <String>] [-Content] <String> [-Filename] <String> [-Node] <String> [-Storage] <String> [[-Tmpfilename] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The expected checksum of the file. | false | true (ByPropertyName) | |||
| The algorithm to calculate the checksum of the file. Enum: md5,sha1,sha224,sha256,sha384,sha512 | false | true (ByPropertyName) | |||
| Content type. Enum: iso,vztmpl | true | true (ByPropertyName) | |||
| The name of the file to create. Caution':' This will be normalized! | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| The source file name. This parameter is usually set by the REST handler. You can only overwrite it when connecting to the trusted port on localhost. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesSubscription
Update subscription info.
Syntax
New-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Always connect to server, even if local cache is still valid. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesSuspendall
Suspend all VMs.
Syntax
New-PveNodesSuspendall [[-PveTicket] <PveTicket>] [-Node] <String> [[-Vms] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Only consider Guests with these IDs. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesTermproxy
Creates a VNC Shell proxy.
Syntax
New-PveNodesTermproxy [[-PveTicket] <PveTicket>] [[-Cmd] <String>] [[-CmdOpts] <String>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Run specific command or default to login (requires 'root@pam') Enum: upgrade,ceph_install,login | false | true (ByPropertyName) | |||
| Add parameters to a command. Encoded as null terminated strings. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesVncshell
Creates a VNC Shell proxy.
Syntax
New-PveNodesVncshell [[-PveTicket] <PveTicket>] [[-Cmd] <String>] [[-CmdOpts] <String>] [[-Height] <Int32>] [-Node] <String> [-Websocket] [[-Width] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Run specific command or default to login (requires 'root@pam') Enum: upgrade,ceph_install,login | false | true (ByPropertyName) | |||
| Add parameters to a command. Encoded as null terminated strings. | false | true (ByPropertyName) | |||
| sets the height of the console in pixels. | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| use websocket instead of standard vnc. | false | true (ByPropertyName) | False | ||
| sets the width of the console in pixels. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesVzdump
Create backup.
Aliases
- Backup-PveVzdump
Syntax
New-PveNodesVzdump [[-PveTicket] <PveTicket>] [-All] [[-Bwlimit] <Int32>] [[-Compress] <String>] [[-Dumpdir] <String>] [[-Exclude] <String>] [[-ExcludePath] <Array>] [[-Fleecing] <String>] [[-Ionice] <Int32>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <String>] [[-NotificationMode] <String>] [[-NotificationPolicy] <String>] [[-NotificationTarget] <String>] [[-Performance] <String>] [[-Pigz] <Int32>] [[-Pool] <String>] [-Protected] [[-PruneBackups] <String>] [-Quiet] [-Remove] [[-Script] <String>] [-Stdexcludes] [-Stdout] [-Stop] [[-Stopwait] <Int32>] [[-Storage] <String>] [[-Tmpdir] <String>] [[-Vmid] <String>] [[-Zstd] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Backup all known guest systems on this host. | false | true (ByPropertyName) | False | ||
| Limit I/O bandwidth (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| Compress dump file. Enum: 0,1,gzip,lzo,zstd | false | true (ByPropertyName) | |||
| Store resulting files to specified directory. | false | true (ByPropertyName) | |||
| Exclude specified guest systems (assumes --all) | false | true (ByPropertyName) | |||
| Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. | false | true (ByPropertyName) | |||
| Options for backup fleecing (VM only). | false | true (ByPropertyName) | |||
| Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. | false | true (ByPropertyName) | 0 | ||
| Maximal time to wait for the global lock (minutes). | false | true (ByPropertyName) | 0 | ||
| Deprecated':' use notification targets/matchers instead. Specify when to send a notification mail Enum: always,failure | false | true (ByPropertyName) | |||
| Deprecated':' Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications. | false | true (ByPropertyName) | |||
| Deprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system. | false | true (ByPropertyName) | 0 | ||
| Backup mode. Enum: snapshot,suspend,stop | false | true (ByPropertyName) | |||
| Only run if executed on this node. | false | true (ByPropertyName) | |||
| Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. | false | true (ByPropertyName) | |||
| Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. Enum: auto,legacy-sendmail,notification-system | false | true (ByPropertyName) | |||
| Deprecated':' Do not use Enum: always,failure,never | false | true (ByPropertyName) | |||
| Deprecated':' Do not use | false | true (ByPropertyName) | |||
| Other performance-related settings. | false | true (ByPropertyName) | |||
| Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. | false | true (ByPropertyName) | 0 | ||
| Backup all known guest systems included in the specified pool. | false | true (ByPropertyName) | |||
| If true, mark backup(s) as protected. | false | true (ByPropertyName) | False | ||
| Use these retention options instead of those from the storage configuration. | false | true (ByPropertyName) | |||
| Be quiet. | false | true (ByPropertyName) | False | ||
| Prune older backups according to 'prune-backups'. | false | true (ByPropertyName) | False | ||
| Use specified hook script. | false | true (ByPropertyName) | |||
| Exclude temporary files and logs. | false | true (ByPropertyName) | False | ||
| Write tar to stdout, not to a file. | false | true (ByPropertyName) | False | ||
| Stop running backup jobs on this host. | false | true (ByPropertyName) | False | ||
| Maximal time to wait until a guest system is stopped (minutes). | false | true (ByPropertyName) | 0 | ||
| Store resulting file to this storage. | false | true (ByPropertyName) | |||
| Store temporary files to specified directory. | false | true (ByPropertyName) | |||
| The ID of the guest system you want to backup. | false | true (ByPropertyName) | |||
| Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveNodesWakeonlan
Try to wake a node via 'wake on LAN' network packet.
Syntax
New-PveNodesWakeonlan [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| target node for wake on LAN packet | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PvePools
Create new pool.
Syntax
New-PvePools [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Poolid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveStorage
Create a new storage.
Syntax
New-PveStorage [[-PveTicket] <PveTicket>] [[-Authsupported] <String>] [[-Base] <String>] [[-Blocksize] <String>] [[-Bwlimit] <String>] [[-ComstarHg] <String>] [[-ComstarTg] <String>] [[-Content] <String>] [[-ContentDirs] <String>] [-CreateBasePath] [-CreateSubdirs] [[-DataPool] <String>] [[-Datastore] <String>] [-Disable] [[-Domain] <String>] [[-EncryptionKey] <String>] [[-Export] <String>] [[-Fingerprint] <String>] [[-Format] <String>] [[-FsName] <String>] [-Fuse] [[-IsMountpoint] <String>] [[-Iscsiprovider] <String>] [[-Keyring] <String>] [-Krbd] [[-LioTpg] <String>] [[-MasterPubkey] <String>] [[-MaxProtectedBackups] <Int32>] [[-Maxfiles] <Int32>] [-Mkdir] [[-Monhost] <String>] [[-Mountpoint] <String>] [[-Namespace] <String>] [-Nocow] [[-Nodes] <String>] [-Nowritecache] [[-Options] <String>] [[-Password] <SecureString>] [[-Path] <String>] [[-Pool] <String>] [[-Port] <Int32>] [[-Portal] <String>] [[-Preallocation] <String>] [[-PruneBackups] <String>] [-Saferemove] [[-SaferemoveThroughput] <String>] [[-Server] <String>] [[-Server2] <String>] [[-Share] <String>] [-Shared] [-SkipCertVerification] [[-Smbversion] <String>] [-Sparse] [-Storage] <String> [[-Subdir] <String>] [-TaggedOnly] [[-Target] <String>] [[-Thinpool] <String>] [[-Transport] <String>] [-Type] <String> [[-Username] <String>] [[-Vgname] <String>] [[-Volume] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Authsupported. | false | true (ByPropertyName) | |||
| Base volume. This volume is automatically activated. | false | true (ByPropertyName) | |||
| block size | false | true (ByPropertyName) | |||
| Set I/O bandwidth limit for various operations (in KiB/s). | false | true (ByPropertyName) | |||
| host group for comstar views | false | true (ByPropertyName) | |||
| target group for comstar views | false | true (ByPropertyName) | |||
| Allowed content types.NOTE':' the value 'rootdir' is used for Containers, and value 'images' for VMs. | false | true (ByPropertyName) | |||
| Overrides for default content type directories. | false | true (ByPropertyName) | |||
| Create the base directory if it doesn't exist. | false | true (ByPropertyName) | False | ||
| Populate the directory with the default structure. | false | true (ByPropertyName) | False | ||
| Data Pool (for erasure coding only) | false | true (ByPropertyName) | |||
| Proxmox Backup Server datastore name. | false | true (ByPropertyName) | |||
| Flag to disable the storage. | false | true (ByPropertyName) | False | ||
| CIFS domain. | false | true (ByPropertyName) | |||
| Encryption key. Use 'autogen' to generate one automatically without passphrase. | false | true (ByPropertyName) | |||
| NFS export path. | false | true (ByPropertyName) | |||
| Certificate SHA 256 fingerprint. | false | true (ByPropertyName) | |||
| Default image format. | false | true (ByPropertyName) | |||
| The Ceph filesystem name. | false | true (ByPropertyName) | |||
| Mount CephFS through FUSE. | false | true (ByPropertyName) | False | ||
| Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. | false | true (ByPropertyName) | |||
| iscsi provider | false | true (ByPropertyName) | |||
| Client keyring contents (for external clusters). | false | true (ByPropertyName) | |||
| Always access rbd through krbd kernel module. | false | true (ByPropertyName) | False | ||
| target portal group for Linux LIO targets | false | true (ByPropertyName) | |||
| Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. | false | true (ByPropertyName) | |||
| Maximal number of protected backups per guest. Use '-1' for unlimited. | false | true (ByPropertyName) | 0 | ||
| Deprecated':' use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited. | false | true (ByPropertyName) | 0 | ||
| Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE':' Deprecated, use the 'create-base-path' and 'create-subdirs' options instead. | false | true (ByPropertyName) | False | ||
| IP addresses of monitors (for external clusters). | false | true (ByPropertyName) | |||
| mount point | false | true (ByPropertyName) | |||
| Namespace. | false | true (ByPropertyName) | |||
| Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system. | false | true (ByPropertyName) | False | ||
| List of nodes for which the storage configuration applies. | false | true (ByPropertyName) | |||
| disable write caching on the target | false | true (ByPropertyName) | False | ||
| NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') | false | true (ByPropertyName) | |||
| Password for accessing the share/datastore. | false | true (ByPropertyName) | |||
| File system path. | false | true (ByPropertyName) | |||
| Pool. | false | true (ByPropertyName) | |||
| For non default port. | false | true (ByPropertyName) | 0 | ||
| iSCSI portal (IP or DNS name with optional port). | false | true (ByPropertyName) | |||
| Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. Enum: off,metadata,falloc,full | false | true (ByPropertyName) | |||
| The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups. | false | true (ByPropertyName) | |||
| Zero-out data when removing LVs. | false | true (ByPropertyName) | False | ||
| Wipe throughput (cstream -t parameter value). | false | true (ByPropertyName) | |||
| Server IP or DNS name. | false | true (ByPropertyName) | |||
| Backup volfile server IP or DNS name. | false | true (ByPropertyName) | |||
| CIFS share. | false | true (ByPropertyName) | |||
| Indicate that this is a single storage with the same contents on all nodes (or all listed in the 'nodes' option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such! | false | true (ByPropertyName) | False | ||
| Disable TLS certificate verification, only enable on fully trusted networks! | false | true (ByPropertyName) | False | ||
| SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. Enum: default,2.0,2.1,3,3.0,3.11 | false | true (ByPropertyName) | |||
| use sparse volumes | false | true (ByPropertyName) | False | ||
| The storage identifier. | true | true (ByPropertyName) | |||
| Subdir to mount. | false | true (ByPropertyName) | |||
| Only use logical volumes tagged with 'pve-vm-ID'. | false | true (ByPropertyName) | False | ||
| iSCSI target. | false | true (ByPropertyName) | |||
| LVM thin pool LV name. | false | true (ByPropertyName) | |||
| Gluster transport':' tcp or rdma Enum: tcp,rdma,unix | false | true (ByPropertyName) | |||
| Storage type. Enum: btrfs,cephfs,cifs,dir,esxi,glusterfs,iscsi,iscsidirect,lvm,lvmthin,nfs,pbs,rbd,zfs,zfspool | true | true (ByPropertyName) | |||
| RBD Id. | false | true (ByPropertyName) | |||
| Volume group name. | false | true (ByPropertyName) | |||
| Glusterfs Volume. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
New-PveVmSnapshot
Create snapshot VM.
Syntax
New-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [[-Description] <String>] [-Snapname] <String> [-Vmstate] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The (unique) ID or Name of the VM. | true | true (ByValue, ByPropertyName) | |||
| A textual description or comment. | false | true (ByValue, ByPropertyName) | |||
| The name of the snapshot. | true | true (ByValue, ByPropertyName) | |||
| Save the vmstate | false | true (ByValue, ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveAccessDomains
Delete an authentication server.
Syntax
Remove-PveAccessDomains [[-PveTicket] <PveTicket>] [-Realm] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Authentication domain ID | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveAccessGroups
Delete group.
Syntax
Remove-PveAccessGroups [[-PveTicket] <PveTicket>] [-Groupid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveAccessRoles
Delete role.
Syntax
Remove-PveAccessRoles [[-PveTicket] <PveTicket>] [-Roleid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveAccessTfa
Delete a TFA entry by ID.
Syntax
Remove-PveAccessTfa [[-PveTicket] <PveTicket>] [-Id] <String> [[-Password] <SecureString>] [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A TFA entry id. | true | true (ByPropertyName) | |||
| The current password of the user performing the change. | false | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveAccessUsers
Delete user.
Syntax
Remove-PveAccessUsers [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveAccessUsersToken
Remove API token for a specific user.
Syntax
Remove-PveAccessUsersToken [[-PveTicket] <PveTicket>] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| User-specific token identifier. | true | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterAcmeAccount
Deactivate existing ACME account at CA.
Syntax
Remove-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [[-Name] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| ACME account config file name. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterAcmePlugins
Delete ACME plugin configuration.
Syntax
Remove-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Unique identifier for ACME plugin instance. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterBackup
Delete vzdump backup job definition.
Syntax
Remove-PveClusterBackup [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The job ID. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterConfigNodes
Removes a node from the cluster configuration.
Syntax
Remove-PveClusterConfigNodes [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterFirewallAliases
Remove IP or Network alias.
Syntax
Remove-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Alias name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterFirewallGroups
Delete security group.
Syntax
Remove-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Security Group name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterFirewallGroupsIdx
Delete rule.
Syntax
Remove-PveClusterFirewallGroupsIdx [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Group] <String> [[-Pos] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Security Group name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterFirewallIpset
Delete IPSet
Syntax
Remove-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Delete all members of the IPSet, if there are any. | false | true (ByPropertyName) | False | ||
| IP set name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterFirewallIpsetIdx
Remove IP or Network from IPSet.
Syntax
Remove-PveClusterFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterFirewallRules
Delete rule.
Syntax
Remove-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [[-Pos] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterHaGroups
Delete ha group configuration.
Syntax
Remove-PveClusterHaGroups [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The HA group identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterHaResources
Delete resource configuration.
Syntax
Remove-PveClusterHaResources [[-PveTicket] <PveTicket>] [-Sid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100). | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterJobsRealmSync
Delete realm-sync job definition.
Syntax
Remove-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterMappingPci
Remove Hardware Mapping.
Syntax
Remove-PveClusterMappingPci [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterMappingUsb
Remove Hardware Mapping.
Syntax
Remove-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterMetricsServer
Remove Metric server.
Syntax
Remove-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterNotificationsEndpointsGotify
Remove gotify endpoint
Syntax
Remove-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterNotificationsEndpointsSendmail
Remove sendmail endpoint
Syntax
Remove-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterNotificationsEndpointsSmtp
Remove smtp endpoint
Syntax
Remove-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterNotificationsMatchers
Remove matcher
Syntax
Remove-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterReplication
Mark replication job for removal.
Syntax
Remove-PveClusterReplication [[-PveTicket] <PveTicket>] [-Force] [-Id] <String> [-Keep] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Will remove the jobconfig entry, but will not cleanup. | false | true (ByPropertyName) | False | ||
| Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. | true | true (ByPropertyName) | |||
| Keep replicated data at target (do not remove). | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterSdnControllers
Delete sdn controller object configuration.
Syntax
Remove-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [-Controller] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The SDN controller object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterSdnDns
Delete sdn dns object configuration.
Syntax
Remove-PveClusterSdnDns [[-PveTicket] <PveTicket>] [-Dns] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The SDN dns object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterSdnIpams
Delete sdn ipam object configuration.
Syntax
Remove-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [-Ipam] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The SDN ipam object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterSdnVnets
Delete sdn vnet object configuration.
Syntax
Remove-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [-Vnet] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The SDN vnet object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterSdnVnetsIps
Delete IP Mappings in a VNet
Syntax
Remove-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The IP address to delete | true | true (ByPropertyName) | |||
| Unicast MAC address. | false | true (ByPropertyName) | |||
| The SDN vnet object identifier. | true | true (ByPropertyName) | |||
| The SDN zone object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterSdnVnetsSubnets
Delete sdn subnet object configuration.
Syntax
Remove-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [-Subnet] <String> [-Vnet] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The SDN subnet object identifier. | true | true (ByPropertyName) | |||
| The SDN vnet object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveClusterSdnZones
Delete sdn zone object configuration.
Syntax
Remove-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-Zone] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The SDN zone object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesCephMds
Destroy Ceph Metadata Server
Syntax
Remove-PveNodesCephMds [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The name (ID) of the mds | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesCephMgr
Destroy Ceph Manager.
Syntax
Remove-PveNodesCephMgr [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The ID of the manager | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesCephMon
Destroy Ceph Monitor and Manager.
Syntax
Remove-PveNodesCephMon [[-PveTicket] <PveTicket>] [-Monid] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Monitor ID | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesCephOsd
Destroy OSD
Syntax
Remove-PveNodesCephOsd [[-PveTicket] <PveTicket>] [-Cleanup] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| If set, we remove partition table entries. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| OSD ID | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesCephPool
Destroy pool
Syntax
Remove-PveNodesCephPool [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-RemoveEcprofile] [-RemoveStorages] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| If true, destroys pool even if in use | false | true (ByPropertyName) | False | ||
| The name of the pool. It must be unique. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Remove the erasure code profile. Defaults to true, if applicable. | false | true (ByPropertyName) | False | ||
| Remove all pveceph-managed storages configured for this pool | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesCertificatesAcmeCertificate
Revoke existing certificate from CA.
Syntax
Remove-PveNodesCertificatesAcmeCertificate [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesCertificatesCustom
DELETE custom certificate chain and key.
Syntax
Remove-PveNodesCertificatesCustom [[-PveTicket] <PveTicket>] [-Node] <String> [-Restart] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Restart pveproxy. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesDisksDirectory
Unmounts the storage and removes the mount unit.
Syntax
Remove-PveNodesDisksDirectory [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). | false | true (ByPropertyName) | False | ||
| Also wipe disk so it can be repurposed afterwards. | false | true (ByPropertyName) | False | ||
| The storage identifier. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesDisksLvm
Remove an LVM Volume Group.
Syntax
Remove-PveNodesDisksLvm [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). | false | true (ByPropertyName) | False | ||
| Also wipe disks so they can be repurposed afterwards. | false | true (ByPropertyName) | False | ||
| The storage identifier. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesDisksLvmthin
Remove an LVM thin pool.
Syntax
Remove-PveNodesDisksLvmthin [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [-VolumeGroup] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). | false | true (ByPropertyName) | False | ||
| Also wipe disks so they can be repurposed afterwards. | false | true (ByPropertyName) | False | ||
| The storage identifier. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesDisksZfs
Destroy a ZFS pool.
Syntax
Remove-PveNodesDisksZfs [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). | false | true (ByPropertyName) | False | ||
| Also wipe disks so they can be repurposed afterwards. | false | true (ByPropertyName) | False | ||
| The storage identifier. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesFirewallRules
Delete rule.
Syntax
Remove-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesLxc
Destroy the container (also delete all uses files).
Syntax
Remove-PveNodesLxc [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Force] [-Node] <String> [-Purge] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config. | false | true (ByPropertyName) | False | ||
| Force destroy, even if running. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed. | false | true (ByPropertyName) | False | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesLxcFirewallAliases
Remove IP or Network alias.
Syntax
Remove-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Alias name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesLxcFirewallIpset
Delete IPSet
Syntax
Remove-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Delete all members of the IPSet, if there are any. | false | true (ByPropertyName) | False | ||
| IP set name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesLxcFirewallIpsetIdx
Remove IP or Network from IPSet.
Syntax
Remove-PveNodesLxcFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesLxcFirewallRules
Delete rule.
Syntax
Remove-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesLxcSnapshot
Delete a LXC snapshot.
Syntax
Remove-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| For removal from config file, even if removing disk snapshots fails. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesNetwork
Revert network configuration changes.
Syntax
Remove-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesNetworkIdx
Delete network device configuration
Syntax
Remove-PveNodesNetworkIdx [[-PveTicket] <PveTicket>] [-Iface] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network interface name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesQemu
Destroy the VM and all used/owned volumes. Removes any VM specific permissions and firewall rules
Syntax
Remove-PveNodesQemu [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Node] <String> [-Purge] [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Remove VMID from configurations, like backup & replication jobs and HA. | false | true (ByPropertyName) | False | ||
| Ignore locks - only root is allowed to use this option. | false | true (ByPropertyName) | False | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesQemuFirewallAliases
Remove IP or Network alias.
Syntax
Remove-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Alias name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesQemuFirewallIpset
Delete IPSet
Syntax
Remove-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Delete all members of the IPSet, if there are any. | false | true (ByPropertyName) | False | ||
| IP set name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesQemuFirewallIpsetIdx
Remove IP or Network from IPSet.
Syntax
Remove-PveNodesQemuFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesQemuFirewallRules
Delete rule.
Syntax
Remove-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesQemuSnapshot
Delete a VM snapshot.
Syntax
Remove-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| For removal from config file, even if removing disk snapshots fails. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesStorageContent
Delete volume
Syntax
Remove-PveNodesStorageContent [[-PveTicket] <PveTicket>] [[-Delay] <Int32>] [-Node] <String> [[-Storage] <String>] [-Volume] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Time to wait for the task to finish. We return 'null' if the task finish within that time. | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| The storage identifier. | false | true (ByPropertyName) | |||
| Volume identifier | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesStoragePrunebackups
Prune backups. Only those using the standard naming scheme are considered.
Syntax
Remove-PveNodesStoragePrunebackups [[-PveTicket] <PveTicket>] [-Node] <String> [[-PruneBackups] <String>] [-Storage] <String> [[-Type] <String>] [[-Vmid] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Use these retention options instead of those from the storage configuration. | false | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) | |||
| Either 'qemu' or 'lxc'. Only consider backups for guests of this type. Enum: qemu,lxc | false | true (ByPropertyName) | |||
| Only prune backups for this VM. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesSubscription
Delete subscription key of this node.
Syntax
Remove-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveNodesTasks
Stop a task.
Syntax
Remove-PveNodesTasks [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PvePools
Delete pool.
Syntax
Remove-PvePools [[-PveTicket] <PveTicket>] [-Poolid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PvePoolsIdx
Delete pool (deprecated, no support for nested pools, use 'DELETE /pools/?poolid={poolid}').
Syntax
Remove-PvePoolsIdx [[-PveTicket] <PveTicket>] [-Poolid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveStorage
Delete storage configuration.
Syntax
Remove-PveStorage [[-PveTicket] <PveTicket>] [-Storage] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The storage identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Remove-PveVmSnapshot
Delete a VM snapshot.
Syntax
Remove-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Snapname] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The (unique) ID or Name of the VM. | true | true (ByValue, ByPropertyName) | |||
| The name of the snapshot. | true | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Reset-PveVm
Reset VM.
Syntax
Reset-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The (unique) ID or Name of the VM. | true | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Resume-PveVm
Resume VM.
Syntax
Resume-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The (unique) ID or Name of the VM. | true | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveAccessAcl
Update Access Control List (add or remove permissions).
Syntax
Set-PveAccessAcl [[-PveTicket] <PveTicket>] [-Delete] [[-Groups] <String>] [-Path] <String> [-Propagate] [-Roles] <String> [[-Tokens] <String>] [[-Users] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Remove permissions (instead of adding it). | false | true (ByPropertyName) | False | ||
| List of groups. | false | true (ByPropertyName) | |||
| Access control path | true | true (ByPropertyName) | |||
| Allow to propagate (inherit) permissions. | false | true (ByPropertyName) | False | ||
| List of roles. | true | true (ByPropertyName) | |||
| List of API tokens. | false | true (ByPropertyName) | |||
| List of users. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveAccessDomains
Update authentication server settings.
Syntax
Set-PveAccessDomains [[-PveTicket] <PveTicket>] [[-AcrValues] <String>] [-Autocreate] [[-BaseDn] <String>] [[-BindDn] <String>] [[-Capath] <String>] [-CaseSensitive] [[-Cert] <String>] [[-Certkey] <String>] [-CheckConnection] [[-ClientId] <String>] [[-ClientKey] <String>] [[-Comment] <String>] [-Default] [[-Delete] <String>] [[-Digest] <String>] [[-Domain] <String>] [[-Filter] <String>] [[-GroupClasses] <String>] [[-GroupDn] <String>] [[-GroupFilter] <String>] [[-GroupNameAttr] <String>] [[-IssuerUrl] <String>] [[-Mode] <String>] [[-Password] <SecureString>] [[-Port] <Int32>] [[-Prompt] <String>] [-Realm] <String> [[-Scopes] <String>] [-Secure] [[-Server1] <String>] [[-Server2] <String>] [[-Sslversion] <String>] [[-SyncDefaultsOptions] <String>] [[-SyncAttributes] <String>] [[-Tfa] <String>] [[-UserAttr] <String>] [[-UserClasses] <String>] [-Verify] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. | false | true (ByPropertyName) | |||
| Automatically create users if they do not exist. | false | true (ByPropertyName) | False | ||
| LDAP base domain name | false | true (ByPropertyName) | |||
| LDAP bind domain name | false | true (ByPropertyName) | |||
| Path to the CA certificate store | false | true (ByPropertyName) | |||
| username is case-sensitive | false | true (ByPropertyName) | False | ||
| Path to the client certificate | false | true (ByPropertyName) | |||
| Path to the client certificate key | false | true (ByPropertyName) | |||
| Check bind connection to the server. | false | true (ByPropertyName) | False | ||
| OpenID Client ID | false | true (ByPropertyName) | |||
| OpenID Client Key | false | true (ByPropertyName) | |||
| Description. | false | true (ByPropertyName) | |||
| Use this as default realm | false | true (ByPropertyName) | False | ||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| AD domain name | false | true (ByPropertyName) | |||
| LDAP filter for user sync. | false | true (ByPropertyName) | |||
| The objectclasses for groups. | false | true (ByPropertyName) | |||
| LDAP base domain name for group sync. If not set, the base_dn will be used. | false | true (ByPropertyName) | |||
| LDAP filter for group sync. | false | true (ByPropertyName) | |||
| LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name. | false | true (ByPropertyName) | |||
| OpenID Issuer Url | false | true (ByPropertyName) | |||
| LDAP protocol mode. Enum: ldap,ldaps,ldap+starttls | false | true (ByPropertyName) | |||
| LDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'. | false | true (ByPropertyName) | |||
| Server port. | false | true (ByPropertyName) | 0 | ||
| Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. | false | true (ByPropertyName) | |||
| Authentication domain ID | true | true (ByPropertyName) | |||
| Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. | false | true (ByPropertyName) | |||
| Use secure LDAPS protocol. DEPRECATED':' use 'mode' instead. | false | true (ByPropertyName) | False | ||
| Server IP address (or DNS name) | false | true (ByPropertyName) | |||
| Fallback Server IP address (or DNS name) | false | true (ByPropertyName) | |||
| LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! Enum: tlsv1,tlsv1_1,tlsv1_2,tlsv1_3 | false | true (ByPropertyName) | |||
| The default options for behavior of synchronizations. | false | true (ByPropertyName) | |||
| Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name. | false | true (ByPropertyName) | |||
| Use Two-factor authentication. | false | true (ByPropertyName) | |||
| LDAP user attribute name | false | true (ByPropertyName) | |||
| The objectclasses for users. | false | true (ByPropertyName) | |||
| Verify the server's SSL certificate | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveAccessGroups
Update group data.
Syntax
Set-PveAccessGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Groupid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveAccessPassword
Change user password.
Syntax
Set-PveAccessPassword [[-PveTicket] <PveTicket>] [[-ConfirmationPassword] <SecureString>] [-Password] <SecureString> [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The current password of the user performing the change. | false | true (ByPropertyName) | |||
| The new password. | true | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveAccessRoles
Update an existing role.
Syntax
Set-PveAccessRoles [[-PveTicket] <PveTicket>] [-Append] [[-Privs] <String>] [-Roleid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | False | ||
| -- | false | true (ByPropertyName) | |||
| -- | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveAccessTfa
Add a TFA entry for a user.
Syntax
Set-PveAccessTfa [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Enable] [-Id] <String> [[-Password] <SecureString>] [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A description to distinguish multiple entries from one another | false | true (ByPropertyName) | |||
| Whether the entry should be enabled for login. | false | true (ByPropertyName) | False | ||
| A TFA entry id. | true | true (ByPropertyName) | |||
| The current password of the user performing the change. | false | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveAccessUsers
Update user configuration.
Syntax
Set-PveAccessUsers [[-PveTicket] <PveTicket>] [-Append] [[-Comment] <String>] [[-Email] <String>] [-Enable] [[-Expire] <Int32>] [[-Firstname] <String>] [[-Groups] <String>] [[-Keys] <String>] [[-Lastname] <String>] [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | False | ||
| -- | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Enable the account (default). You can set this to '0' to disable the account | false | true (ByPropertyName) | False | ||
| Account expiration date (seconds since epoch). '0' means no expiration date. | false | true (ByPropertyName) | 0 | ||
| -- | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Keys for two factor auth (yubico). | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| 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.
Set-PveAccessUsersToken
Update API token for a specific user.
Syntax
Set-PveAccessUsersToken [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Expire] <Int32>] [-Privsep] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| API token expiration date (seconds since epoch). '0' means no expiration date. | false | true (ByPropertyName) | 0 | ||
| Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. | false | true (ByPropertyName) | False | ||
| User-specific token identifier. | true | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveAccessUsersUnlockTfa
Unlock a user's TFA authentication.
Syntax
Set-PveAccessUsersUnlockTfa [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Full User ID, in the `name@realm` format. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterAcmeAccount
Update existing ACME account information with CA. Note':' not specifying any new account information triggers a refresh.
Syntax
Set-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [[-Contact] <String>] [[-Name] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Contact email addresses. | false | true (ByPropertyName) | |||
| ACME account config file name. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterAcmePlugins
Update ACME plugin configuration.
Syntax
Set-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [[-Api] <String>] [[-Data] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [-Id] <String> [[-Nodes] <String>] [[-ValidationDelay] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| API plugin name Enum: 1984hosting,acmedns,acmeproxy,active24,ad,ali,anx,artfiles,arvan,aurora,autodns,aws,azion,azure,bookmyname,bunny,cf,clouddns,cloudns,cn,conoha,constellix,cpanel,curanet,cyon,da,ddnss,desec,df,dgon,dnsexit,dnshome,dnsimple,dnsservices,do,doapi,domeneshop,dp,dpi,dreamhost,duckdns,durabledns,dyn,dynu,dynv6,easydns,edgedns,euserv,exoscale,fornex,freedns,gandi_livedns,gcloud,gcore,gd,geoscaling,googledomains,he,hetzner,hexonet,hostingde,huaweicloud,infoblox,infomaniak,internetbs,inwx,ionos,ipv64,ispconfig,jd,joker,kappernet,kas,kinghost,knot,la,leaseweb,lexicon,linode,linode_v4,loopia,lua,maradns,me,miab,misaka,myapi,mydevil,mydnsjp,mythic_beasts,namecheap,namecom,namesilo,nanelo,nederhost,neodigit,netcup,netlify,nic,njalla,nm,nsd,nsone,nsupdate,nw,oci,one,online,openprovider,openstack,opnsense,ovh,pdns,pleskxml,pointhq,porkbun,rackcorp,rackspace,rage4,rcode0,regru,scaleway,schlundtech,selectel,selfhost,servercow,simply,tele3,tencent,transip,udr,ultra,unoeuro,variomedia,veesp,vercel,vscale,vultr,websupport,world4you,yandex,yc,zilore,zone,zonomi | false | true (ByPropertyName) | |||
| DNS plugin data. (base64 encoded) | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Flag to disable the config. | false | true (ByPropertyName) | False | ||
| ACME Plugin ID name | true | true (ByPropertyName) | |||
| List of cluster node names. | false | true (ByPropertyName) | |||
| 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.
Set-PveClusterBackup
Update vzdump backup job definition.
Syntax
Set-PveClusterBackup [[-PveTicket] <PveTicket>] [-All] [[-Bwlimit] <Int32>] [[-Comment] <String>] [[-Compress] <String>] [[-Delete] <String>] [[-Dow] <String>] [[-Dumpdir] <String>] [-Enabled] [[-Exclude] <String>] [[-ExcludePath] <Array>] [[-Fleecing] <String>] [-Id] <String> [[-Ionice] <Int32>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <String>] [[-NotificationMode] <String>] [[-NotificationPolicy] <String>] [[-NotificationTarget] <String>] [[-Performance] <String>] [[-Pigz] <Int32>] [[-Pool] <String>] [-Protected] [[-PruneBackups] <String>] [-Quiet] [-Remove] [-RepeatMissed] [[-Schedule] <String>] [[-Script] <String>] [[-Starttime] <String>] [-Stdexcludes] [-Stop] [[-Stopwait] <Int32>] [[-Storage] <String>] [[-Tmpdir] <String>] [[-Vmid] <String>] [[-Zstd] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Backup all known guest systems on this host. | false | true (ByPropertyName) | False | ||
| Limit I/O bandwidth (in KiB/s). | false | true (ByPropertyName) | 0 | ||
| Description for the Job. | false | true (ByPropertyName) | |||
| Compress dump file. Enum: 0,1,gzip,lzo,zstd | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Day of week selection. | false | true (ByPropertyName) | |||
| Store resulting files to specified directory. | false | true (ByPropertyName) | |||
| Enable or disable the job. | false | true (ByPropertyName) | False | ||
| Exclude specified guest systems (assumes --all) | false | true (ByPropertyName) | |||
| Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. | false | true (ByPropertyName) | |||
| Options for backup fleecing (VM only). | false | true (ByPropertyName) | |||
| The job ID. | true | true (ByPropertyName) | |||
| Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. | false | true (ByPropertyName) | 0 | ||
| Maximal time to wait for the global lock (minutes). | false | true (ByPropertyName) | 0 | ||
| Deprecated':' use notification targets/matchers instead. Specify when to send a notification mail Enum: always,failure | false | true (ByPropertyName) | |||
| Deprecated':' Use notification targets/matchers instead. Comma-separated list of email addresses or users that should receive email notifications. | false | true (ByPropertyName) | |||
| Deprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system. | false | true (ByPropertyName) | 0 | ||
| Backup mode. Enum: snapshot,suspend,stop | false | true (ByPropertyName) | |||
| Only run if executed on this node. | false | true (ByPropertyName) | |||
| Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively. | false | true (ByPropertyName) | |||
| Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. Enum: auto,legacy-sendmail,notification-system | false | true (ByPropertyName) | |||
| Deprecated':' Do not use Enum: always,failure,never | false | true (ByPropertyName) | |||
| Deprecated':' Do not use | false | true (ByPropertyName) | |||
| Other performance-related settings. | false | true (ByPropertyName) | |||
| Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. | false | true (ByPropertyName) | 0 | ||
| Backup all known guest systems included in the specified pool. | false | true (ByPropertyName) | |||
| If true, mark backup(s) as protected. | false | true (ByPropertyName) | False | ||
| Use these retention options instead of those from the storage configuration. | false | true (ByPropertyName) | |||
| Be quiet. | false | true (ByPropertyName) | False | ||
| Prune older backups according to 'prune-backups'. | false | true (ByPropertyName) | False | ||
| If true, the job will be run as soon as possible if it was missed while the scheduler was not running. | false | true (ByPropertyName) | False | ||
| Backup schedule. The format is a subset of `systemd` calendar events. | false | true (ByPropertyName) | |||
| Use specified hook script. | false | true (ByPropertyName) | |||
| Job Start time. | false | true (ByPropertyName) | |||
| Exclude temporary files and logs. | false | true (ByPropertyName) | False | ||
| Stop running backup jobs on this host. | false | true (ByPropertyName) | False | ||
| Maximal time to wait until a guest system is stopped (minutes). | false | true (ByPropertyName) | 0 | ||
| Store resulting file to this storage. | false | true (ByPropertyName) | |||
| Store temporary files to specified directory. | false | true (ByPropertyName) | |||
| The ID of the guest system you want to backup. | false | true (ByPropertyName) | |||
| Zstd threads. N=0 uses half of the available cores, if N is set to a value bigger than 0, N is used as thread count. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterCephFlags
Set/Unset multiple ceph flags at once.
Syntax
Set-PveClusterCephFlags [[-PveTicket] <PveTicket>] [-Nobackfill] [-NodeepScrub] [-Nodown] [-Noin] [-Noout] [-Norebalance] [-Norecover] [-Noscrub] [-Notieragent] [-Noup] [-Pause] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Backfilling of PGs is suspended. | false | true (ByPropertyName) | False | ||
| Deep Scrubbing is disabled. | false | true (ByPropertyName) | False | ||
| OSD failure reports are being ignored, such that the monitors will not mark OSDs down. | false | true (ByPropertyName) | False | ||
| OSDs that were previously marked out will not be marked back in when they start. | false | true (ByPropertyName) | False | ||
| OSDs will not automatically be marked out after the configured interval. | false | true (ByPropertyName) | False | ||
| Rebalancing of PGs is suspended. | false | true (ByPropertyName) | False | ||
| Recovery of PGs is suspended. | false | true (ByPropertyName) | False | ||
| Scrubbing is disabled. | false | true (ByPropertyName) | False | ||
| Cache tiering activity is suspended. | false | true (ByPropertyName) | False | ||
| OSDs are not allowed to start. | false | true (ByPropertyName) | False | ||
| Pauses read and writes. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterCephFlagsIdx
Set or clear (unset) a specific ceph flag
Syntax
Set-PveClusterCephFlagsIdx [[-PveTicket] <PveTicket>] [-Flag] <String> -Value [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The ceph flag to update Enum: nobackfill,nodeep-scrub,nodown,noin,noout,norebalance,norecover,noscrub,notieragent,noup,pause | true | true (ByPropertyName) | |||
| The new value of the flag | true | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterFirewallAliases
Update IP or Network alias.
Syntax
Set-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [[-Rename] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Alias name. | true | true (ByPropertyName) | |||
| Rename an existing alias. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterFirewallGroups
Modify rule data.
Syntax
Set-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [-Group] <String> [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. | false | true (ByPropertyName) | |||
| Descriptive comment. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| 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) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| 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) | |||
| Flag to enable/disable a rule. | false | true (ByPropertyName) | 0 | ||
| Security Group name. | true | true (ByPropertyName) | |||
| Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. | false | true (ByPropertyName) | |||
| 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 level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Use predefined standard macro. | false | true (ByPropertyName) | |||
| Move rule to new position <moveto>. Other arguments are ignored. | false | true (ByPropertyName) | 0 | ||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 | ||
| IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. | false | true (ByPropertyName) | |||
| 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) | |||
| 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) | |||
| Rule type. Enum: in,out,group | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterFirewallIpset
Update IP or Network settings
Syntax
Set-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Nomatch] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterFirewallOptions
Set Firewall options.
Syntax
Set-PveClusterFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Ebtables] [[-Enable] <Int32>] [[-LogRatelimit] <String>] [[-PolicyIn] <String>] [[-PolicyOut] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Enable ebtables rules cluster wide. | false | true (ByPropertyName) | False | ||
| Enable or disable the firewall cluster wide. | false | true (ByPropertyName) | 0 | ||
| Log ratelimiting settings | false | true (ByPropertyName) | |||
| Input policy. Enum: ACCEPT,REJECT,DROP | false | true (ByPropertyName) | |||
| Output policy. Enum: ACCEPT,REJECT,DROP | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterFirewallRules
Modify rule data.
Syntax
Set-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. | false | true (ByPropertyName) | |||
| Descriptive comment. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| 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) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| 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) | |||
| Flag to enable/disable a rule. | false | true (ByPropertyName) | 0 | ||
| Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. | false | true (ByPropertyName) | |||
| 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 level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Use predefined standard macro. | false | true (ByPropertyName) | |||
| Move rule to new position <moveto>. Other arguments are ignored. | false | true (ByPropertyName) | 0 | ||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 | ||
| IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. | false | true (ByPropertyName) | |||
| 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) | |||
| 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) | |||
| Rule type. Enum: in,out,group | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterHaGroups
Update ha group configuration.
Syntax
Set-PveClusterHaGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Group] <String> [[-Nodes] <String>] [-Nofailback] [-Restricted] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Description. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| The HA group identifier. | true | true (ByPropertyName) | |||
| List of cluster node names with optional priority. | false | true (ByPropertyName) | |||
| 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 | ||
| Resources bound to restricted groups may only run on nodes defined by the group. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterHaResources
Update resource configuration.
Syntax
Set-PveClusterHaResources [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [[-Digest] <String>] [[-Group] <String>] [[-MaxRelocate] <Int32>] [[-MaxRestart] <Int32>] [-Sid] <String> [[-State] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Description. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| The HA group identifier. | false | true (ByPropertyName) | |||
| Maximal number of service relocate tries when a service failes to start. | false | true (ByPropertyName) | 0 | ||
| Maximal number of tries to restart the service on a node after its start failed. | false | true (ByPropertyName) | 0 | ||
| 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) | |||
| Requested resource state. Enum: started,stopped,enabled,disabled,ignored | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterJobsRealmSync
Update realm-sync job definition.
Syntax
Set-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [-EnableNew] [-Enabled] [-Id] <String> [[-RemoveVanished] <String>] [-Schedule] <String> [[-Scope] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Description for the Job. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Enable newly synced users immediately. | false | true (ByPropertyName) | False | ||
| Determines if the job is enabled. | false | true (ByPropertyName) | False | ||
| The ID of the job. | true | true (ByPropertyName) | |||
| A semicolon-seperated list of things to remove when they or the user vanishes during a sync. The following values are possible':' 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default). | false | true (ByPropertyName) | |||
| Backup schedule. The format is a subset of `systemd` calendar events. | true | true (ByPropertyName) | |||
| Select what to sync. Enum: users,groups,both | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterMappingPci
Update a hardware mapping.
Syntax
Set-PveClusterMappingPci [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [-Id] <String> [[-Map] <Array>] [-Mdev] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Description of the logical PCI device. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| The ID of the logical PCI mapping. | true | true (ByPropertyName) | |||
| A list of maps for the cluster nodes. | false | true (ByPropertyName) | |||
| Marks the device(s) as being capable of providing mediated devices. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterMappingUsb
Update a hardware mapping.
Syntax
Set-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [-Id] <String> [-Map] <Array> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Description of the logical USB device. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| The ID of the logical USB mapping. | true | true (ByPropertyName) | |||
| 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.
Set-PveClusterMetricsServer
Update metric server configuration.
Syntax
Set-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [[-ApiPathPrefix] <String>] [[-Bucket] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [-Id] <String> [[-Influxdbproto] <String>] [[-MaxBodySize] <Int32>] [[-Mtu] <Int32>] [[-Organization] <String>] [[-Path] <String>] [-Port] <Int32> [[-Proto] <String>] [-Server] <String> [[-Timeout] <Int32>] [[-Token] <String>] [-VerifyCertificate] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| 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) | |||
| The InfluxDB bucket/db. Only necessary when using the http v2 api. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Flag to disable the plugin. | false | true (ByPropertyName) | False | ||
| The ID of the entry. | true | true (ByPropertyName) | |||
| -- Enum: udp,http,https | false | true (ByPropertyName) | |||
| InfluxDB max-body-size in bytes. Requests are batched up to this size. | false | true (ByPropertyName) | 0 | ||
| MTU for metrics transmission over UDP | false | true (ByPropertyName) | 0 | ||
| The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api. | false | true (ByPropertyName) | |||
| root graphite path (ex':' proxmox.mycluster.mykey) | false | true (ByPropertyName) | |||
| server network port | true | true (ByPropertyName) | 0 | ||
| Protocol to send graphite data. TCP or UDP (default) Enum: udp,tcp | false | true (ByPropertyName) | |||
| server dns name or IP address | true | true (ByPropertyName) | |||
| graphite TCP socket timeout (default=1) | false | true (ByPropertyName) | 0 | ||
| 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) | |||
| 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.
Set-PveClusterNotificationsEndpointsGotify
Update existing gotify endpoint
Syntax
Set-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [-Name] <String> [[-Server] <String>] [[-Token] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Comment | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Disable this target | false | true (ByPropertyName) | False | ||
| The name of the endpoint. | true | true (ByPropertyName) | |||
| Server URL | false | true (ByPropertyName) | |||
| Secret token | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterNotificationsEndpointsSendmail
Update existing sendmail endpoint
Syntax
Set-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [[-Author] <String>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [[-FromAddress] <String>] [[-Mailto] <Array>] [[-MailtoUser] <Array>] [-Name] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Author of the mail | false | true (ByPropertyName) | |||
| Comment | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Disable this target | false | true (ByPropertyName) | False | ||
| `From` address for the mail | false | true (ByPropertyName) | |||
| List of email recipients | false | true (ByPropertyName) | |||
| List of users | false | true (ByPropertyName) | |||
| 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.
Set-PveClusterNotificationsEndpointsSmtp
Update existing smtp endpoint
Syntax
Set-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [[-Author] <String>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [[-FromAddress] <String>] [[-Mailto] <Array>] [[-MailtoUser] <Array>] [[-Mode] <String>] [-Name] <String> [[-Password] <SecureString>] [[-Port] <Int32>] [[-Server] <String>] [[-Username] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Author of the mail. Defaults to 'Proxmox VE'. | false | true (ByPropertyName) | |||
| Comment | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Disable this target | false | true (ByPropertyName) | False | ||
| `From` address for the mail | false | true (ByPropertyName) | |||
| List of email recipients | false | true (ByPropertyName) | |||
| List of users | false | true (ByPropertyName) | |||
| Determine which encryption method shall be used for the connection. Enum: insecure,starttls,tls | false | true (ByPropertyName) | |||
| The name of the endpoint. | true | true (ByPropertyName) | |||
| Password for SMTP authentication | false | true (ByPropertyName) | |||
| The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections. | false | true (ByPropertyName) | 0 | ||
| The address of the SMTP server. | false | true (ByPropertyName) | |||
| Username for SMTP authentication | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterNotificationsMatchers
Update existing matcher
Syntax
Set-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [-InvertMatch] [[-MatchCalendar] <Array>] [[-MatchField] <Array>] [[-MatchSeverity] <Array>] [[-Mode] <String>] [-Name] <String> [[-Target] <Array>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Comment | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Disable this matcher | false | true (ByPropertyName) | False | ||
| Invert match of the whole matcher | false | true (ByPropertyName) | False | ||
| Match notification timestamp | false | true (ByPropertyName) | |||
| Metadata fields to match (regex or exact match). Must be in the form (regex|exact)':'<field>=<value> | false | true (ByPropertyName) | |||
| Notification severities to match | false | true (ByPropertyName) | |||
| Choose between 'all' and 'any' for when multiple properties are specified Enum: all,any | false | true (ByPropertyName) | |||
| Name of the matcher. | true | true (ByPropertyName) | |||
| Targets to notify on match | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterOptions
Set datacenter options.
Syntax
Set-PveClusterOptions [[-PveTicket] <PveTicket>] [[-Bwlimit] <String>] [[-Console] <String>] [[-Crs] <String>] [[-Delete] <String>] [[-Description] <String>] [[-EmailFrom] <String>] [[-Fencing] <String>] [[-Ha] <String>] [[-HttpProxy] <String>] [[-Keyboard] <String>] [[-Language] <String>] [[-MacPrefix] <String>] [[-MaxWorkers] <Int32>] [[-Migration] <String>] [-MigrationUnsecure] [[-NextId] <String>] [[-Notify] <String>] [[-RegisteredTags] <String>] [[-TagStyle] <String>] [[-U2f] <String>] [[-UserTagAccess] <String>] [[-Webauthn] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Set I/O bandwidth limit for various operations (in KiB/s). | false | true (ByPropertyName) | |||
| Select the default Console viewer. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer comtatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC. Enum: applet,vv,html5,xtermjs | false | true (ByPropertyName) | |||
| Cluster resource scheduling settings. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file. | false | true (ByPropertyName) | |||
| Specify email address to send notification from (default is root@$hostname) | false | true (ByPropertyName) | |||
| Set the fencing mode of the HA cluster. Hardware mode needs a valid configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two modes are used.WARNING':' 'hardware' and 'both' are EXPERIMENTAL & WIP Enum: watchdog,hardware,both | false | true (ByPropertyName) | |||
| Cluster wide HA settings. | false | true (ByPropertyName) | |||
| Specify external http proxy which is used for downloads (example':' 'http':'//username':'password@host':'port/') | false | true (ByPropertyName) | |||
| Default keybord layout for vnc server. Enum: de,de-ch,da,en-gb,en-us,es,fi,fr,fr-be,fr-ca,fr-ch,hu,is,it,ja,lt,mk,nl,no,pl,pt,pt-br,sv,sl,tr | false | true (ByPropertyName) | |||
| Default GUI language. Enum: ar,ca,da,de,en,es,eu,fa,fr,hr,he,it,ja,ka,kr,nb,nl,nn,pl,pt_BR,ru,sl,sv,tr,ukr,zh_CN,zh_TW | false | true (ByPropertyName) | |||
| Prefix for the auto-generated MAC addresses of virtual guests. The default 'BC':'24':'11' is the OUI assigned by the IEEE to Proxmox Server Solutions GmbH for a 24-bit large MAC block. You're allowed to use this in local networks, i.e., those not directly reachable by the public (e.g., in a LAN or behind NAT). | false | true (ByPropertyName) | |||
| Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager. | false | true (ByPropertyName) | 0 | ||
| For cluster wide migration settings. | false | true (ByPropertyName) | |||
| Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration. Deprecated, use the 'migration' property instead! | false | true (ByPropertyName) | False | ||
| Control the range for the free VMID auto-selection pool. | false | true (ByPropertyName) | |||
| Cluster-wide notification settings. | false | true (ByPropertyName) | |||
| A list of tags that require a `Sys.Modify` on '/' to set and delete. Tags set here that are also in 'user-tag-access' also require `Sys.Modify`. | false | true (ByPropertyName) | |||
| Tag style options. | false | true (ByPropertyName) | |||
| u2f | false | true (ByPropertyName) | |||
| Privilege options for user-settable tags | false | true (ByPropertyName) | |||
| webauthn configuration | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterReplication
Update replication job configuration.
Syntax
Set-PveClusterReplication [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [-Id] <String> [[-Rate] <Single>] [[-RemoveJob] <String>] [[-Schedule] <String>] [[-Source] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Description. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Flag to disable/deactivate the entry. | false | true (ByPropertyName) | False | ||
| Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'. | true | true (ByPropertyName) | |||
| Rate limit in mbps (megabytes per second) as floating point number. | false | true (ByPropertyName) | 0 | ||
| Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. Enum: local,full | false | true (ByPropertyName) | |||
| Storage replication schedule. The format is a subset of `systemd` calendar events. | false | true (ByPropertyName) | |||
| For internal use, to detect if the guest was stolen. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterSdn
Apply sdn controller changes && reload.
Syntax
Set-PveClusterSdn [[-PveTicket] <PveTicket>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterSdnControllers
Update sdn controller object configuration.
Syntax
Set-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [[-Asn] <Int32>] [-BgpMultipathAsPathRelax] [-Controller] <String> [[-Delete] <String>] [[-Digest] <String>] [-Ebgp] [[-EbgpMultihop] <Int32>] [[-IsisDomain] <String>] [[-IsisIfaces] <String>] [[-IsisNet] <String>] [[-Loopback] <String>] [[-Node] <String>] [[-Peers] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| autonomous system number | false | true (ByPropertyName) | 0 | ||
| -- | false | true (ByPropertyName) | False | ||
| The SDN controller object identifier. | true | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Enable ebgp. (remote-as external) | false | true (ByPropertyName) | False | ||
| -- | false | true (ByPropertyName) | 0 | ||
| ISIS domain. | false | true (ByPropertyName) | |||
| ISIS interface. | false | true (ByPropertyName) | |||
| ISIS network entity title. | false | true (ByPropertyName) | |||
| source loopback interface. | false | true (ByPropertyName) | |||
| The cluster node name. | false | true (ByPropertyName) | |||
| peers address list. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterSdnDns
Update sdn dns object configuration.
Syntax
Set-PveClusterSdnDns [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Dns] <String> [[-Key] <String>] [[-Reversemaskv6] <Int32>] [[-Ttl] <Int32>] [[-Url] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| The SDN dns object identifier. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| -- | false | true (ByPropertyName) | 0 | ||
| -- | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterSdnIpams
Update sdn ipam object configuration.
Syntax
Set-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Ipam] <String> [[-Section] <Int32>] [[-Token] <String>] [[-Url] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| The SDN ipam object identifier. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | 0 | ||
| -- | false | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterSdnVnets
Update sdn vnet object configuration.
Syntax
Set-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [[-Alias] <String>] [[-Delete] <String>] [[-Digest] <String>] [[-Tag] <Int32>] [-Vlanaware] [-Vnet] <String> [[-Zone] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| alias name of the vnet | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| vlan or vxlan id | false | true (ByPropertyName) | 0 | ||
| Allow vm VLANs to pass through this vnet. | false | true (ByPropertyName) | False | ||
| The SDN vnet object identifier. | true | true (ByPropertyName) | |||
| zone id | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterSdnVnetsIps
Update IP Mapping in a VNet
Syntax
Set-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [[-Vmid] <Int32>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The IP address to associate with the given MAC address | true | true (ByPropertyName) | |||
| Unicast MAC address. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | false | true (ByPropertyName) | 0 | ||
| The SDN vnet object identifier. | true | true (ByPropertyName) | |||
| The SDN zone object identifier. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterSdnVnetsSubnets
Update sdn subnet object configuration.
Syntax
Set-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-DhcpDnsServer] <String>] [[-DhcpRange] <Array>] [[-Digest] <String>] [[-Dnszoneprefix] <String>] [[-Gateway] <String>] [-Snat] [-Subnet] <String> [[-Vnet] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| IP address for the DNS server | false | true (ByPropertyName) | |||
| A list of DHCP ranges for this subnet | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| dns domain zone prefix ex':' 'adm' -> <hostname>.adm.mydomain.com | false | true (ByPropertyName) | |||
| Subnet Gateway':' Will be assign on vnet for layer3 zones | false | true (ByPropertyName) | |||
| enable masquerade for this subnet if pve-firewall | false | true (ByPropertyName) | False | ||
| The SDN subnet object identifier. | true | true (ByPropertyName) | |||
| associated vnet | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveClusterSdnZones
Update sdn zone object configuration.
Syntax
Set-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-AdvertiseSubnets] [[-Bridge] <String>] [-BridgeDisableMacLearning] [[-Controller] <String>] [[-Delete] <String>] [[-Dhcp] <String>] [[-Digest] <String>] [-DisableArpNdSuppression] [[-Dns] <String>] [[-Dnszone] <String>] [[-DpId] <Int32>] [[-Exitnodes] <String>] [-ExitnodesLocalRouting] [[-ExitnodesPrimary] <String>] [[-Ipam] <String>] [[-Mac] <String>] [[-Mtu] <Int32>] [[-Nodes] <String>] [[-Peers] <String>] [[-Reversedns] <String>] [[-RtImport] <String>] [[-Tag] <Int32>] [[-VlanProtocol] <String>] [[-VrfVxlan] <Int32>] [[-VxlanPort] <Int32>] [-Zone] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Advertise evpn subnets if you have silent hosts | false | true (ByPropertyName) | False | ||
| -- | false | true (ByPropertyName) | |||
| Disable auto mac learning. | false | true (ByPropertyName) | False | ||
| Frr router name | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Type of the DHCP backend for this zone Enum: dnsmasq | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Disable ipv4 arp && ipv6 neighbour discovery suppression | false | true (ByPropertyName) | False | ||
| dns api server | false | true (ByPropertyName) | |||
| dns domain zone ex':' mydomain.com | false | true (ByPropertyName) | |||
| Faucet dataplane id | false | true (ByPropertyName) | 0 | ||
| List of cluster node names. | false | true (ByPropertyName) | |||
| Allow exitnodes to connect to evpn guests | false | true (ByPropertyName) | False | ||
| Force traffic to this exitnode first. | false | true (ByPropertyName) | |||
| use a specific ipam | false | true (ByPropertyName) | |||
| Anycast logical router mac address | false | true (ByPropertyName) | |||
| MTU | false | true (ByPropertyName) | 0 | ||
| List of cluster node names. | false | true (ByPropertyName) | |||
| peers address list. | false | true (ByPropertyName) | |||
| reverse dns api server | false | true (ByPropertyName) | |||
| Route-Target import | false | true (ByPropertyName) | |||
| Service-VLAN Tag | false | true (ByPropertyName) | 0 | ||
| -- Enum: 802.1q,802.1ad | false | true (ByPropertyName) | |||
| l3vni. | false | true (ByPropertyName) | 0 | ||
| Vxlan tunnel udp port (default 4789). | false | true (ByPropertyName) | 0 | ||
| 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.
Set-PveNodesAptRepositories
Add a standard repository to the configuration
Syntax
Set-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Handle] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Digest to detect modifications. | false | true (ByPropertyName) | |||
| Handle that identifies a repository. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesCephPool
Change POOL settings
Syntax
Set-PveNodesCephPool [[-PveTicket] <PveTicket>] [[-Application] <String>] [[-CrushRule] <String>] [[-MinSize] <Int32>] [-Name] <String> [-Node] <String> [[-PgAutoscaleMode] <String>] [[-PgNum] <Int32>] [[-PgNumMin] <Int32>] [[-Size] <Int32>] [[-TargetSize] <String>] [[-TargetSizeRatio] <Single>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The application of the pool. Enum: rbd,cephfs,rgw | false | true (ByPropertyName) | |||
| The rule to use for mapping object placement in the cluster. | false | true (ByPropertyName) | |||
| Minimum number of replicas per object | false | true (ByPropertyName) | 0 | ||
| The name of the pool. It must be unique. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The automatic PG scaling mode of the pool. Enum: on,off,warn | false | true (ByPropertyName) | |||
| Number of placement groups. | false | true (ByPropertyName) | 0 | ||
| Minimal number of placement groups. | false | true (ByPropertyName) | 0 | ||
| Number of replicas per object | false | true (ByPropertyName) | 0 | ||
| The estimated target size of the pool for the PG autoscaler. | false | true (ByPropertyName) | |||
| The estimated target ratio of the pool for the PG autoscaler. | false | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesCertificatesAcmeCertificate
Renew existing certificate from CA.
Syntax
Set-PveNodesCertificatesAcmeCertificate [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Force renewal even if expiry is more than 30 days away. | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesConfig
Set node configuration options.
Syntax
Set-PveNodesConfig [[-PveTicket] <PveTicket>] [[-Acme] <String>] [[-AcmedomainN] <Hashtable>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [-Node] <String> [[-StartallOnbootDelay] <Int32>] [[-Wakeonlan] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Node specific ACME settings. | false | true (ByPropertyName) | |||
| ACME domain and validation plugin | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled. | false | true (ByPropertyName) | 0 | ||
| Node specific wake on LAN settings. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesDisksWipedisk
Wipe a disk or partition.
Syntax
Set-PveNodesDisksWipedisk [[-PveTicket] <PveTicket>] [-Disk] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Block device name | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesDns
Write DNS settings.
Syntax
Set-PveNodesDns [[-PveTicket] <PveTicket>] [[-Dns1] <String>] [[-Dns2] <String>] [[-Dns3] <String>] [-Node] <String> [-Search] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| First name server IP address. | false | true (ByPropertyName) | |||
| Second name server IP address. | false | true (ByPropertyName) | |||
| Third name server IP address. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Search domain for host-name lookup. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesFirewallOptions
Set Firewall options.
Syntax
Set-PveNodesFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Enable] [[-LogLevelIn] <String>] [[-LogLevelOut] <String>] [-LogNfConntrack] [-Ndp] [-NfConntrackAllowInvalid] [[-NfConntrackHelpers] <String>] [[-NfConntrackMax] <Int32>] [[-NfConntrackTcpTimeoutEstablished] <Int32>] [[-NfConntrackTcpTimeoutSynRecv] <Int32>] [-Nftables] [-Node] <String> [-Nosmurfs] [-ProtectionSynflood] [[-ProtectionSynfloodBurst] <Int32>] [[-ProtectionSynfloodRate] <Int32>] [[-SmurfLogLevel] <String>] [[-TcpFlagsLogLevel] <String>] [-Tcpflags] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Enable host firewall rules. | false | true (ByPropertyName) | False | ||
| Log level for incoming traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Log level for outgoing traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Enable logging of conntrack information. | false | true (ByPropertyName) | False | ||
| Enable NDP (Neighbor Discovery Protocol). | false | true (ByPropertyName) | False | ||
| Allow invalid packets on connection tracking. | false | true (ByPropertyName) | False | ||
| Enable conntrack helpers for specific protocols. Supported protocols':' amanda, ftp, irc, netbios-ns, pptp, sane, sip, snmp, tftp | false | true (ByPropertyName) | |||
| Maximum number of tracked connections. | false | true (ByPropertyName) | 0 | ||
| Conntrack established timeout. | false | true (ByPropertyName) | 0 | ||
| Conntrack syn recv timeout. | false | true (ByPropertyName) | 0 | ||
| Enable nftables based firewall (tech preview) | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Enable SMURFS filter. | false | true (ByPropertyName) | False | ||
| Enable synflood protection | false | true (ByPropertyName) | False | ||
| Synflood protection rate burst by ip src. | false | true (ByPropertyName) | 0 | ||
| Synflood protection rate syn/sec by ip src. | false | true (ByPropertyName) | 0 | ||
| Log level for SMURFS filter. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Log level for illegal tcp flags filter. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Filter illegal combinations of TCP flags. | false | true (ByPropertyName) | False |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesFirewallRules
Modify rule data.
Syntax
Set-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. | false | true (ByPropertyName) | |||
| Descriptive comment. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| 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) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| 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) | |||
| Flag to enable/disable a rule. | false | true (ByPropertyName) | 0 | ||
| Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. | false | true (ByPropertyName) | |||
| 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 level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Use predefined standard macro. | false | true (ByPropertyName) | |||
| Move rule to new position <moveto>. Other arguments are ignored. | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 | ||
| IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. | false | true (ByPropertyName) | |||
| 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) | |||
| 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) | |||
| Rule type. Enum: in,out,group | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesLxcConfig
Set container options.
Syntax
Set-PveNodesLxcConfig [[-PveTicket] <PveTicket>] [[-Arch] <String>] [[-Cmode] <String>] [-Console] [[-Cores] <Int32>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [-Debug_] [[-Delete] <String>] [[-Description] <String>] [[-DevN] <Hashtable>] [[-Digest] <String>] [[-Features] <String>] [[-Hookscript] <String>] [[-Hostname] <String>] [[-Lock] <String>] [[-Memory] <Int32>] [[-MpN] <Hashtable>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Onboot] [[-Ostype] <String>] [-Protection] [[-Revert] <String>] [[-Rootfs] <String>] [[-Searchdomain] <String>] [[-Startup] <String>] [[-Swap] <Int32>] [[-Tags] <String>] [-Template] [[-Timezone] <String>] [[-Tty] <Int32>] [-Unprivileged] [[-UnusedN] <Hashtable>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| OS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64 | false | true (ByPropertyName) | |||
| Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). Enum: shell,console,tty | false | true (ByPropertyName) | |||
| Attach a console device (/dev/console) to the container. | false | true (ByPropertyName) | False | ||
| The number of cores assigned to the container. A container can use all available cores by default. | false | true (ByPropertyName) | 0 | ||
| Limit of CPU usage.NOTE':' If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. | false | true (ByPropertyName) | 0 | ||
| CPU weight for a container, will be clamped to \[1, 10000] in cgroup v2. | false | true (ByPropertyName) | 0 | ||
| Try to be more verbose. For now this only enables debug log-level on start. | false | true (ByPropertyName) | False | ||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. | false | true (ByPropertyName) | |||
| Device to pass through to the container | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Allow containers access to advanced features. | false | true (ByPropertyName) | |||
| Script that will be exectued during various steps in the containers lifetime. | false | true (ByPropertyName) | |||
| Set a host name for the container. | false | true (ByPropertyName) | |||
| Lock/unlock the container. Enum: backup,create,destroyed,disk,fstrim,migrate,mounted,rollback,snapshot,snapshot-delete | false | true (ByPropertyName) | |||
| Amount of RAM for the container in MB. | false | true (ByPropertyName) | 0 | ||
| Use volume as container mount point. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. | false | true (ByPropertyName) | |||
| Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. | false | true (ByPropertyName) | |||
| Specifies network interfaces for the container. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Specifies whether a container will be started during system bootup. | false | true (ByPropertyName) | False | ||
| OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. Enum: debian,devuan,ubuntu,centos,fedora,opensuse,archlinux,alpine,gentoo,nixos,unmanaged | false | true (ByPropertyName) | |||
| Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. | false | true (ByPropertyName) | False | ||
| Revert a pending change. | false | true (ByPropertyName) | |||
| Use volume as container root. | false | true (ByPropertyName) | |||
| Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. | false | true (ByPropertyName) | |||
| Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. | false | true (ByPropertyName) | |||
| Amount of SWAP for the container in MB. | false | true (ByPropertyName) | 0 | ||
| Tags of the Container. This is only meta information. | false | true (ByPropertyName) | |||
| Enable/disable Template. | false | true (ByPropertyName) | False | ||
| Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab | false | true (ByPropertyName) | |||
| Specify the number of tty available to the container | false | true (ByPropertyName) | 0 | ||
| Makes the container run as unprivileged user. (Should not be modified manually.) | false | true (ByPropertyName) | False | ||
| Reference to unused volumes. This is used internally, and should not be modified manually. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesLxcFirewallAliases
Update IP or Network alias.
Syntax
Set-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Alias name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Rename an existing alias. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesLxcFirewallIpset
Update IP or Network settings
Syntax
Set-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | False | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesLxcFirewallOptions
Set Firewall options.
Syntax
Set-PveNodesLxcFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [-Dhcp] [[-Digest] <String>] [-Enable] [-Ipfilter] [[-LogLevelIn] <String>] [[-LogLevelOut] <String>] [-Macfilter] [-Ndp] [-Node] <String> [[-PolicyIn] <String>] [[-PolicyOut] <String>] [-Radv] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Enable DHCP. | false | true (ByPropertyName) | False | ||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Enable/disable firewall rules. | false | true (ByPropertyName) | False | ||
| Enable default IP filters. This is equivalent to adding an empty ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added. | false | true (ByPropertyName) | False | ||
| Log level for incoming traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Log level for outgoing traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Enable/disable MAC address filter. | false | true (ByPropertyName) | False | ||
| Enable NDP (Neighbor Discovery Protocol). | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Input policy. Enum: ACCEPT,REJECT,DROP | false | true (ByPropertyName) | |||
| Output policy. Enum: ACCEPT,REJECT,DROP | false | true (ByPropertyName) | |||
| Allow sending Router Advertisement. | false | true (ByPropertyName) | False | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesLxcFirewallRules
Modify rule data.
Syntax
Set-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. | false | true (ByPropertyName) | |||
| Descriptive comment. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| 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) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| 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) | |||
| Flag to enable/disable a rule. | false | true (ByPropertyName) | 0 | ||
| Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. | false | true (ByPropertyName) | |||
| 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 level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Use predefined standard macro. | false | true (ByPropertyName) | |||
| Move rule to new position <moveto>. Other arguments are ignored. | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 | ||
| IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. | false | true (ByPropertyName) | |||
| 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) | |||
| 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) | |||
| Rule type. Enum: in,out,group | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesLxcResize
Resize a container mount point.
Syntax
Set-PveNodesLxcResize [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Disk] <String> [-Node] <String> [-Size] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| The disk you want to resize. Enum: rootfs,mp0,mp1,mp2,mp3,mp4,mp5,mp6,mp7,mp8,mp9,mp10,mp11,mp12,mp13,mp14,mp15,mp16,mp17,mp18,mp19,mp20,mp21,mp22,mp23,mp24,mp25,mp26,mp27,mp28,mp29,mp30,mp31,mp32,mp33,mp34,mp35,mp36,mp37,mp38,mp39,mp40,mp41,mp42,mp43,mp44,mp45,mp46,mp47,mp48,mp49,mp50,mp51,mp52,mp53,mp54,mp55,mp56,mp57,mp58,mp59,mp60,mp61,mp62,mp63,mp64,mp65,mp66,mp67,mp68,mp69,mp70,mp71,mp72,mp73,mp74,mp75,mp76,mp77,mp78,mp79,mp80,mp81,mp82,mp83,mp84,mp85,mp86,mp87,mp88,mp89,mp90,mp91,mp92,mp93,mp94,mp95,mp96,mp97,mp98,mp99,mp100,mp101,mp102,mp103,mp104,mp105,mp106,mp107,mp108,mp109,mp110,mp111,mp112,mp113,mp114,mp115,mp116,mp117,mp118,mp119,mp120,mp121,mp122,mp123,mp124,mp125,mp126,mp127,mp128,mp129,mp130,mp131,mp132,mp133,mp134,mp135,mp136,mp137,mp138,mp139,mp140,mp141,mp142,mp143,mp144,mp145,mp146,mp147,mp148,mp149,mp150,mp151,mp152,mp153,mp154,mp155,mp156,mp157,mp158,mp159,mp160,mp161,mp162,mp163,mp164,mp165,mp166,mp167,mp168,mp169,mp170,mp171,mp172,mp173,mp174,mp175,mp176,mp177,mp178,mp179,mp180,mp181,mp182,mp183,mp184,mp185,mp186,mp187,mp188,mp189,mp190,mp191,mp192,mp193,mp194,mp195,mp196,mp197,mp198,mp199,mp200,mp201,mp202,mp203,mp204,mp205,mp206,mp207,mp208,mp209,mp210,mp211,mp212,mp213,mp214,mp215,mp216,mp217,mp218,mp219,mp220,mp221,mp222,mp223,mp224,mp225,mp226,mp227,mp228,mp229,mp230,mp231,mp232,mp233,mp234,mp235,mp236,mp237,mp238,mp239,mp240,mp241,mp242,mp243,mp244,mp245,mp246,mp247,mp248,mp249,mp250,mp251,mp252,mp253,mp254,mp255 | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesLxcSnapshotConfig
Update snapshot metadata.
Syntax
Set-PveNodesLxcSnapshotConfig [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A textual description or comment. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesNetwork
Reload network configuration
Syntax
Set-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesNetworkIdx
Update network device configuration
Syntax
Set-PveNodesNetworkIdx [[-PveTicket] <PveTicket>] [[-Address] <String>] [[-Address6] <String>] [-Autostart] [[-BondPrimary] <String>] [[-BondMode] <String>] [[-BondXmitHashPolicy] <String>] [[-BridgePorts] <String>] [-BridgeVlanAware] [[-Cidr] <String>] [[-Cidr6] <String>] [[-Comments] <String>] [[-Comments6] <String>] [[-Delete] <String>] [[-Gateway] <String>] [[-Gateway6] <String>] [-Iface] <String> [[-Mtu] <Int32>] [[-Netmask] <String>] [[-Netmask6] <Int32>] [-Node] <String> [[-OvsBonds] <String>] [[-OvsBridge] <String>] [[-OvsOptions] <String>] [[-OvsPorts] <String>] [[-OvsTag] <Int32>] [[-Slaves] <String>] [-Type] <String> [[-VlanId] <Int32>] [[-VlanRawDevice] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| IP address. | false | true (ByPropertyName) | |||
| IP address. | false | true (ByPropertyName) | |||
| Automatically start interface on boot. | false | true (ByPropertyName) | False | ||
| Specify the primary interface for active-backup bond. | false | true (ByPropertyName) | |||
| Bonding mode. Enum: balance-rr,active-backup,balance-xor,broadcast,802.3ad,balance-tlb,balance-alb,balance-slb,lacp-balance-slb,lacp-balance-tcp | false | true (ByPropertyName) | |||
| Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. Enum: layer2,layer2+3,layer3+4 | false | true (ByPropertyName) | |||
| Specify the interfaces you want to add to your bridge. | false | true (ByPropertyName) | |||
| Enable bridge vlan support. | false | true (ByPropertyName) | False | ||
| IPv4 CIDR. | false | true (ByPropertyName) | |||
| IPv6 CIDR. | false | true (ByPropertyName) | |||
| Comments | false | true (ByPropertyName) | |||
| Comments | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Default gateway address. | false | true (ByPropertyName) | |||
| Default ipv6 gateway address. | false | true (ByPropertyName) | |||
| Network interface name. | true | true (ByPropertyName) | |||
| MTU. | false | true (ByPropertyName) | 0 | ||
| Network mask. | false | true (ByPropertyName) | |||
| Network mask. | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Specify the interfaces used by the bonding device. | false | true (ByPropertyName) | |||
| The OVS bridge associated with a OVS port. This is required when you create an OVS port. | false | true (ByPropertyName) | |||
| OVS interface options. | false | true (ByPropertyName) | |||
| Specify the interfaces you want to add to your bridge. | false | true (ByPropertyName) | |||
| Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond) | false | true (ByPropertyName) | 0 | ||
| Specify the interfaces used by the bonding device. | false | true (ByPropertyName) | |||
| Network interface type Enum: bridge,bond,eth,alias,vlan,OVSBridge,OVSBond,OVSPort,OVSIntPort,unknown | true | true (ByPropertyName) | |||
| vlan-id for a custom named vlan interface (ifupdown2 only). | false | true (ByPropertyName) | 0 | ||
| Specify the raw interface for the vlan interface. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesQemuCloudinit
Regenerate and change cloudinit config drive.
Syntax
Set-PveNodesQemuCloudinit [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesQemuConfig
Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation.
Syntax
Set-PveNodesQemuConfig [[-PveTicket] <PveTicket>] [-Acpi] [[-Affinity] <String>] [[-Agent] <String>] [[-Arch] <String>] [[-Args_] <String>] [[-Audio0] <String>] [-Autostart] [[-Balloon] <Int32>] [[-Bios] <String>] [[-Boot] <String>] [[-Bootdisk] <String>] [[-Cdrom] <String>] [[-Cicustom] <String>] [[-Cipassword] <SecureString>] [[-Citype] <String>] [-Ciupgrade] [[-Ciuser] <String>] [[-Cores] <Int32>] [[-Cpu] <String>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [[-Efidisk0] <String>] [-Force] [-Freeze] [[-Hookscript] <String>] [[-HostpciN] <Hashtable>] [[-Hotplug] <String>] [[-Hugepages] <String>] [[-IdeN] <Hashtable>] [[-IpconfigN] <Hashtable>] [[-Ivshmem] <String>] [-Keephugepages] [[-Keyboard] <String>] [-Kvm] [-Localtime] [[-Lock] <String>] [[-Machine] <String>] [[-Memory] <String>] [[-MigrateDowntime] <Single>] [[-MigrateSpeed] <Int32>] [[-Name] <String>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Numa] [[-NumaN] <Hashtable>] [-Onboot] [[-Ostype] <String>] [[-ParallelN] <Hashtable>] [-Protection] [-Reboot] [[-Revert] <String>] [[-Rng0] <String>] [[-SataN] <Hashtable>] [[-ScsiN] <Hashtable>] [[-Scsihw] <String>] [[-Searchdomain] <String>] [[-SerialN] <Hashtable>] [[-Shares] <Int32>] [-Skiplock] [[-Smbios1] <String>] [[-Smp] <Int32>] [[-Sockets] <Int32>] [[-SpiceEnhancements] <String>] [[-Sshkeys] <String>] [[-Startdate] <String>] [[-Startup] <String>] [-Tablet] [[-Tags] <String>] [-Tdf] [-Template] [[-Tpmstate0] <String>] [[-UnusedN] <Hashtable>] [[-UsbN] <Hashtable>] [[-Vcpus] <Int32>] [[-Vga] <String>] [[-VirtioN] <Hashtable>] [[-Vmgenid] <String>] [-Vmid] <Int32> [[-Vmstatestorage] <String>] [[-Watchdog] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Enable/disable ACPI. | false | true (ByPropertyName) | False | ||
| List of host cores used to execute guest processes, for example':' 0,5,8-11 | false | true (ByPropertyName) | |||
| Enable/disable communication with the QEMU Guest Agent and its properties. | false | true (ByPropertyName) | |||
| Virtual processor architecture. Defaults to the host. Enum: x86_64,aarch64 | false | true (ByPropertyName) | |||
| Arbitrary arguments passed to kvm. | false | true (ByPropertyName) | |||
| Configure a audio device, useful in combination with QXL/Spice. | false | true (ByPropertyName) | |||
| Automatic restart after crash (currently ignored). | false | true (ByPropertyName) | False | ||
| Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. | false | true (ByPropertyName) | 0 | ||
| Select BIOS implementation. Enum: seabios,ovmf | false | true (ByPropertyName) | |||
| Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. | false | true (ByPropertyName) | |||
| Enable booting from specified disk. Deprecated':' Use 'boot':' order=foo;bar' instead. | false | true (ByPropertyName) | |||
| This is an alias for option -ide2 | false | true (ByPropertyName) | |||
| cloud-init':' Specify custom files to replace the automatically generated ones at start. | false | true (ByPropertyName) | |||
| cloud-init':' Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. | false | true (ByPropertyName) | |||
| Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. Enum: configdrive2,nocloud,opennebula | false | true (ByPropertyName) | |||
| cloud-init':' do an automatic package upgrade after the first boot. | false | true (ByPropertyName) | False | ||
| cloud-init':' User name to change ssh keys and password for instead of the image's configured default user. | false | true (ByPropertyName) | |||
| The number of cores per socket. | false | true (ByPropertyName) | 0 | ||
| Emulated CPU type. | false | true (ByPropertyName) | |||
| Limit of CPU usage. | false | true (ByPropertyName) | 0 | ||
| CPU weight for a VM, will be clamped to \[1, 10000] in cgroup v2. | false | true (ByPropertyName) | 0 | ||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused\[n]', which contains the volume ID. Unlink of unused\[n] always cause physical removal. | false | true (ByPropertyName) | False | ||
| Freeze CPU at startup (use 'c' monitor command to start execution). | false | true (ByPropertyName) | False | ||
| Script that will be executed during various steps in the vms lifetime. | false | true (ByPropertyName) | |||
| Map host PCI devices into guest. | false | true (ByPropertyName) | |||
| Selectively enable hotplug features. This is a comma separated list of hotplug features':' 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7. | false | true (ByPropertyName) | |||
| Enable/disable hugepages memory. Enum: any,2,1024 | false | true (ByPropertyName) | |||
| Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| cloud-init':' Specify IP addresses and gateways for the corresponding interface.IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicitgateway should be provided.For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requirescloud-init 19.4 or newer.If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to usingdhcp on IPv4. | false | true (ByPropertyName) | |||
| Inter-VM shared memory. Useful for direct communication between VMs, or to the host. | false | true (ByPropertyName) | |||
| Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. | false | true (ByPropertyName) | False | ||
| Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. Enum: de,de-ch,da,en-gb,en-us,es,fi,fr,fr-be,fr-ca,fr-ch,hu,is,it,ja,lt,mk,nl,no,pl,pt,pt-br,sv,sl,tr | false | true (ByPropertyName) | |||
| Enable/disable KVM hardware virtualization. | false | true (ByPropertyName) | False | ||
| Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. | false | true (ByPropertyName) | False | ||
| Lock/unlock the VM. Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspended | false | true (ByPropertyName) | |||
| Specify the QEMU machine. | false | true (ByPropertyName) | |||
| Memory properties. | false | true (ByPropertyName) | |||
| Set maximum tolerated downtime (in seconds) for migrations. | false | true (ByPropertyName) | 0 | ||
| Set maximum speed (in MB/s) for migrations. Value 0 is no limit. | false | true (ByPropertyName) | 0 | ||
| Set a name for the VM. Only used on the configuration web interface. | false | true (ByPropertyName) | |||
| cloud-init':' Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. | false | true (ByPropertyName) | |||
| Specify network devices. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Enable/disable NUMA. | false | true (ByPropertyName) | False | ||
| NUMA topology. | false | true (ByPropertyName) | |||
| Specifies whether a VM will be started during system bootup. | false | true (ByPropertyName) | False | ||
| Specify guest operating system. Enum: other,wxp,w2k,w2k3,w2k8,wvista,win7,win8,win10,win11,l24,l26,solaris | false | true (ByPropertyName) | |||
| Map host parallel devices (n is 0 to 2). | false | true (ByPropertyName) | |||
| Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. | false | true (ByPropertyName) | False | ||
| Allow reboot. If set to '0' the VM exit on reboot. | false | true (ByPropertyName) | False | ||
| Revert a pending change. | false | true (ByPropertyName) | |||
| Configure a VirtIO-based Random Number Generator. | false | true (ByPropertyName) | |||
| Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| SCSI controller model Enum: lsi,lsi53c810,virtio-scsi-pci,virtio-scsi-single,megasas,pvscsi | false | true (ByPropertyName) | |||
| cloud-init':' Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. | false | true (ByPropertyName) | |||
| Create a serial device inside the VM (n is 0 to 3) | false | true (ByPropertyName) | |||
| Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. | false | true (ByPropertyName) | 0 | ||
| Ignore locks - only root is allowed to use this option. | false | true (ByPropertyName) | False | ||
| Specify SMBIOS type 1 fields. | false | true (ByPropertyName) | |||
| The number of CPUs. Please use option -sockets instead. | false | true (ByPropertyName) | 0 | ||
| The number of CPU sockets. | false | true (ByPropertyName) | 0 | ||
| Configure additional enhancements for SPICE. | false | true (ByPropertyName) | |||
| cloud-init':' Setup public SSH keys (one key per line, OpenSSH format). | false | true (ByPropertyName) | |||
| Set the initial date of the real time clock. Valid format for date are':''now' or '2006-06-17T16':'01':'21' or '2006-06-17'. | false | true (ByPropertyName) | |||
| Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. | false | true (ByPropertyName) | |||
| Enable/disable the USB tablet device. | false | true (ByPropertyName) | False | ||
| Tags of the VM. This is only meta information. | false | true (ByPropertyName) | |||
| Enable/disable time drift fix. | false | true (ByPropertyName) | False | ||
| Enable/disable Template. | false | true (ByPropertyName) | False | ||
| Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| Reference to unused volumes. This is used internally, and should not be modified manually. | false | true (ByPropertyName) | |||
| Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). | false | true (ByPropertyName) | |||
| Number of hotplugged vcpus. | false | true (ByPropertyName) | 0 | ||
| Configure the VGA hardware. | false | true (ByPropertyName) | |||
| Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume. | false | true (ByPropertyName) | |||
| Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 | ||
| Default storage for VM state volumes/files. | false | true (ByPropertyName) | |||
| Create a virtual hardware watchdog device. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesQemuFirewallAliases
Update IP or Network alias.
Syntax
Set-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Alias name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Rename an existing alias. | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesQemuFirewallIpset
Update IP or Network settings
Syntax
Set-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Network/IP specification in CIDR format. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| IP set name. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| -- | false | true (ByPropertyName) | False | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesQemuFirewallOptions
Set Firewall options.
Syntax
Set-PveNodesQemuFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [-Dhcp] [[-Digest] <String>] [-Enable] [-Ipfilter] [[-LogLevelIn] <String>] [[-LogLevelOut] <String>] [-Macfilter] [-Ndp] [-Node] <String> [[-PolicyIn] <String>] [[-PolicyOut] <String>] [-Radv] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Enable DHCP. | false | true (ByPropertyName) | False | ||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Enable/disable firewall rules. | false | true (ByPropertyName) | False | ||
| Enable default IP filters. This is equivalent to adding an empty ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added. | false | true (ByPropertyName) | False | ||
| Log level for incoming traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Log level for outgoing traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Enable/disable MAC address filter. | false | true (ByPropertyName) | False | ||
| Enable NDP (Neighbor Discovery Protocol). | false | true (ByPropertyName) | False | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Input policy. Enum: ACCEPT,REJECT,DROP | false | true (ByPropertyName) | |||
| Output policy. Enum: ACCEPT,REJECT,DROP | false | true (ByPropertyName) | |||
| Allow sending Router Advertisement. | false | true (ByPropertyName) | False | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesQemuFirewallRules
Modify rule data.
Syntax
Set-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. | false | true (ByPropertyName) | |||
| Descriptive comment. | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| 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) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| 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) | |||
| Flag to enable/disable a rule. | false | true (ByPropertyName) | 0 | ||
| Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. | false | true (ByPropertyName) | |||
| 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 level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog | false | true (ByPropertyName) | |||
| Use predefined standard macro. | false | true (ByPropertyName) | |||
| Move rule to new position <moveto>. Other arguments are ignored. | false | true (ByPropertyName) | 0 | ||
| The cluster node name. | true | true (ByPropertyName) | |||
| Update rule at position <pos>. | false | true (ByPropertyName) | 0 | ||
| IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. | false | true (ByPropertyName) | |||
| 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) | |||
| 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) | |||
| Rule type. Enum: in,out,group | false | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesQemuResize
Extend volume size.
Syntax
Set-PveNodesQemuResize [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Disk] <String> [-Node] <String> [-Size] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| The disk you want to resize. Enum: ide0,ide1,ide2,ide3,scsi0,scsi1,scsi2,scsi3,scsi4,scsi5,scsi6,scsi7,scsi8,scsi9,scsi10,scsi11,scsi12,scsi13,scsi14,scsi15,scsi16,scsi17,scsi18,scsi19,scsi20,scsi21,scsi22,scsi23,scsi24,scsi25,scsi26,scsi27,scsi28,scsi29,scsi30,virtio0,virtio1,virtio2,virtio3,virtio4,virtio5,virtio6,virtio7,virtio8,virtio9,virtio10,virtio11,virtio12,virtio13,virtio14,virtio15,sata0,sata1,sata2,sata3,sata4,sata5,efidisk0,tpmstate0 | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The new size. With the `+` sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported. | true | true (ByPropertyName) | |||
| Ignore locks - only root is allowed to use this option. | false | true (ByPropertyName) | False | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesQemuSendkey
Send key event to virtual machine.
Syntax
Set-PveNodesQemuSendkey [[-PveTicket] <PveTicket>] [-Key] <String> [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The key (qemu monitor encoding). | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Ignore locks - only root is allowed to use this option. | false | true (ByPropertyName) | False | ||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesQemuSnapshotConfig
Update snapshot metadata.
Syntax
Set-PveNodesQemuSnapshotConfig [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| A textual description or comment. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The name of the snapshot. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesQemuUnlink
Unlink/delete disk images.
Syntax
Set-PveNodesQemuUnlink [[-PveTicket] <PveTicket>] [-Force] [-Idlist] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused\[n]', which contains the volume ID. Unlink of unused\[n] always cause physical removal. | false | true (ByPropertyName) | False | ||
| A list of disk IDs you want to delete. | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The (unique) ID of the VM. | true | true (ByPropertyName) | 0 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesStorageContent
Update volume attributes
Syntax
Set-PveNodesStorageContent [[-PveTicket] <PveTicket>] [-Node] <String> [[-Notes] <String>] [-Protected] [[-Storage] <String>] [-Volume] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| The new notes. | false | true (ByPropertyName) | |||
| Protection status. Currently only supported for backups. | false | true (ByPropertyName) | False | ||
| The storage identifier. | false | true (ByPropertyName) | |||
| Volume identifier | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesSubscription
Set subscription key.
Syntax
Set-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Key] <String> [-Node] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Proxmox VE subscription key | true | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveNodesTime
Set time zone.
Syntax
Set-PveNodesTime [[-PveTicket] <PveTicket>] [-Node] <String> [-Timezone] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| The cluster node name. | true | true (ByPropertyName) | |||
| Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names. | true | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PvePools
Update pool.
Syntax
Set-PvePools [[-PveTicket] <PveTicket>] [-AllowMove] [[-Comment] <String>] [-Delete] [-Poolid] <String> [[-Storage] <String>] [[-Vms] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one. | false | true (ByPropertyName) | False | ||
| -- | false | true (ByPropertyName) | |||
| Remove the passed VMIDs and/or storage IDs instead of adding them. | false | true (ByPropertyName) | False | ||
| -- | true | true (ByPropertyName) | |||
| List of storage IDs to add or remove from this pool. | false | true (ByPropertyName) | |||
| List of guest VMIDs to add or remove from this pool. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PvePoolsIdx
Update pool data (deprecated, no support for nested pools - use 'PUT /pools/?poolid={poolid}' instead).
Syntax
Set-PvePoolsIdx [[-PveTicket] <PveTicket>] [-AllowMove] [[-Comment] <String>] [-Delete] [-Poolid] <String> [[-Storage] <String>] [[-Vms] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one. | false | true (ByPropertyName) | False | ||
| -- | false | true (ByPropertyName) | |||
| Remove the passed VMIDs and/or storage IDs instead of adding them. | false | true (ByPropertyName) | False | ||
| -- | true | true (ByPropertyName) | |||
| List of storage IDs to add or remove from this pool. | false | true (ByPropertyName) | |||
| List of guest VMIDs to add or remove from this pool. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Set-PveStorage
Update storage configuration.
Syntax
Set-PveStorage [[-PveTicket] <PveTicket>] [[-Blocksize] <String>] [[-Bwlimit] <String>] [[-ComstarHg] <String>] [[-ComstarTg] <String>] [[-Content] <String>] [[-ContentDirs] <String>] [-CreateBasePath] [-CreateSubdirs] [[-DataPool] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [[-Domain] <String>] [[-EncryptionKey] <String>] [[-Fingerprint] <String>] [[-Format] <String>] [[-FsName] <String>] [-Fuse] [[-IsMountpoint] <String>] [[-Keyring] <String>] [-Krbd] [[-LioTpg] <String>] [[-MasterPubkey] <String>] [[-MaxProtectedBackups] <Int32>] [[-Maxfiles] <Int32>] [-Mkdir] [[-Monhost] <String>] [[-Mountpoint] <String>] [[-Namespace] <String>] [-Nocow] [[-Nodes] <String>] [-Nowritecache] [[-Options] <String>] [[-Password] <SecureString>] [[-Pool] <String>] [[-Port] <Int32>] [[-Preallocation] <String>] [[-PruneBackups] <String>] [-Saferemove] [[-SaferemoveThroughput] <String>] [[-Server] <String>] [[-Server2] <String>] [-Shared] [-SkipCertVerification] [[-Smbversion] <String>] [-Sparse] [-Storage] <String> [[-Subdir] <String>] [-TaggedOnly] [[-Transport] <String>] [[-Username] <String>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByPropertyName) | |||
| block size | false | true (ByPropertyName) | |||
| Set I/O bandwidth limit for various operations (in KiB/s). | false | true (ByPropertyName) | |||
| host group for comstar views | false | true (ByPropertyName) | |||
| target group for comstar views | false | true (ByPropertyName) | |||
| Allowed content types.NOTE':' the value 'rootdir' is used for Containers, and value 'images' for VMs. | false | true (ByPropertyName) | |||
| Overrides for default content type directories. | false | true (ByPropertyName) | |||
| Create the base directory if it doesn't exist. | false | true (ByPropertyName) | False | ||
| Populate the directory with the default structure. | false | true (ByPropertyName) | False | ||
| Data Pool (for erasure coding only) | false | true (ByPropertyName) | |||
| A list of settings you want to delete. | false | true (ByPropertyName) | |||
| Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications. | false | true (ByPropertyName) | |||
| Flag to disable the storage. | false | true (ByPropertyName) | False | ||
| CIFS domain. | false | true (ByPropertyName) | |||
| Encryption key. Use 'autogen' to generate one automatically without passphrase. | false | true (ByPropertyName) | |||
| Certificate SHA 256 fingerprint. | false | true (ByPropertyName) | |||
| Default image format. | false | true (ByPropertyName) | |||
| The Ceph filesystem name. | false | true (ByPropertyName) | |||
| Mount CephFS through FUSE. | false | true (ByPropertyName) | False | ||
| Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. | false | true (ByPropertyName) | |||
| Client keyring contents (for external clusters). | false | true (ByPropertyName) | |||
| Always access rbd through krbd kernel module. | false | true (ByPropertyName) | False | ||
| target portal group for Linux LIO targets | false | true (ByPropertyName) | |||
| Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. | false | true (ByPropertyName) | |||
| Maximal number of protected backups per guest. Use '-1' for unlimited. | false | true (ByPropertyName) | 0 | ||
| Deprecated':' use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited. | false | true (ByPropertyName) | 0 | ||
| Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE':' Deprecated, use the 'create-base-path' and 'create-subdirs' options instead. | false | true (ByPropertyName) | False | ||
| IP addresses of monitors (for external clusters). | false | true (ByPropertyName) | |||
| mount point | false | true (ByPropertyName) | |||
| Namespace. | false | true (ByPropertyName) | |||
| Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system. | false | true (ByPropertyName) | False | ||
| List of nodes for which the storage configuration applies. | false | true (ByPropertyName) | |||
| disable write caching on the target | false | true (ByPropertyName) | False | ||
| NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') | false | true (ByPropertyName) | |||
| Password for accessing the share/datastore. | false | true (ByPropertyName) | |||
| Pool. | false | true (ByPropertyName) | |||
| For non default port. | false | true (ByPropertyName) | 0 | ||
| Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. Enum: off,metadata,falloc,full | false | true (ByPropertyName) | |||
| The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups. | false | true (ByPropertyName) | |||
| Zero-out data when removing LVs. | false | true (ByPropertyName) | False | ||
| Wipe throughput (cstream -t parameter value). | false | true (ByPropertyName) | |||
| Server IP or DNS name. | false | true (ByPropertyName) | |||
| Backup volfile server IP or DNS name. | false | true (ByPropertyName) | |||
| Indicate that this is a single storage with the same contents on all nodes (or all listed in the 'nodes' option). It will not make the contents of a local storage automatically accessible to other nodes, it just marks an already shared storage as such! | false | true (ByPropertyName) | False | ||
| Disable TLS certificate verification, only enable on fully trusted networks! | false | true (ByPropertyName) | False | ||
| SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. Enum: default,2.0,2.1,3,3.0,3.11 | false | true (ByPropertyName) | |||
| use sparse volumes | false | true (ByPropertyName) | False | ||
| The storage identifier. | true | true (ByPropertyName) | |||
| Subdir to mount. | false | true (ByPropertyName) | |||
| Only use logical volumes tagged with 'pve-vm-ID'. | false | true (ByPropertyName) | False | ||
| Gluster transport':' tcp or rdma Enum: tcp,rdma,unix | false | true (ByPropertyName) | |||
| RBD Id. | false | true (ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Start-PveVm
Start VM.
Syntax
Start-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The (unique) ID or Name of the VM. | true | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Stop-PveVm
Stop VM.
Syntax
Stop-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The (unique) ID or Name of the VM. | true | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Suspend-PveVm
Suspend VM.
Syntax
Suspend-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The (unique) ID or Name of the VM. | true | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Undo-PveVmSnapshot
Rollback VM state to specified snapshot.
Syntax
Undo-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Snapname] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The (unique) ID or Name of the VM. | true | true (ByValue, ByPropertyName) | |||
| The name of the snapshot. | true | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
Unlock-PveVm
Unlock VM.
Syntax
Unlock-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| The (unique) ID or Name of the VM. | true | true (ByValue, ByPropertyName) |
Outputs
The output type is the type of the objects that the cmdlet emits.
- PveResponse. Return response.
VmCheckIdOrName
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| None | false | false | |||
| None | false | false |
Wait-PveTaskIsFinish
Get task is running.
Syntax
Wait-PveTaskIsFinish [[-PveTicket] <PveTicket>] [-Upid] <String> [[-Wait] <Int32>] [[-Timeout] <Int32>] [<CommonParameters>]
Parameters
| Name | Alias | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Ticket data connection. | false | true (ByValue, ByPropertyName) | |||
| Upid task e.g UPID:pve1:00004A1A:0964214C:5EECEF11:vzdump:134:root@pam: | true | true (ByValue, ByPropertyName) | |||
| Millisecond wait next check | false | true (ByValue, ByPropertyName) | 500 | ||
| Millisecond timeout | false | true (ByValue, ByPropertyName) | 10000 |
Outputs
The output type is the type of the objects that the cmdlet emits.
- Bool. Return tas is running.