gsadmin/PSProxmoxVE
1
0
Fork 0
mirror of https://github.com/GoodOlClint/PSProxmoxVE.git synced 2026-07-26 07:58:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update cmdlet help via platyPS merge, fix generate-help.ps1

Browse Source 
- generate-help.ps1: rewritten to use Update-MarkdownHelp (merge) by
  default, preserving hand-written descriptions and examples. Only
  New-MarkdownHelp on genuinely new cmdlets. -Force flag for full regen.
- docs/cmdlets: parameter metadata updated via platyPS merge, CRLF
  normalized to LF
- Removed stale Send-PveIso.md (cmdlet renamed to Send-PveFile)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Clint Branham
2026-03-23 17:41:04 -05:00
parent d5f4e13637
commit f6a2f843db
90 changed files with 24596 additions and 3615 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/cmdlets/Get-PveClusterResource.md
+16 -16
View File
@@ -38,22 +38,6 @@ Returns only VM resources across the cluster.
## PARAMETERS
### -Type
Filter by resource type.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: vm, lxc, node, storage, sdn
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
Filter results to a specific node name.
@@ -84,6 +68,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Type
Filter by resource type.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: vm, lxc, node, storage, sdn
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/Get-PveContainerInterface.md
+15 -15
View File
@@ -46,21 +46,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The container identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -76,6 +61,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The container identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/Get-PveFirewallAlias.md
+19 -19
View File
@@ -47,8 +47,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node name. Required when Level is Node, Vm, or Container.
### -Name
Optional alias name to filter by.
```yaml
Type: String
@@ -62,23 +62,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
Optional alias name to filter by.
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
@@ -107,6 +92,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/Get-PveFirewallIpSet.md
+19 -19
View File
@@ -47,8 +47,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node name. Required when Level is Node, Vm, or Container.
### -Name
Optional IP set name to filter by.
```yaml
Type: String
@@ -62,23 +62,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
Optional IP set name to filter by.
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
@@ -107,6 +92,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/Get-PveFirewallIpSetEntry.md
+30 -30
View File
@@ -47,36 +47,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
The IP set name.
@@ -92,6 +62,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -107,6 +92,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/Get-PveFirewallOptions.md
+6 -6
View File
@@ -62,11 +62,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
### -Session
{{ Fill Session Description }}
```yaml
Type: Int32
Type: PveSession
Parameter Sets: (All)
Aliases:
@@ -77,11 +77,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: PveSession
Type: Int32
Parameter Sets: (All)
Aliases:
docs/cmdlets/Get-PveFirewallRef.md
+8 -8
View File
@@ -13,8 +13,8 @@ Lists firewall references at the specified level.
## SYNTAX
```
Get-PveFirewallRef [-Level] <String> [-Node <String>] [-VmId <Int32>] [-Type <String>]
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-PveFirewallRef [-Level] <String> [-Node <String>] [-VmId <Int32>] [-Type <String>] [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```
## DESCRIPTION
@@ -62,11 +62,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
### -Session
{{ Fill Session Description }}
```yaml
Type: Int32
Type: PveSession
Parameter Sets: (All)
Aliases:
@@ -92,11 +92,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: PveSession
Type: Int32
Parameter Sets: (All)
Aliases:
docs/cmdlets/Get-PveFirewallRule.md
+15 -15
View File
@@ -62,21 +62,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Position
Optional rule position to filter by.
@@ -107,6 +92,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/Get-PveStorageStatus.md
+15 -15
View File
@@ -46,21 +46,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Storage
The storage pool name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -76,6 +61,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Storage
The storage pool name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/Get-PveTaskList.md
+20 -20
View File
@@ -38,6 +38,21 @@ Returns the 10 most recent tasks for VM 100.
## PARAMETERS
### -Limit
Maximum number of tasks to return. Defaults to 50.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
@@ -53,11 +68,11 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -VmId
Filter tasks by VM ID.
### -Session
{{ Fill Session Description }}
```yaml
Type: Int32
Type: PveSession
Parameter Sets: (All)
Aliases:
@@ -99,29 +114,14 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Limit
Maximum number of tasks to return. Defaults to 50.
### -VmId
Filter tasks by VM ID.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
docs/cmdlets/Get-PveVm.md
+16 -1
View File
@@ -14,7 +14,7 @@ schema: 2.0.0
```
Get-PveVm [-Node <String>] [-VmId <Int32>] [-Name <String>] [-Status <String>] [-Tag <String>] [-TemplatesOnly]
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
[-Detailed] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```
## DESCRIPTION
@@ -152,6 +152,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Detailed
Include detailed status (QmpStatus) via per-VM API call.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
docs/cmdlets/Get-PveVmGuestFsInfo.md
+15 -15
View File
@@ -46,21 +46,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -76,6 +61,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/Get-PveVmGuestOsInfo.md
+15 -15
View File
@@ -46,21 +46,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -76,6 +61,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/Import-PveOva.md
+90 -90
View File
@@ -32,6 +32,66 @@ Imports an OVA file into a new VM on node pve1.
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Cores
Override CPU core count.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Memory
Override memory size in MiB.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
Override the VM name from the OVF.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
@@ -47,21 +107,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Storage
The storage pool for OVA upload.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Path
Local path to the OVA file.
@@ -77,6 +122,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Storage
The storage pool for OVA upload.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -TargetStorage
Target storage for imported VM disks.
@@ -107,51 +182,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
Override the VM name from the OVF.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Memory
Override memory size in MiB.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Cores
Override CPU core count.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Wait
Wait for all tasks to complete before returning.
@@ -167,21 +197,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -197,21 +212,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/Import-PveVmDisk.md
+63 -63
View File
@@ -13,7 +13,7 @@ Imports a disk image into a Proxmox VE virtual machine.
## SYNTAX
```
Import-PveVmDisk [-Disk] <String> -Node <String> -VmId <Int32> -TargetStorage <String> -Source <String>
Import-PveVmDisk -Node <String> -VmId <Int32> [-Disk] <String> -TargetStorage <String> -Source <String>
[-Format <String>] [-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
@@ -32,33 +32,18 @@ Imports a cloud image into VM 100.
## PARAMETERS
### -Node
The PVE node name.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -VmId
The VM identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept pipeline input: False
Accept wildcard characters: False
```
@@ -77,36 +62,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -TargetStorage
Target storage for the imported disk.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Source
Import source (e.g. local:iso/image.img or local:import/vm.ova/disk.vmdk).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Format
Target disk format (qcow2, raw, vmdk).
@@ -123,18 +78,18 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Wait
Wait for the import task to complete.
### -Node
The PVE node name.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
@@ -153,13 +108,58 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -Source
Import source (e.g. local:iso/image.img or local:import/vm.ova/disk.vmdk).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -TargetStorage
Target storage for the imported disk.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Wait
Wait for the import task to complete.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -168,13 +168,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
docs/cmdlets/Invoke-PveSdnApply.md
+15 -15
View File
@@ -31,6 +31,21 @@ Applies all pending SDN configuration changes.
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -61,21 +76,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/Invoke-PveVmGuestExec.md
+17 -1
View File
@@ -14,7 +14,8 @@ schema: 2.0.0
```
Invoke-PveVmGuestExec [-Node] <String> [-VmId] <Int32> [-Command] <String> [-Args <String[]>]
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
[-Timeout <Int32>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
## DESCRIPTION
@@ -152,6 +153,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Timeout
Timeout in seconds to wait for command completion. Defaults to 300.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
docs/cmdlets/Invoke-PveVmGuestFsTrim.md
+30 -30
View File
@@ -31,6 +31,21 @@ Triggers fstrim on VM 100.
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
@@ -46,6 +61,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM identifier.
@@ -61,21 +91,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -91,21 +106,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/Move-PveContainerVolume.md
+60 -60
View File
@@ -31,6 +31,36 @@ Moves the rootfs volume of container 100 to local-lvm storage.
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Delete
Delete the original volume after move (default true).
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: True
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
@@ -46,6 +76,36 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Storage
The target storage identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The container identifier.
@@ -76,36 +136,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Storage
The target storage identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Delete
Delete the original volume after move (default true).
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: True
Accept pipeline input: False
Accept wildcard characters: False
```
### -Wait
Wait for the task to complete before returning.
@@ -121,21 +151,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -151,21 +166,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/Move-PveVmDisk.md
+64 -65
View File
@@ -14,8 +14,7 @@ Moves a VM disk to a different storage.
```
Move-PveVmDisk -Node <String> -VmId <Int32> -Disk <String> -Storage <String> [-Format <String>] [-Delete]
[-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
[-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -32,53 +31,38 @@ Moves the scsi0 disk of VM 100 to local-lvm storage.
## PARAMETERS
### -Node
The PVE node name.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -VmId
The VM identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Disk
The disk slot to move (e.g. scsi0, virtio0).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Storage
The target storage identifier.
### -Delete
Delete the original disk after move (default true).
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: True
Accept pipeline input: False
Accept wildcard characters: False
```
### -Disk
The disk slot to move (e.g. scsi0, virtio0).
```yaml
Type: String
@@ -108,33 +92,18 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Delete
Delete the original disk after move (default true).
### -Node
The PVE node name.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: True
Accept pipeline input: False
Accept wildcard characters: False
```
### -Wait
Wait for the task to complete before returning.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
@@ -153,13 +122,43 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -Storage
The target storage identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Wait
Wait for the task to complete before returning.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -168,13 +167,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
docs/cmdlets/New-PveBackup.md
+48 -48
View File
@@ -32,43 +32,29 @@ Creates a snapshot backup of VM 100 and waits for completion.
## PARAMETERS
### -Node
The PVE node name.
### -Compress
The compression algorithm.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: zstd, lzo, gzip, none
Required: True
Position: 0
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM identifier.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: Int32
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Storage
The target storage for the backup.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: False
Position: Named
@@ -93,14 +79,28 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Compress
The compression algorithm.
### -Node
The PVE node name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: zstd, lzo, gzip, none
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
@@ -109,11 +109,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Wait
Wait for the task to complete before returning.
### -Storage
The target storage for the backup.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
@@ -139,11 +139,26 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
### -VmId
The VM identifier.
```yaml
Type: PveSession
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Wait
Wait for the task to complete before returning.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
@@ -169,21 +184,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/New-PveBackupJob.md
+145 -145
View File
@@ -33,67 +33,6 @@ Creates a nightly backup job at 2 AM.
## PARAMETERS
### -Schedule
Cron-style schedule expression (e.g., '0 2 * * *').
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Storage
The target storage for backups.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Mode
The backup mode.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: snapshot, suspend, stop
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
Comma-separated list of VM IDs to back up.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -All
Back up all VMs.
@@ -109,83 +48,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Compress
The compression algorithm.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: zstd, lzo, gzip, none
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node to restrict the backup job to.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -MailTo
Email address(es) for notifications.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -MailNotification
When to send email notifications.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: always, failure
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Enabled
Whether the backup job is enabled. Default is enabled.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Comment
A comment or description for the backup job.
@@ -201,6 +63,114 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Compress
The compression algorithm.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: zstd, lzo, gzip, none
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Enabled
Whether the backup job is enabled. Default is enabled.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -MailNotification
When to send email notifications.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: always, failure
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -MailTo
Email address(es) for notifications.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Mode
The backup mode.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: snapshot, suspend, stop
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node to restrict the backup job to.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -PruneBackups
Prune-backups configuration string.
@@ -216,6 +186,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Schedule
Cron-style schedule expression (e.g., '0 2 * * *').
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -231,13 +216,28 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -Storage
The target storage for backups.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
Comma-separated list of VM IDs to back up.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
@@ -246,13 +246,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
docs/cmdlets/New-PveContainerTemplate.md
+30 -30
View File
@@ -31,6 +31,21 @@ Converts container 100 to a template.
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
@@ -46,21 +61,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -VmId
The container identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -76,6 +76,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The container identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -91,21 +106,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/New-PveDomain.md
+46 -46
View File
@@ -31,37 +31,6 @@ Creates a new LDAP authentication domain.
## PARAMETERS
### -Realm
The realm identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Type
The domain type (pam, pve, ad, ldap, openid).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: pam, pve, ad, ldap, openid
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Comment
Comment or description for the domain.
@@ -77,6 +46,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Default
Set as the default authentication domain.
@@ -92,6 +76,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Realm
The realm identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -107,6 +106,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Type
The domain type (pam, pve, ad, ldap, openid).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: pam, pve, ad, ldap, openid
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -122,21 +137,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/New-PveFirewallAlias.md
+76 -76
View File
@@ -32,67 +32,6 @@ Creates a cluster-level firewall alias.
## PARAMETERS
### -Level
The firewall level: Cluster, Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Cluster, Node, Vm, Container
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
The alias name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Cidr
The CIDR network address.
@@ -123,6 +62,67 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Level
The firewall level: Cluster, Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Cluster, Node, Vm, Container
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
The alias name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -138,6 +138,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -153,21 +168,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/New-PveFirewallGroup.md
+30 -30
View File
@@ -31,21 +31,6 @@ Creates a security group named webservers.
## PARAMETERS
### -Group
The security group name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Comment
Optional comment for the security group.
@@ -61,6 +46,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Group
The security group name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -91,21 +106,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
docs/cmdlets/New-PveFirewallIpSet.md
+39 -39
View File
@@ -31,6 +31,36 @@ Creates a cluster-level IP set named trusted.
## PARAMETERS
### -Comment
Optional comment for the IP set.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Level
The firewall level: Cluster, Node, Vm, or Container.
@@ -47,36 +77,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
The IP set name.
@@ -92,8 +92,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Comment
Optional comment for the IP set.
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
@@ -122,13 +122,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: SwitchParameter
Type: Int32
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -137,13 +137,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
docs/cmdlets/New-PveFirewallIpSetEntry.md
+57 -59
View File
@@ -13,9 +13,9 @@ Adds an entry to a firewall IP set.
## SYNTAX
```
New-PveFirewallIpSetEntry [-Level] <String> [-Node <String>] [-VmId <Int32>] -Name <String>
-Cidr <String> [-NoMatch] [-Comment <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
New-PveFirewallIpSetEntry [-Level] <String> [-Node <String>] [-VmId <Int32>] -Name <String> -Cidr <String>
[-NoMatch] [-Comment <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -30,6 +30,51 @@ PS C:\> New-PveFirewallIpSetEntry -Level Cluster -Name trusted -Cidr 10.0.0.0/24
## PARAMETERS
### -Cidr
The CIDR network address to add.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Comment
Optional comment for the entry.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Level
The firewall level: Cluster, Node, Vm, or Container.
@@ -37,7 +82,6 @@ The firewall level: Cluster, Node, Vm, or Container.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Cluster, Node, Vm, Container
Required: True
@@ -47,36 +91,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
The IP set name.
@@ -92,21 +106,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Cidr
The CIDR network address to add.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -NoMatch
Exclude this entry from the IP set match.
@@ -122,8 +121,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Comment
Optional comment for the entry.
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
@@ -152,13 +151,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: SwitchParameter
Type: Int32
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -167,13 +166,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
@@ -200,7 +199,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/New-PveFirewallRule.md
+99 -103
View File
@@ -31,70 +31,6 @@ PS C:\> New-PveFirewallRule -Level Cluster -Type in -Action ACCEPT -Proto tcp -D
## PARAMETERS
### -Level
The firewall level: Cluster, Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Cluster, Node, Vm, Container
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Type
The rule type: in, out, or group.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: in, out, group
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Action
The rule action: ACCEPT, DROP, or REJECT.
@@ -102,7 +38,6 @@ The rule action: ACCEPT, DROP, or REJECT.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: ACCEPT, DROP, REJECT
Required: True
@@ -112,11 +47,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Enable
Enable the rule.
### -Comment
Rule comment.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
@@ -127,13 +62,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Source
Source address or alias.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: False
Position: Named
@@ -157,21 +92,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Proto
Protocol (e.g., tcp, udp, icmp).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Dport
Destination port.
@@ -187,8 +107,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Sport
Source port.
### -Enable
Enable the rule.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Iface
Network interface.
```yaml
Type: String
@@ -202,8 +137,24 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Comment
Rule comment.
### -Level
The firewall level: Cluster, Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Cluster, Node, Vm, Container
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Log
Log level.
```yaml
Type: String
@@ -232,8 +183,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Log
Log level.
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
@@ -247,8 +198,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Iface
Network interface.
### -Proto
Protocol (e.g., tcp, udp, icmp).
```yaml
Type: String
@@ -277,13 +228,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -Source
Source address or alias.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -292,13 +243,59 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -Sport
Source port.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Type
The rule type: in, out, or group.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: in, out, group
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
@@ -325,7 +322,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/New-PveGroup.md
+30 -31
View File
@@ -29,21 +29,6 @@ PS C:\> New-PveGroup -GroupId admins -Comment 'Admin group'
## PARAMETERS
### -GroupId
The group identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Comment
Comment or description for the group.
@@ -59,6 +44,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -GroupId
The group identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -89,21 +104,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -122,7 +122,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/New-PvePool.md
+32 -33
View File
@@ -13,8 +13,8 @@ Creates a new resource pool in Proxmox VE.
## SYNTAX
```
New-PvePool [-PoolId] <String> [-Comment <String>] [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
New-PvePool [-PoolId] <String> [-Comment <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -29,21 +29,6 @@ PS C:\> New-PvePool -PoolId production -Comment 'Production VMs'
## PARAMETERS
### -PoolId
The pool ID to create.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Comment
An optional comment or description for the pool.
@@ -59,6 +44,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -PoolId
The pool ID to create.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -89,21 +104,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -122,7 +122,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/New-PveSdnController.md
+52 -55
View File
@@ -13,9 +13,8 @@ Creates a new SDN controller in Proxmox VE.
## SYNTAX
```
New-PveSdnController [-Controller] <String> [-Type] <String> [-Asn <Int32>] [-Peers <String>]
[-Node <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
New-PveSdnController [-Controller] <String> [-Type] <String> [-Asn <Int32>] [-Peers <String>] [-Node <String>]
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -30,38 +29,6 @@ PS C:\> New-PveSdnController -Controller bgp1 -Type bgp -Asn 65001
## PARAMETERS
### -Controller
The controller identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Type
The controller type.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: evpn, bgp
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Asn
The Autonomous System Number for BGP/EVPN.
@@ -77,8 +44,38 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Peers
Comma-separated list of BGP peer addresses.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Controller
The controller identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node this controller is configured on.
```yaml
Type: String
@@ -92,8 +89,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node this controller is configured on.
### -Peers
Comma-separated list of BGP peer addresses.
```yaml
Type: String
@@ -122,6 +119,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Type
The controller type.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: evpn, bgp
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -137,21 +150,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -170,7 +168,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/New-PveSdnDns.md
+53 -55
View File
@@ -30,6 +30,21 @@ PS C:\> New-PveSdnDns -Dns pdns1 -Type powerdns -Url https://dns.example.com -Ke
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Dns
The DNS plugin identifier.
@@ -45,38 +60,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Type
The DNS plugin type.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: powerdns
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Url
The URL of the DNS service API.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Key
The API key for the DNS service.
@@ -107,21 +90,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Ttl
The TTL (time-to-live) for DNS records.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -137,13 +105,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -Ttl
The TTL (time-to-live) for DNS records.
```yaml
Type: SwitchParameter
Type: Int32
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -152,13 +120,44 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -Type
The DNS plugin type.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: powerdns
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Url
The URL of the DNS service API.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
@@ -185,7 +184,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/New-PveSdnIpam.md
+53 -55
View File
@@ -29,6 +29,21 @@ PS C:\> New-PveSdnIpam -Ipam pveipam -Type pve
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Ipam
The IPAM plugin identifier.
@@ -44,53 +59,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Type
The IPAM plugin type.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: pve, netbox, phpipam
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Url
The URL of the external IPAM service.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Token
The API token for the external IPAM service.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Section
The configuration section identifier.
@@ -121,13 +89,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -Token
The API token for the external IPAM service.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -136,13 +104,44 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -Type
The IPAM plugin type.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: pve, netbox, phpipam
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Url
The URL of the external IPAM service.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
@@ -169,7 +168,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/New-PveStorageDisk.md
+51 -53
View File
@@ -30,31 +30,16 @@ PS C:\> New-PveStorageDisk -Node pve1 -Storage local-lvm -Filename vm-100-disk-1
## PARAMETERS
### -Node
The PVE node name.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Storage
The storage pool name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@@ -75,21 +60,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Size
The size of the disk (e.g. 32G, 100M).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Format
The disk image format (raw, qcow2, vmdk).
@@ -97,7 +67,6 @@ The disk image format (raw, qcow2, vmdk).
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: raw, qcow2, vmdk
Required: False
@@ -107,6 +76,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -122,6 +106,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Size
The size of the disk (e.g. 32G, 100M).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Storage
The storage pool name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -137,21 +151,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -170,7 +169,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/Read-PveVmGuestFile.md
+30 -31
View File
@@ -29,36 +29,6 @@ PS C:\> Read-PveVmGuestFile -Node pve1 -VmId 100 -File /etc/hostname
## PARAMETERS
### -Node
The PVE node name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -File
The file path inside the guest to read.
@@ -74,6 +44,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -89,6 +74,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.Int32
docs/cmdlets/Remove-PveBackupJob.md
+17 -18
View File
@@ -13,8 +13,8 @@ Removes a scheduled backup job from Proxmox VE.
## SYNTAX
```
Remove-PveBackupJob [-Id] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
Remove-PveBackupJob [-Id] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -29,6 +29,21 @@ PS C:\> Remove-PveBackupJob -Id "example"
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Id
The backup job ID.
@@ -74,21 +89,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Remove-PveDomain.md
+17 -18
View File
@@ -13,8 +13,8 @@ Removes a Proxmox VE authentication domain/realm.
## SYNTAX
```
Remove-PveDomain [-Realm] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
Remove-PveDomain [-Realm] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -29,6 +29,21 @@ PS C:\> Remove-PveDomain -Realm "example"
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Realm
The realm identifier to remove.
@@ -74,21 +89,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Remove-PveFirewallAlias.md
+45 -47
View File
@@ -29,6 +29,21 @@ PS C:\> Remove-PveFirewallAlias -Level Cluster -Name myserver
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Level
The firewall level: Cluster, Node, Vm, or Container.
@@ -36,7 +51,6 @@ The firewall level: Cluster, Node, Vm, or Container.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Cluster, Node, Vm, Container
Required: True
@@ -46,6 +60,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
The alias name to remove.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node name. Required when Level is Node, Vm, or Container.
@@ -61,6 +90,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
@@ -76,36 +120,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
The alias name to remove.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -121,21 +135,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -154,7 +153,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/Remove-PveFirewallGroup.md
+15 -16
View File
@@ -29,6 +29,21 @@ PS C:\> Remove-PveFirewallGroup -Group webservers
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Group
The security group name to remove.
@@ -74,21 +89,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/Remove-PveFirewallIpSet.md
+45 -47
View File
@@ -29,6 +29,21 @@ PS C:\> Remove-PveFirewallIpSet -Level Cluster -Name trusted
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Level
The firewall level: Cluster, Node, Vm, or Container.
@@ -36,7 +51,6 @@ The firewall level: Cluster, Node, Vm, or Container.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Cluster, Node, Vm, Container
Required: True
@@ -46,6 +60,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
The IP set name to remove.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node name. Required when Level is Node, Vm, or Container.
@@ -61,6 +90,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
@@ -76,36 +120,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
The IP set name to remove.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -121,21 +135,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -154,7 +153,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/Remove-PveFirewallIpSetEntry.md
+62 -65
View File
@@ -13,9 +13,8 @@ Removes an entry from a firewall IP set.
## SYNTAX
```
Remove-PveFirewallIpSetEntry [-Level] <String> [-Node <String>] [-VmId <Int32>] -Name <String>
-Cidr <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Remove-PveFirewallIpSetEntry [-Level] <String> [-Node <String>] [-VmId <Int32>] -Name <String> -Cidr <String>
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -30,6 +29,36 @@ PS C:\> Remove-PveFirewallIpSetEntry -Level Cluster -Name trusted -Cidr 10.0.0.0
## PARAMETERS
### -Cidr
The CIDR network address to remove.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Level
The firewall level: Cluster, Node, Vm, or Container.
@@ -37,7 +66,6 @@ The firewall level: Cluster, Node, Vm, or Container.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Cluster, Node, Vm, Container
Required: True
@@ -47,6 +75,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
The IP set name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node name. Required when Level is Node, Vm, or Container.
@@ -62,6 +105,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
@@ -77,51 +135,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
The IP set name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Cidr
The CIDR network address to remove.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -137,21 +150,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -170,7 +168,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/Remove-PveFirewallRule.md
+22 -24
View File
@@ -29,6 +29,21 @@ PS C:\> Remove-PveFirewallRule -Level Cluster -Position 0
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Level
The firewall level: Cluster, Node, Vm, or Container.
@@ -36,7 +51,6 @@ The firewall level: Cluster, Node, Vm, or Container.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Cluster, Node, Vm, Container
Required: True
@@ -61,21 +75,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Position
The rule position to remove.
@@ -106,13 +105,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: SwitchParameter
Type: Int32
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -121,13 +120,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
@@ -154,7 +153,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/Remove-PveGroup.md
+17 -18
View File
@@ -13,8 +13,8 @@ Removes a Proxmox VE group.
## SYNTAX
```
Remove-PveGroup [-GroupId] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
Remove-PveGroup [-GroupId] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -29,6 +29,21 @@ PS C:\> Remove-PveGroup -GroupId "example"
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -GroupId
The group identifier to remove.
@@ -74,21 +89,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Remove-PvePool.md
+17 -18
View File
@@ -13,8 +13,8 @@ Removes a resource pool from Proxmox VE.
## SYNTAX
```
Remove-PvePool [-PoolId] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
Remove-PvePool [-PoolId] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -29,6 +29,21 @@ PS C:\> Remove-PvePool -PoolId "example"
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -PoolId
The pool ID to remove.
@@ -74,21 +89,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Remove-PveSdnController.md
+15 -16
View File
@@ -29,6 +29,21 @@ PS C:\> Remove-PveSdnController -Controller "example"
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Controller
The controller identifier to remove.
@@ -74,21 +89,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Remove-PveSdnDns.md
+17 -18
View File
@@ -13,8 +13,8 @@ Removes an SDN DNS plugin from Proxmox VE.
## SYNTAX
```
Remove-PveSdnDns [-Dns] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
Remove-PveSdnDns [-Dns] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -29,6 +29,21 @@ PS C:\> Remove-PveSdnDns -Dns "example"
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Dns
The DNS plugin identifier to remove.
@@ -74,21 +89,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Remove-PveSdnIpam.md
+17 -18
View File
@@ -13,8 +13,8 @@ Removes an SDN IPAM plugin from Proxmox VE.
## SYNTAX
```
Remove-PveSdnIpam [-Ipam] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
Remove-PveSdnIpam [-Ipam] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -29,6 +29,21 @@ PS C:\> Remove-PveSdnIpam -Ipam "example"
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Ipam
The IPAM plugin identifier to remove.
@@ -74,21 +89,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Remove-PveStorageContent.md
+32 -33
View File
@@ -13,8 +13,8 @@ Removes a content volume from a Proxmox VE storage.
## SYNTAX
```
Remove-PveStorageContent [-Node] <String> [-Storage] <String> [-Volume] <String>
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
Remove-PveStorageContent [-Node] <String> [-Storage] <String> [-Volume] <String> [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -29,6 +29,21 @@ PS C:\> Remove-PveStorageContent -Node pve1 -Storage local -Volume "local:iso/ub
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
@@ -44,6 +59,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Storage
The storage pool name.
@@ -74,21 +104,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -104,21 +119,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -137,7 +137,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Remove-PveVmDisk.md
+50 -51
View File
@@ -29,45 +29,15 @@ PS C:\> Remove-PveVmDisk -Node pve1 -VmId 100 -IdList scsi0 -Force
## PARAMETERS
### -Node
The PVE node name.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -VmId
The VM identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -IdList
Comma-separated list of disk IDs to unlink (e.g. scsi0,scsi1).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@@ -89,6 +59,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -IdList
Comma-separated list of disk IDs to unlink (e.g. scsi0,scsi1).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -104,6 +104,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -119,21 +134,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Reset-PveVm.md
+17 -2
View File
@@ -13,8 +13,8 @@ schema: 2.0.0
## SYNTAX
```
Reset-PveVm -Node <String> -VmId <Int32> [-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
Reset-PveVm -Node <String> -VmId <Int32> [-Wait] [-Timeout <Int32>] [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -137,6 +137,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Timeout
Timeout in seconds for -Wait (default 60).
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
docs/cmdlets/Resize-PveContainerDisk.md
+41 -42
View File
@@ -13,8 +13,8 @@ Resizes a disk attached to an LXC container.
## SYNTAX
```
Resize-PveContainerDisk -Node <String> -VmId <Int32> -Disk <String> -Size <String>
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
Resize-PveContainerDisk -Node <String> -VmId <Int32> -Disk <String> -Size <String> [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -29,6 +29,36 @@ PS C:\> Resize-PveContainerDisk -Node pve1 -VmId 100 -Disk rootfs -Size +5G
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Disk
The disk/volume to resize (e.g. rootfs, mp0).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
@@ -44,30 +74,15 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -VmId
The container identifier.
### -Session
{{ Fill Session Description }}
```yaml
Type: Int32
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Disk
The disk/volume to resize (e.g. rootfs, mp0).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@@ -89,18 +104,18 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
### -VmId
The container identifier.
```yaml
Type: PveSession
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
@@ -119,21 +134,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Resume-PveContainer.md
+45 -46
View File
@@ -29,6 +29,21 @@ PS C:\> Resume-PveContainer -Node pve1 -VmId 100 -Wait
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
@@ -44,6 +59,36 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Timeout
Timeout in seconds for -Wait (default 60).
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 60
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The container identifier.
@@ -74,36 +119,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Timeout
Timeout in seconds for -Wait (default 60).
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 60
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -119,21 +134,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Resume-PveVm.md
+17 -2
View File
@@ -13,8 +13,8 @@ schema: 2.0.0
## SYNTAX
```
Resume-PveVm -Node <String> -VmId <Int32> [-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
Resume-PveVm -Node <String> -VmId <Int32> [-Wait] [-Timeout <Int32>] [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -137,6 +137,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Timeout
Timeout in seconds for -Wait (default 60).
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
docs/cmdlets/Send-PveFile.md
+70 -73
View File
@@ -30,68 +30,6 @@ PS C:\> Send-PveFile -Node pve1 -Storage local -Path ./ubuntu.iso -ContentType i
## PARAMETERS
### -Node
The PVE node name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Storage
The storage pool name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Path
Local path to the file to upload.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ContentType
Content type: iso, vztmpl, or import.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: iso, vztmpl, import
Required: False
Position: 3
Default value: iso
Accept pipeline input: False
Accept wildcard characters: False
```
### -Checksum
Checksum value to verify the upload.
@@ -114,7 +52,6 @@ Checksum algorithm (md5, sha1, sha256, sha512).
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: md5, sha1, sha256, sha512
Required: False
@@ -124,13 +61,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Wait
Wait for the task to complete before returning.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: False
Position: Named
@@ -139,6 +76,52 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ContentType
Content type: iso, vztmpl, or import.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: iso, vztmpl, import
Required: False
Position: 3
Default value: iso
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Path
Local path to the file to upload.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -154,13 +137,28 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -Storage
The storage pool name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Wait
Wait for the task to complete before returning.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -169,13 +167,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
@@ -202,7 +200,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/Set-PveApiToken.md
+45 -46
View File
@@ -30,36 +30,6 @@ PS C:\> Set-PveApiToken -UserId root@pam -TokenId mytoken -Comment 'Updated'
## PARAMETERS
### -UserId
The user ID (e.g. 'user@realm').
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -TokenId
The token identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Comment
Comment describing the token.
@@ -75,6 +45,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Expire
Expiration as Unix epoch (0 = no expiration).
@@ -120,6 +105,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -TokenId
The token identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -UserId
The user ID (e.g. 'user@realm').
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -135,21 +150,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -168,7 +168,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Set-PveBackupJob.md
+164 -168
View File
@@ -13,10 +13,10 @@ Updates a scheduled backup job on Proxmox VE.
## SYNTAX
```
Set-PveBackupJob [-Id] <String> [-Schedule <String>] [-Storage <String>] [-Mode <String>]
[-VmId <String>] [-All] [-Compress <String>] [-Node <String>] [-MailTo <String>]
[-MailNotification <String>] [-Enabled] [-Comment <String>] [-PruneBackups <String>]
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-PveBackupJob [-Id] <String> [-Schedule <String>] [-Storage <String>] [-Mode <String>] [-VmId <String>]
[-All] [-Compress <String>] [-Node <String>] [-MailTo <String>] [-MailNotification <String>] [-Enabled]
[-Comment <String>] [-PruneBackups <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -31,83 +31,6 @@ PS C:\> Set-PveBackupJob -Id backup-abc -Schedule '0 3 * * *'
## PARAMETERS
### -Id
The backup job ID.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Schedule
Cron-style schedule expression.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Storage
The target storage for backups.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Mode
The backup mode.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: snapshot, suspend, stop
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
Comma-separated list of VM IDs to back up.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -All
Back up all VMs.
@@ -123,85 +46,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Compress
The compression algorithm.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: zstd, lzo, gzip, none
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node to restrict the backup job to.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -MailTo
Email address(es) for notifications.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -MailNotification
When to send email notifications.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: always, failure
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Enabled
Enable or disable the backup job.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Comment
A comment or description for the backup job.
@@ -217,6 +61,129 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Compress
The compression algorithm.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: zstd, lzo, gzip, none
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Enabled
Enable or disable the backup job.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Id
The backup job ID.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -MailNotification
When to send email notifications.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: always, failure
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -MailTo
Email address(es) for notifications.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Mode
The backup mode.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: snapshot, suspend, stop
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node to restrict the backup job to.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -PruneBackups
Prune-backups configuration string.
@@ -232,6 +199,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Schedule
Cron-style schedule expression.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -247,13 +229,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -Storage
The target storage for backups.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -262,13 +244,28 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -VmId
Comma-separated list of VM IDs to back up.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
@@ -295,7 +292,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Set-PveDomain.md
+30 -31
View File
@@ -29,21 +29,6 @@ PS C:\> Set-PveDomain -Realm myldap -Comment 'Updated'
## PARAMETERS
### -Realm
The realm identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Comment
Updated comment or description for the domain.
@@ -59,6 +44,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Default
Set as the default authentication domain.
@@ -74,6 +74,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Realm
The realm identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -104,21 +119,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -137,7 +137,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Set-PveFirewallAlias.md
+76 -78
View File
@@ -30,68 +30,6 @@ PS C:\> Set-PveFirewallAlias -Level Cluster -Name myserver -Cidr 10.0.0.2/32
## PARAMETERS
### -Level
The firewall level: Cluster, Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Cluster, Node, Vm, Container
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
The alias name to update.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Cidr
The updated CIDR network address.
@@ -122,6 +60,67 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Level
The firewall level: Cluster, Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Cluster, Node, Vm, Container
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
The alias name to update.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -137,6 +136,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -152,21 +166,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -185,7 +184,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/Set-PveFirewallIpSetEntry.md
+57 -59
View File
@@ -13,9 +13,9 @@ Updates an entry in a firewall IP set.
## SYNTAX
```
Set-PveFirewallIpSetEntry [-Level] <String> [-Node <String>] [-VmId <Int32>] -Name <String>
-Cidr <String> [-NoMatch] [-Comment <String>] [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-PveFirewallIpSetEntry [-Level] <String> [-Node <String>] [-VmId <Int32>] -Name <String> -Cidr <String>
[-NoMatch] [-Comment <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -30,6 +30,51 @@ PS C:\> Set-PveFirewallIpSetEntry -Level Cluster -Name trusted -Cidr 10.0.0.0/24
## PARAMETERS
### -Cidr
The CIDR network address to update.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Comment
Updated comment for the entry.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Level
The firewall level: Cluster, Node, Vm, or Container.
@@ -37,7 +82,6 @@ The firewall level: Cluster, Node, Vm, or Container.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Cluster, Node, Vm, Container
Required: True
@@ -47,36 +91,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Name
The IP set name.
@@ -92,21 +106,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Cidr
The CIDR network address to update.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -NoMatch
Exclude this entry from the IP set match.
@@ -122,8 +121,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Comment
Updated comment for the entry.
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
@@ -152,13 +151,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: SwitchParameter
Type: Int32
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -167,13 +166,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
@@ -200,7 +199,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/Set-PveFirewallOptions.md
+50 -55
View File
@@ -13,10 +13,9 @@ Updates firewall options at the specified level.
## SYNTAX
```
Set-PveFirewallOptions [-Level] <String> [-Node <String>] [-VmId <Int32>] [-Enable]
[-PolicyIn <String>] [-PolicyOut <String>] [-LogLevelIn <String>] [-LogLevelOut <String>] [-Dhcp]
[-Ndp] [-MacFilter] [-IpFilter] [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
Set-PveFirewallOptions [-Level] <String> [-Node <String>] [-VmId <Int32>] [-Enable] [-PolicyIn <String>]
[-PolicyOut <String>] [-LogLevelIn <String>] [-LogLevelOut <String>] [-Dhcp] [-Ndp] [-MacFilter] [-IpFilter]
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -31,30 +30,13 @@ PS C:\> Set-PveFirewallOptions -Level Cluster -Enable -PolicyIn DROP
## PARAMETERS
### -Level
The firewall level: Cluster, Node, Vm, or Container.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Accepted values: Cluster, Node, Vm, Container
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: False
Position: Named
@@ -63,11 +45,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
### -Dhcp
Enable DHCP.
```yaml
Type: Int32
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
@@ -93,16 +75,14 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -PolicyIn
Default policy for incoming traffic.
### -IpFilter
Enable IP filter.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Accepted values: ACCEPT, DROP, REJECT
Required: False
Position: Named
Default value: None
@@ -110,18 +90,17 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -PolicyOut
Default policy for outgoing traffic.
### -Level
The firewall level: Cluster, Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Cluster, Node, Vm, Container
Accepted values: ACCEPT, DROP, REJECT
Required: False
Position: Named
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@@ -157,8 +136,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Dhcp
Enable DHCP.
### -MacFilter
Enable MAC address filter.
```yaml
Type: SwitchParameter
@@ -187,11 +166,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -MacFilter
Enable MAC address filter.
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
@@ -202,13 +181,30 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -IpFilter
Enable IP filter.
### -PolicyIn
Default policy for incoming traffic.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: ACCEPT, DROP, REJECT
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -PolicyOut
Default policy for outgoing traffic.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: ACCEPT, DROP, REJECT
Required: False
Position: Named
@@ -232,13 +228,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: SwitchParameter
Type: Int32
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -247,13 +243,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
@@ -280,7 +276,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/Set-PveFirewallRule.md
+118 -123
View File
@@ -13,11 +13,10 @@ Updates a firewall rule.
## SYNTAX
```
Set-PveFirewallRule [-Level] <String> [-Node <String>] [-VmId <Int32>] -Position <Int32>
[-Type <String>] [-Action <String>] [-Enable] [-Source <String>] [-Dest <String>] [-Proto <String>]
[-Dport <String>] [-Sport <String>] [-Comment <String>] [-Macro <String>] [-Log <String>]
[-Iface <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Set-PveFirewallRule [-Level] <String> [-Node <String>] [-VmId <Int32>] -Position <Int32> [-Type <String>]
[-Action <String>] [-Enable] [-Source <String>] [-Dest <String>] [-Proto <String>] [-Dport <String>]
[-Sport <String>] [-Comment <String>] [-Macro <String>] [-Log <String>] [-Iface <String>]
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -32,85 +31,6 @@ PS C:\> Set-PveFirewallRule -Level Cluster -Position 0 -Enable
## PARAMETERS
### -Level
The firewall level: Cluster, Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Cluster, Node, Vm, Container
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Position
The rule position to update.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Type
The rule type: in, out, or group.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: in, out, group
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Action
The rule action: ACCEPT, DROP, or REJECT.
@@ -118,7 +38,6 @@ The rule action: ACCEPT, DROP, or REJECT.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: ACCEPT, DROP, REJECT
Required: False
@@ -128,11 +47,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Enable
Enable the rule.
### -Comment
Rule comment.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
@@ -143,13 +62,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Source
Source address or alias.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: False
Position: Named
@@ -173,21 +92,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Proto
Protocol (e.g., tcp, udp, icmp).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Dport
Destination port.
@@ -203,8 +107,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Sport
Source port.
### -Enable
Enable the rule.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Iface
Network interface.
```yaml
Type: String
@@ -218,8 +137,24 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Comment
Rule comment.
### -Level
The firewall level: Cluster, Node, Vm, or Container.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Cluster, Node, Vm, Container
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Log
Log level.
```yaml
Type: String
@@ -248,8 +183,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Log
Log level.
### -Node
The node name. Required when Level is Node, Vm, or Container.
```yaml
Type: String
@@ -263,8 +198,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Iface
Network interface.
### -Position
The rule position to update.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Proto
Protocol (e.g., tcp, udp, icmp).
```yaml
Type: String
@@ -293,13 +243,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -Source
Source address or alias.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -308,13 +258,59 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -Sport
Source port.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Type
The rule type: in, out, or group.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: in, out, group
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM/Container ID. Required when Level is Vm or Container.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
@@ -341,7 +337,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/Set-PveGroup.md
+30 -31
View File
@@ -29,21 +29,6 @@ PS C:\> Set-PveGroup -GroupId admins -Comment 'Updated'
## PARAMETERS
### -GroupId
The group identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Comment
Updated comment or description.
@@ -59,6 +44,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -GroupId
The group identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -89,21 +104,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -122,7 +122,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Set-PveNetwork.md
+19 -4
View File
@@ -13,10 +13,10 @@ schema: 2.0.0
## SYNTAX
```
Set-PveNetwork [-Node] <String> [-Iface] <String> [-Address <String>] [-Netmask <String>] [-Gateway <String>]
[-Address6 <String>] [-Netmask6 <Int32>] [-Gateway6 <String>] [-BridgePorts <String>] [-BondSlaves <String>]
[-Mtu <Int32>] [-Autostart] [-Comments <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
Set-PveNetwork [-Node] <String> [-Iface] <String> -Type <String> [-Address <String>] [-Netmask <String>]
[-Gateway <String>] [-Address6 <String>] [-Netmask6 <Int32>] [-Gateway6 <String>] [-BridgePorts <String>]
[-BondSlaves <String>] [-Mtu <Int32>] [-Autostart] [-Comments <String>] [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -289,6 +289,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Type
Interface type (bridge, bond, eth, vlan, OVSBridge).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
docs/cmdlets/Set-PveNodeConfig.md
+33 -34
View File
@@ -29,6 +29,36 @@ PS C:\> Set-PveNodeConfig -Node pve1 -Description 'Primary node'
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Description
Node description or comment.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
@@ -44,11 +74,11 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Description
Node description or comment.
### -Session
{{ Fill Session Description }}
```yaml
Type: String
Type: PveSession
Parameter Sets: (All)
Aliases:
@@ -74,21 +104,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -104,21 +119,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -137,7 +137,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Set-PveNodeDns.md
+36 -37
View File
@@ -29,31 +29,16 @@ PS C:\> Set-PveNodeDns -Node pve1 -Search example.com -Dns1 8.8.8.8
## PARAMETERS
### -Node
The PVE node name.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Search
The DNS search domain.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@@ -104,6 +89,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Search
The DNS search domain.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -134,21 +149,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -167,7 +167,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Set-PvePassword.md
+21 -22
View File
@@ -29,16 +29,16 @@ PS C:\> Set-PvePassword -UserId admin@pve -Password (Read-Host -AsSecureString)
## PARAMETERS
### -UserId
The user ID in user@realm format.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 0
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
@@ -74,6 +74,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -UserId
The user ID in user@realm format.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -89,21 +104,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -122,7 +122,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
docs/cmdlets/Set-PvePool.md
+27 -28
View File
@@ -29,23 +29,38 @@ PS C:\> Set-PvePool -PoolId production -Comment 'Updated'
## PARAMETERS
### -PoolId
The pool ID to update.
### -Comment
An optional comment or description.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept pipeline input: False
Accept wildcard characters: False
```
### -Comment
An optional comment or description.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Delete
Comma-separated list of members to remove.
```yaml
Type: String
@@ -74,18 +89,18 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Delete
Comma-separated list of members to remove.
### -PoolId
The pool ID to update.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
@@ -119,21 +134,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Set-PveRole.md
+22 -23
View File
@@ -29,18 +29,18 @@ PS C:\> Set-PveRole -RoleId MyRole -Privileges 'VM.Audit,VM.Console'
## PARAMETERS
### -RoleId
The role identifier.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 0
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept pipeline input: False
Accept wildcard characters: False
```
@@ -59,6 +59,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -RoleId
The role identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -89,21 +104,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -122,7 +122,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Set-PveSdnController.md
+34 -35
View File
@@ -29,21 +29,6 @@ PS C:\> Set-PveSdnController -Controller bgp1 -Asn 65002
## PARAMETERS
### -Controller
The SDN controller identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Asn
The Autonomous System Number for BGP/EVPN.
@@ -59,8 +44,38 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Peers
Comma-separated list of BGP peer addresses.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Controller
The SDN controller identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Node
The node this controller is configured on.
```yaml
Type: String
@@ -74,8 +89,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node this controller is configured on.
### -Peers
Comma-separated list of BGP peer addresses.
```yaml
Type: String
@@ -119,21 +134,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Set-PveSdnDns.md
+33 -34
View File
@@ -29,6 +29,21 @@ PS C:\> Set-PveSdnDns -Dns pdns1 -Url https://dns2.example.com
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Dns
The SDN DNS plugin identifier.
@@ -44,21 +59,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Url
The DNS server URL.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Key
The TSIG key for DNS updates.
@@ -89,6 +89,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Ttl
The TTL for DNS records.
@@ -104,11 +119,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
### -Url
The DNS server URL.
```yaml
Type: PveSession
Type: String
Parameter Sets: (All)
Aliases:
@@ -134,21 +149,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -167,7 +167,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Set-PveSdnIpam.md
+39 -40
View File
@@ -13,8 +13,8 @@ Updates an SDN IPAM plugin configuration in Proxmox VE.
## SYNTAX
```
Set-PveSdnIpam [-Ipam] <String> [-Url <String>] [-Token <String>] [-Section <Int32>]
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-PveSdnIpam [-Ipam] <String> [-Url <String>] [-Token <String>] [-Section <Int32>] [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -29,6 +29,21 @@ PS C:\> Set-PveSdnIpam -Ipam myipam -Url https://ipam.example.com
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Ipam
The SDN IPAM plugin identifier.
@@ -44,36 +59,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Url
The IPAM server URL.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Token
The API token for the IPAM server.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Section
The section ID in the IPAM server.
@@ -104,13 +89,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -Token
The API token for the IPAM server.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -119,13 +104,28 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -Url
The IPAM server URL.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Set-PveSdnSubnet.md
+48 -49
View File
@@ -13,9 +13,9 @@ Updates an SDN subnet configuration in Proxmox VE.
## SYNTAX
```
Set-PveSdnSubnet [-Vnet] <String> [-Subnet] <String> [-Gateway <String>] [-Snat]
[-DnsZonePrefix <String>] [-DhcpRange <String>] [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-PveSdnSubnet [-Vnet] <String> [-Subnet] <String> [-Gateway <String>] [-Snat] [-DnsZonePrefix <String>]
[-DhcpRange <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
```
## DESCRIPTION
@@ -30,43 +30,13 @@ PS C:\> Set-PveSdnSubnet -Vnet myvnet -Subnet 10.0.0.0/24 -Gateway 10.0.0.1
## PARAMETERS
### -Vnet
The SDN VNet name.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Subnet
The subnet CIDR.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Gateway
Gateway address for this subnet.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: False
Position: Named
@@ -75,11 +45,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Snat
Enable SNAT for this subnet.
### -DhcpRange
DHCP range for this subnet.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases:
@@ -105,8 +75,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -DhcpRange
DHCP range for this subnet.
### -Gateway
Gateway address for this subnet.
```yaml
Type: String
@@ -135,13 +105,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -Snat
Enable SNAT for this subnet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -150,13 +120,43 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -Subnet
The subnet CIDR.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Vnet
The SDN VNet name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
@@ -183,7 +183,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Set-PveSdnVnet.md
+28 -29
View File
@@ -29,21 +29,6 @@ PS C:\> Set-PveSdnVnet -Vnet myvnet -Zone myzone
## PARAMETERS
### -Vnet
The SDN VNet name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Alias
An alias for the VNet.
@@ -59,11 +44,26 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Zone
The zone this VNet belongs to.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
@@ -104,18 +104,18 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
### -Vnet
The SDN VNet name.
```yaml
Type: PveSession
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
@@ -134,13 +134,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -Zone
The zone this VNet belongs to.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
@@ -167,7 +167,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Set-PveSdnZone.md
+18 -19
View File
@@ -29,18 +29,18 @@ PS C:\> Set-PveSdnZone -Zone myzone -Dns pdns1
## PARAMETERS
### -Zone
The SDN zone name.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 0
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept pipeline input: False
Accept wildcard characters: False
```
@@ -59,8 +59,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Reversedns
Reverse DNS server.
### -DnsZone
DNS zone name for registration.
```yaml
Type: String
@@ -74,8 +74,8 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -DnsZone
DNS zone name for registration.
### -Reversedns
Reverse DNS server.
```yaml
Type: String
@@ -119,18 +119,18 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -Zone
The SDN zone name.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: cf
Aliases:
Required: False
Position: Named
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Set-PveStorage.md
+46 -47
View File
@@ -14,8 +14,8 @@ Updates a Proxmox VE storage definition.
```
Set-PveStorage [-Storage] <String> [-Content <String>] [-Nodes <String>] [-Enabled] [-Shared]
[-AdditionalConfig <Hashtable>] [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
[-AdditionalConfig <Hashtable>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -30,26 +30,11 @@ PS C:\> Set-PveStorage -Storage local -Content 'images,iso,backup'
## PARAMETERS
### -Storage
The storage identifier.
### -AdditionalConfig
Additional configuration parameters as a hashtable.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Content
Comma-separated content types.
```yaml
Type: String
Type: Hashtable
Parameter Sets: (All)
Aliases:
@@ -60,8 +45,23 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Nodes
Comma-separated list of nodes.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Content
Comma-separated content types.
```yaml
Type: String
@@ -90,26 +90,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Shared
Whether the storage is shared.
### -Nodes
Comma-separated list of nodes.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -AdditionalConfig
Additional configuration parameters as a hashtable.
```yaml
Type: Hashtable
Type: String
Parameter Sets: (All)
Aliases:
@@ -135,13 +120,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -Shared
Whether the storage is shared.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -150,13 +135,28 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -Storage
The storage identifier.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
@@ -183,7 +183,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Set-PveStorageContent.md
+45 -46
View File
@@ -29,6 +29,21 @@ PS C:\> Set-PveStorageContent -Node pve1 -Storage local -Volume 'local:iso/ubunt
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
@@ -44,6 +59,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Notes
Notes or description for the volume.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Storage
The storage pool name.
@@ -74,36 +119,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Notes
Notes or description for the volume.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -119,21 +134,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Set-PveVmGuestPassword.md
+67 -69
View File
@@ -13,9 +13,8 @@ Sets a user password inside the guest via the QEMU guest agent.
## SYNTAX
```
Set-PveVmGuestPassword [-Node] <String> [-VmId] <Int32> -Username <String> -Password <SecureString>
[-Crypted] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Set-PveVmGuestPassword [-Node] <String> [-VmId] <Int32> -Username <String> -Password <SecureString> [-Crypted]
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -30,60 +29,15 @@ PS C:\> Set-PveVmGuestPassword -Node pve1 -VmId 100 -Username root -Password (Re
## PARAMETERS
### -Node
The PVE node name.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Username
The username whose password to set.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Password
The new password.
```yaml
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@@ -105,6 +59,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Password
The new password.
```yaml
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -120,6 +104,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Username
The username whose password to set.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -135,21 +149,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -168,7 +167,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.Int32
docs/cmdlets/Start-PveContainer.md
+16 -1
View File
@@ -13,7 +13,7 @@ schema: 2.0.0
## SYNTAX
```
Start-PveContainer -Node <String> -VmId <Int32> [-Wait] [-Session <PveSession>]
Start-PveContainer -Node <String> -VmId <Int32> [-Wait] [-Timeout <Int32>] [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
@@ -137,6 +137,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Timeout
Timeout in seconds for -Wait (default 60).
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
docs/cmdlets/Start-PveNodeVms.md
+22 -23
View File
@@ -29,6 +29,21 @@ PS C:\> Start-PveNodeVms -Node pve1
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
@@ -44,21 +59,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -VmIds
Comma-separated list of VM IDs to start.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -74,13 +74,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
### -VmIds
Comma-separated list of VM IDs to start.
```yaml
Type: SwitchParameter
Type: String
Parameter Sets: (All)
Aliases: wi
Aliases:
Required: False
Position: Named
@@ -89,13 +89,13 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Aliases: wi
Required: False
Position: Named
@@ -122,7 +122,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Start-PveVm.md
+17 -2
View File
@@ -13,8 +13,8 @@ schema: 2.0.0
## SYNTAX
```
Start-PveVm -Node <String> -VmId <Int32> [-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
Start-PveVm -Node <String> -VmId <Int32> [-Wait] [-Timeout <Int32>] [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -137,6 +137,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Timeout
Timeout in seconds for -Wait (default 60).
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
docs/cmdlets/Stop-PveContainer.md
+16 -1
View File
@@ -13,7 +13,7 @@ schema: 2.0.0
## SYNTAX
```
Stop-PveContainer -Node <String> -VmId <Int32> [-Wait] [-Session <PveSession>]
Stop-PveContainer -Node <String> -VmId <Int32> [-Wait] [-Timeout <Int32>] [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
@@ -137,6 +137,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Timeout
Timeout in seconds for -Wait (default 60).
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
docs/cmdlets/Stop-PveNodeVms.md
+34 -35
View File
@@ -29,28 +29,13 @@ PS C:\> Stop-PveNodeVms -Node pve1
## PARAMETERS
### -Node
The PVE node name.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -VmIds
Comma-separated list of VM IDs to stop.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: False
Position: Named
@@ -74,6 +59,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -89,6 +89,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmIds
Comma-separated list of VM IDs to stop.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -104,21 +119,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -137,7 +137,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Stop-PveTask.md
+32 -33
View File
@@ -13,8 +13,8 @@ Stops a running task on a Proxmox VE node.
## SYNTAX
```
Stop-PveTask [-Node] <String> [-Upid] <String> [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
Stop-PveTask [-Node] <String> [-Upid] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -29,6 +29,21 @@ PS C:\> Stop-PveTask -Node pve1 -Upid 'UPID:pve1:...'
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
@@ -44,6 +59,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Upid
The task UPID.
@@ -59,21 +89,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -89,21 +104,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -122,7 +122,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Stop-PveVm.md
+17 -2
View File
@@ -13,8 +13,8 @@ schema: 2.0.0
## SYNTAX
```
Stop-PveVm -Node <String> -VmId <Int32> [-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
Stop-PveVm -Node <String> -VmId <Int32> [-Wait] [-Timeout <Int32>] [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -137,6 +137,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Timeout
Timeout in seconds for -Wait (default 60).
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
docs/cmdlets/Suspend-PveContainer.md
+45 -46
View File
@@ -29,6 +29,21 @@ PS C:\> Suspend-PveContainer -Node pve1 -VmId 100 -Wait
## PARAMETERS
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
@@ -44,6 +59,36 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Timeout
Timeout in seconds for -Wait (default 60).
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 60
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The container identifier.
@@ -74,36 +119,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Timeout
Timeout in seconds for -Wait (default 60).
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 60
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
```yaml
Type: PveSession
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -119,21 +134,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
docs/cmdlets/Suspend-PveVm.md
+17 -2
View File
@@ -13,8 +13,8 @@ schema: 2.0.0
## SYNTAX
```
Suspend-PveVm -Node <String> -VmId <Int32> [-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
Suspend-PveVm -Node <String> -VmId <Int32> [-Wait] [-Timeout <Int32>] [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -137,6 +137,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Timeout
Timeout in seconds for -Wait (default 60).
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
docs/cmdlets/Write-PveVmGuestFile.md
+52 -53
View File
@@ -13,8 +13,8 @@ Writes content to a file on the guest filesystem via the QEMU guest agent.
## SYNTAX
```
Write-PveVmGuestFile [-Node] <String> [-VmId] <Int32> -File <String> -Content <String>
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
Write-PveVmGuestFile [-Node] <String> [-VmId] <Int32> -File <String> -Content <String> [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -29,45 +29,15 @@ PS C:\> Write-PveVmGuestFile -Node pve1 -VmId 100 -File /tmp/test.txt -Content '
## PARAMETERS
### -Node
The PVE node name.
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Aliases: cf
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -File
The file path inside the guest to write.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
@@ -89,6 +59,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -File
The file path inside the guest to write.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The PVE node name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session
{{ Fill Session Description }}
@@ -104,6 +104,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -VmId
The VM identifier.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -119,21 +134,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.Int32
generate-help.ps1
+46 -9
View File
@@ -1,20 +1,28 @@
#!/usr/bin/env pwsh
<#
.SYNOPSIS
Generates platyPS markdown help stubs and MAML XML help for PSProxmoxVE.
Generates platyPS markdown help and MAML XML help for PSProxmoxVE.
.DESCRIPTION
This script:
1. Builds the module to publish/netstandard2.0/
2. Installs platyPS if needed
3. Generates markdown help stubs in docs/cmdlets/
4. Generates MAML XML help in publish/netstandard2.0/
5. Copies the MAML XML to src/PSProxmoxVE/ for inclusion in builds
3. Creates markdown stubs for NEW cmdlets only (preserves existing docs)
4. Updates existing markdown docs (merges parameter changes, preserves descriptions/examples)
5. Generates MAML XML help from the markdown
6. Copies the MAML XML to src/PSProxmoxVE/ for inclusion in builds
.PARAMETER Force
Regenerate all markdown from scratch, overwriting hand-written content.
Use with caution — this will replace all descriptions and examples.
.NOTES
Run from the repository root:
pwsh -NoProfile -File ./generate-help.ps1
#>
param(
[switch]$Force
)
$ErrorActionPreference = 'Stop'
Set-StrictMode -Version Latest
@@ -25,7 +33,10 @@ Push-Location $repoRoot
try {
# Step 1: Build the module
Write-Host "Building module..." -ForegroundColor Cyan
dotnet publish src/PSProxmoxVE/PSProxmoxVE.csproj --configuration Release --framework netstandard2.0 --output ./publish/netstandard2.0 | Out-Null
dotnet publish src/PSProxmoxVE/PSProxmoxVE.csproj `
--configuration Release `
--framework netstandard2.0 `
--output ./publish/netstandard2.0 | Out-Null
Remove-Item ./publish/netstandard2.0/*.deps.json, ./publish/netstandard2.0/*.runtimeconfig.json -ErrorAction SilentlyContinue
# Step 2: Install platyPS if needed
@@ -45,14 +56,40 @@ try {
New-Item -ItemType Directory -Path $docsDir -Force | Out-Null
}
# Step 5: Generate markdown help stubs
Write-Host "Generating markdown help stubs..." -ForegroundColor Cyan
# Step 5: Generate or update markdown help
$existingDocs = Get-ChildItem "$docsDir/*.md" -ErrorAction SilentlyContinue
if ($Force -or $existingDocs.Count -eq 0) {
# Full generation — creates all markdown from scratch
Write-Host "Generating all markdown help (full)..." -ForegroundColor Cyan
New-MarkdownHelp -Module PSProxmoxVE -OutputFolder $docsDir -Force | Out-Null
}
else {
# Update existing docs: merge parameter/syntax changes, preserve descriptions & examples
Write-Host "Updating existing markdown help (merge)..." -ForegroundColor Cyan
Update-MarkdownHelp -Path $docsDir -Force | Out-Null
# Create stubs for any NEW cmdlets not yet documented
$documentedCmdlets = @($existingDocs | ForEach-Object { $_.BaseName })
$moduleCmdlets = @((Get-Command -Module PSProxmoxVE -CommandType Cmdlet).Name)
$newCmdlets = @($moduleCmdlets | Where-Object { $_ -notin $documentedCmdlets })
if ($newCmdlets.Count -gt 0) {
Write-Host " Creating stubs for $($newCmdlets.Count) new cmdlet(s):" -ForegroundColor Yellow
foreach ($cmdlet in $newCmdlets) {
Write-Host " + $cmdlet" -ForegroundColor Yellow
New-MarkdownHelp -Command $cmdlet -OutputFolder $docsDir -Force | Out-Null
}
}
else {
Write-Host " No new cmdlets to document" -ForegroundColor Green
}
}
$mdCount = (Get-ChildItem "$docsDir/*.md" | Measure-Object).Count
Write-Host " Generated $mdCount markdown files" -ForegroundColor Green
Write-Host " Markdown files: $mdCount" -ForegroundColor Green
# Step 6: Generate MAML XML help
# Step 6: Generate MAML XML help from markdown
Write-Host "Generating MAML XML help..." -ForegroundColor Cyan
New-ExternalHelp -Path $docsDir -OutputPath ./publish/netstandard2.0/ -Force | Out-Null
src/PSProxmoxVE/PSProxmoxVE.dll-Help.xml
+20886 -9
View File
File diff suppressed because it is too large Load Diff