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

- 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
+16 -16
View File
@@ -38,22 +38,6 @@ Returns only VM resources across the cluster.
## PARAMETERS ## 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 ### -Node
Filter results to a specific node name. Filter results to a specific node name.
@@ -84,6 +68,22 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+15 -15
View File
@@ -46,21 +46,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -76,6 +61,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+19 -19
View File
@@ -47,8 +47,8 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Node ### -Name
The node name. Required when Level is Node, Vm, or Container. Optional alias name to filter by.
```yaml ```yaml
Type: String Type: String
@@ -62,23 +62,8 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -VmId ### -Node
The VM/Container ID. Required when Level is Vm or Container. The node name. Required when Level is Node, 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.
```yaml ```yaml
Type: String Type: String
@@ -107,6 +92,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+19 -19
View File
@@ -47,8 +47,8 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Node ### -Name
The node name. Required when Level is Node, Vm, or Container. Optional IP set name to filter by.
```yaml ```yaml
Type: String Type: String
@@ -62,23 +62,8 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -VmId ### -Node
The VM/Container ID. Required when Level is Vm or Container. The node name. Required when Level is Node, 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.
```yaml ```yaml
Type: String Type: String
@@ -107,6 +92,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+30 -30
View File
@@ -47,36 +47,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Name
The IP set name. The IP set name.
@@ -92,6 +62,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -107,6 +92,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+6 -6
View File
@@ -62,11 +62,11 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -VmId ### -Session
The VM/Container ID. Required when Level is Vm or Container. {{ Fill Session Description }}
```yaml ```yaml
Type: Int32 Type: PveSession
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
@@ -77,11 +77,11 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Session ### -VmId
{{ Fill Session Description }} The VM/Container ID. Required when Level is Vm or Container.
```yaml ```yaml
Type: PveSession Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
+8 -8
View File
@@ -13,8 +13,8 @@ Lists firewall references at the specified level.
## SYNTAX ## SYNTAX
``` ```
Get-PveFirewallRef [-Level] <String> [-Node <String>] [-VmId <Int32>] [-Type <String>] Get-PveFirewallRef [-Level] <String> [-Node <String>] [-VmId <Int32>] [-Type <String>] [-Session <PveSession>]
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [<CommonParameters>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -62,11 +62,11 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -VmId ### -Session
The VM/Container ID. Required when Level is Vm or Container. {{ Fill Session Description }}
```yaml ```yaml
Type: Int32 Type: PveSession
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
@@ -92,11 +92,11 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Session ### -VmId
{{ Fill Session Description }} The VM/Container ID. Required when Level is Vm or Container.
```yaml ```yaml
Type: PveSession Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
+15 -15
View File
@@ -62,21 +62,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Position
Optional rule position to filter by. Optional rule position to filter by.
@@ -107,6 +92,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+15 -15
View File
@@ -46,21 +46,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -76,6 +61,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+20 -20
View File
@@ -38,6 +38,21 @@ Returns the 10 most recent tasks for VM 100.
## PARAMETERS ## 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 ### -Node
The PVE node name. The PVE node name.
@@ -53,11 +68,11 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -VmId ### -Session
Filter tasks by VM ID. {{ Fill Session Description }}
```yaml ```yaml
Type: Int32 Type: PveSession
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
@@ -99,29 +114,14 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Limit ### -VmId
Maximum number of tasks to return. Defaults to 50. Filter tasks by VM ID.
```yaml ```yaml
Type: Int32 Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: 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 Required: False
Position: Named Position: Named
Default value: None Default value: None
+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] 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 ## DESCRIPTION
@@ -152,6 +152,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### 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). 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).
+15 -15
View File
@@ -46,21 +46,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -76,6 +61,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+15 -15
View File
@@ -46,21 +46,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -76,6 +61,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+90 -90
View File
@@ -32,6 +32,66 @@ Imports an OVA file into a new VM on node pve1.
## PARAMETERS ## 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 ### -Node
The PVE node name. The PVE node name.
@@ -47,21 +107,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Path
Local path to the OVA file. Local path to the OVA file.
@@ -77,6 +122,36 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -TargetStorage
Target storage for imported VM disks. Target storage for imported VM disks.
@@ -107,51 +182,6 @@ Accept pipeline input: False
Accept wildcard characters: 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
Wait for all tasks to complete before returning. Wait for all tasks to complete before returning.
@@ -167,21 +197,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+63 -63
View File
@@ -13,7 +13,7 @@ Imports a disk image into a Proxmox VE virtual machine.
## SYNTAX ## 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] [-Format <String>] [-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>] [<CommonParameters>]
``` ```
@@ -32,33 +32,18 @@ Imports a cloud image into VM 100.
## PARAMETERS ## PARAMETERS
### -Node ### -Confirm
The PVE node name. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
Required: True Required: False
Position: Named Position: Named
Default value: None Default value: None
Accept pipeline input: True (ByPropertyName) 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 Accept wildcard characters: False
``` ```
@@ -77,36 +62,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Format
Target disk format (qcow2, raw, vmdk). Target disk format (qcow2, raw, vmdk).
@@ -123,18 +78,18 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Wait ### -Node
Wait for the import task to complete. The PVE node name.
```yaml ```yaml
Type: SwitchParameter Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: True
Position: Named Position: Named
Default value: None Default value: None
Accept pipeline input: False Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False Accept wildcard characters: False
``` ```
@@ -153,13 +108,58 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -Source
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -168,13 +168,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
+15 -15
View File
@@ -31,6 +31,21 @@ Applies all pending SDN configuration changes.
## PARAMETERS ## 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -61,21 +76,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+17 -1
View File
@@ -14,7 +14,8 @@ schema: 2.0.0
``` ```
Invoke-PveVmGuestExec [-Node] <String> [-VmId] <Int32> [-Command] <String> [-Args <String[]>] 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 ## DESCRIPTION
@@ -152,6 +153,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### 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). 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).
+30 -30
View File
@@ -31,6 +31,21 @@ Triggers fstrim on VM 100.
## PARAMETERS ## 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 ### -Node
The PVE node name. The PVE node name.
@@ -46,6 +61,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -VmId
The VM identifier. The VM identifier.
@@ -61,21 +91,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: 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 ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+60 -60
View File
@@ -31,6 +31,36 @@ Moves the rootfs volume of container 100 to local-lvm storage.
## PARAMETERS ## 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 ### -Node
The PVE node name. The PVE node name.
@@ -46,6 +76,36 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: 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 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 ### -VmId
The container identifier. The container identifier.
@@ -76,36 +136,6 @@ Accept pipeline input: False
Accept wildcard characters: 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
Wait for the task to complete before returning. Wait for the task to complete before returning.
@@ -121,21 +151,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+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] Move-PveVmDisk -Node <String> -VmId <Int32> -Disk <String> -Storage <String> [-Format <String>] [-Delete]
[-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
[<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -32,53 +31,38 @@ Moves the scsi0 disk of VM 100 to local-lvm storage.
## PARAMETERS ## PARAMETERS
### -Node ### -Confirm
The PVE node name. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) 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 wildcard characters: False
```
### -Disk
The disk slot to move (e.g. scsi0, virtio0).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named Position: Named
Default value: None Default value: None
Accept pipeline input: False Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Storage ### -Delete
The target storage identifier. 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 ```yaml
Type: String Type: String
@@ -108,33 +92,18 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Delete ### -Node
Delete the original disk after move (default true). The PVE node name.
```yaml ```yaml
Type: SwitchParameter Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: True
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
Position: Named Position: Named
Default value: None Default value: None
Accept pipeline input: False Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False Accept wildcard characters: False
``` ```
@@ -153,13 +122,43 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -Storage
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -168,13 +167,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
+48 -48
View File
@@ -32,43 +32,29 @@ Creates a snapshot backup of VM 100 and waits for completion.
## PARAMETERS ## PARAMETERS
### -Node ### -Compress
The PVE node name. The compression algorithm.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Accepted values: zstd, lzo, gzip, none
Required: True Required: False
Position: 0 Position: Named
Default value: None Default value: None
Accept pipeline input: True (ByPropertyName) Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -VmId ### -Confirm
The VM identifier. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: Int32 Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
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:
Required: False Required: False
Position: Named Position: Named
@@ -93,14 +79,28 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Compress ### -Node
The compression algorithm. The PVE node name.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: 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 Required: False
Position: Named Position: Named
@@ -109,11 +109,11 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Wait ### -Storage
Wait for the task to complete before returning. The target storage for the backup.
```yaml ```yaml
Type: SwitchParameter Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
@@ -139,11 +139,26 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Session ### -VmId
{{ Fill Session Description }} The VM identifier.
```yaml ```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) Parameter Sets: (All)
Aliases: Aliases:
@@ -169,21 +184,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+145 -145
View File
@@ -33,67 +33,6 @@ Creates a nightly backup job at 2 AM.
## PARAMETERS ## 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 ### -All
Back up all VMs. Back up all VMs.
@@ -109,83 +48,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Comment
A comment or description for the backup job. A comment or description for the backup job.
@@ -201,6 +63,114 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -PruneBackups
Prune-backups configuration string. Prune-backups configuration string.
@@ -216,6 +186,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -231,13 +216,28 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -Storage
Shows what would happen if the cmdlet runs. The cmdlet is not run. The target storage for backups.
```yaml ```yaml
Type: SwitchParameter Type: String
Parameter Sets: (All) 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 Required: False
Position: Named Position: Named
@@ -246,13 +246,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
+30 -30
View File
@@ -31,6 +31,21 @@ Converts container 100 to a template.
## PARAMETERS ## 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 ### -Node
The PVE node name. The PVE node name.
@@ -46,21 +61,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: 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
```
### -Session ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -76,6 +76,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+46 -46
View File
@@ -31,37 +31,6 @@ Creates a new LDAP authentication domain.
## PARAMETERS ## 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
Comment or description for the domain. Comment or description for the domain.
@@ -77,6 +46,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Default
Set as the default authentication domain. Set as the default authentication domain.
@@ -92,6 +76,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -107,6 +106,22 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+76 -76
View File
@@ -32,67 +32,6 @@ Creates a cluster-level firewall alias.
## PARAMETERS ## 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 ### -Cidr
The CIDR network address. The CIDR network address.
@@ -123,6 +62,67 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -138,6 +138,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+30 -30
View File
@@ -31,21 +31,6 @@ Creates a security group named webservers.
## PARAMETERS ## 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 ### -Comment
Optional comment for the security group. Optional comment for the security group.
@@ -61,6 +46,36 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -91,21 +106,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
+39 -39
View File
@@ -31,6 +31,36 @@ Creates a cluster-level IP set named trusted.
## PARAMETERS ## 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 ### -Level
The firewall level: Cluster, Node, Vm, or Container. The firewall level: Cluster, Node, Vm, or Container.
@@ -47,36 +77,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Name
The IP set name. The IP set name.
@@ -92,8 +92,8 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Comment ### -Node
Optional comment for the IP set. The node name. Required when Level is Node, Vm, or Container.
```yaml ```yaml
Type: String Type: String
@@ -122,13 +122,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -VmId
Shows what would happen if the cmdlet runs. The cmdlet is not run. The VM/Container ID. Required when Level is Vm or Container.
```yaml ```yaml
Type: SwitchParameter Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -137,13 +137,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
+61 -63
View File
@@ -13,9 +13,9 @@ Adds an entry to a firewall IP set.
## SYNTAX ## SYNTAX
``` ```
New-PveFirewallIpSetEntry [-Level] <String> [-Node <String>] [-VmId <Int32>] -Name <String> New-PveFirewallIpSetEntry [-Level] <String> [-Node <String>] [-VmId <Int32>] -Name <String> -Cidr <String>
-Cidr <String> [-NoMatch] [-Comment <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-NoMatch] [-Comment <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-WhatIf] [-Confirm] [<CommonParameters>] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -30,14 +30,58 @@ PS C:\> New-PveFirewallIpSetEntry -Level Cluster -Name trusted -Cidr 10.0.0.0/24
## PARAMETERS ## 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 ### -Level
The firewall level: Cluster, Node, Vm, or Container. The firewall level: Cluster, Node, Vm, or Container.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Accepted values: Cluster, Node, Vm, Container Accepted values: Cluster, Node, Vm, Container
Required: True Required: True
@@ -47,58 +91,13 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Name
The IP set name. The IP set name.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Cidr
The CIDR network address to add.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True Required: True
Position: Named Position: Named
@@ -113,7 +112,7 @@ Exclude this entry from the IP set match.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -122,13 +121,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Comment ### -Node
Optional comment for the entry. The node name. Required when Level is Node, Vm, or Container.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -152,13 +151,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -VmId
Shows what would happen if the cmdlet runs. The cmdlet is not run. The VM/Container ID. Required when Level is Vm or Container.
```yaml ```yaml
Type: SwitchParameter Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -167,13 +166,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -200,7 +199,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+145 -149
View File
@@ -31,78 +31,13 @@ PS C:\> New-PveFirewallRule -Level Cluster -Type in -Action ACCEPT -Proto tcp -D
## PARAMETERS ## 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 ### -Action
The rule action: ACCEPT, DROP, or REJECT. The rule action: ACCEPT, DROP, or REJECT.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Accepted values: ACCEPT, DROP, REJECT Accepted values: ACCEPT, DROP, REJECT
Required: True Required: True
@@ -112,13 +47,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Enable ### -Comment
Enable the rule. Rule comment.
```yaml ```yaml
Type: SwitchParameter Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -127,13 +62,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Source ### -Confirm
Source address or alias. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
Required: False Required: False
Position: Named Position: Named
@@ -148,22 +83,7 @@ Destination address or alias.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Proto
Protocol (e.g., tcp, udp, icmp).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -178,7 +98,7 @@ Destination port.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -187,58 +107,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Sport ### -Enable
Source port. Enable the rule.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Comment
Rule comment.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Macro
Macro name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Log
Log level.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -253,7 +128,83 @@ Network interface.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
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
```
### -Log
Log level.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Macro
Macro name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
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
```
### -Proto
Protocol (e.g., tcp, udp, icmp).
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -277,13 +228,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -Source
Shows what would happen if the cmdlet runs. The cmdlet is not run. Source address or alias.
```yaml ```yaml
Type: SwitchParameter Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -292,13 +243,59 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -Sport
Prompts you for confirmation before running the cmdlet. 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 ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -325,7 +322,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+31 -32
View File
@@ -29,28 +29,13 @@ PS C:\> New-PveGroup -GroupId admins -Comment 'Admin group'
## PARAMETERS ## 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
Comment or description for the group. Comment or description for the group.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -59,6 +44,36 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -89,21 +104,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -122,7 +122,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+33 -34
View File
@@ -13,8 +13,8 @@ Creates a new resource pool in Proxmox VE.
## SYNTAX ## SYNTAX
``` ```
New-PvePool [-PoolId] <String> [-Comment <String>] [-Session <PveSession>] New-PvePool [-PoolId] <String> [-Comment <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>] [-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -29,28 +29,13 @@ PS C:\> New-PvePool -PoolId production -Comment 'Production VMs'
## PARAMETERS ## 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 ### -Comment
An optional comment or description for the pool. An optional comment or description for the pool.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -59,6 +44,36 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -89,21 +104,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -122,7 +122,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+53 -56
View File
@@ -13,9 +13,8 @@ Creates a new SDN controller in Proxmox VE.
## SYNTAX ## SYNTAX
``` ```
New-PveSdnController [-Controller] <String> [-Type] <String> [-Asn <Int32>] [-Peers <String>] New-PveSdnController [-Controller] <String> [-Type] <String> [-Asn <Int32>] [-Peers <String>] [-Node <String>]
[-Node <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
[<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -30,13 +29,43 @@ PS C:\> New-PveSdnController -Controller bgp1 -Type bgp -Asn 65001
## PARAMETERS ## PARAMETERS
### -Asn
The Autonomous System Number for BGP/EVPN.
```yaml
Type: Int32
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
```
### -Controller ### -Controller
The controller identifier. The controller identifier.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -45,30 +74,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Type ### -Node
The controller type. The node this controller is configured on.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: 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.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -83,22 +95,7 @@ Comma-separated list of BGP peer addresses.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node this controller is configured on.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -122,6 +119,22 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -170,7 +168,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+56 -58
View File
@@ -30,13 +30,28 @@ PS C:\> New-PveSdnDns -Dns pdns1 -Type powerdns -Url https://dns.example.com -Ke
## PARAMETERS ## 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 ### -Dns
The DNS plugin identifier. The DNS plugin identifier.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -45,45 +60,13 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Key
The API key for the DNS service. The API key for the DNS service.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@@ -98,22 +81,7 @@ The IPv6 reverse zone mask length.
```yaml ```yaml
Type: Int32 Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False
Position: Named
Default value: None
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 Required: False
Position: Named Position: Named
@@ -137,13 +105,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -Ttl
Shows what would happen if the cmdlet runs. The cmdlet is not run. The TTL (time-to-live) for DNS records.
```yaml ```yaml
Type: SwitchParameter Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -152,13 +120,44 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -Type
Prompts you for confirmation before running the cmdlet. 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 ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -185,7 +184,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+55 -57
View File
@@ -29,13 +29,28 @@ PS C:\> New-PveSdnIpam -Ipam pveipam -Type pve
## PARAMETERS ## 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 ### -Ipam
The IPAM plugin identifier. The IPAM plugin identifier.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -44,60 +59,13 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Section
The configuration section identifier. The configuration section identifier.
```yaml ```yaml
Type: Int32 Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -121,13 +89,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -Token
Shows what would happen if the cmdlet runs. The cmdlet is not run. The API token for the external IPAM service.
```yaml ```yaml
Type: SwitchParameter Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -136,13 +104,44 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -Type
Prompts you for confirmation before running the cmdlet. 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 ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -169,7 +168,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+53 -55
View File
@@ -30,31 +30,16 @@ PS C:\> New-PveStorageDisk -Node pve1 -Storage local-lvm -Filename vm-100-disk-1
## PARAMETERS ## PARAMETERS
### -Node ### -Confirm
The PVE node name. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
Required: True Required: False
Position: 0 Position: Named
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 Default value: None
Accept pipeline input: False Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
@@ -66,7 +51,7 @@ The filename for the new disk (e.g. vm-100-disk-1).
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 2 Position: 2
@@ -75,29 +60,13 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Format
The disk image format (raw, qcow2, vmdk). The disk image format (raw, qcow2, vmdk).
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Accepted values: raw, qcow2, vmdk Accepted values: raw, qcow2, vmdk
Required: False Required: False
@@ -107,6 +76,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -122,6 +106,36 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -170,7 +169,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+31 -32
View File
@@ -29,43 +29,13 @@ PS C:\> Read-PveVmGuestFile -Node pve1 -VmId 100 -File /etc/hostname
## PARAMETERS ## 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 ### -File
The file path inside the guest to read. The file path inside the guest to read.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@@ -74,6 +44,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -89,6 +74,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.Int32 ### System.Int32
+18 -19
View File
@@ -13,8 +13,8 @@ Removes a scheduled backup job from Proxmox VE.
## SYNTAX ## SYNTAX
``` ```
Remove-PveBackupJob [-Id] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] Remove-PveBackupJob [-Id] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-WhatIf] [-Confirm] [<CommonParameters>] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -29,13 +29,28 @@ PS C:\> Remove-PveBackupJob -Id "example"
## PARAMETERS ## 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 ### -Id
The backup job ID. The backup job ID.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -74,21 +89,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+18 -19
View File
@@ -13,8 +13,8 @@ Removes a Proxmox VE authentication domain/realm.
## SYNTAX ## SYNTAX
``` ```
Remove-PveDomain [-Realm] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] Remove-PveDomain [-Realm] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-WhatIf] [-Confirm] [<CommonParameters>] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -29,13 +29,28 @@ PS C:\> Remove-PveDomain -Realm "example"
## PARAMETERS ## 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 ### -Realm
The realm identifier to remove. The realm identifier to remove.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -74,21 +89,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+39 -41
View File
@@ -29,14 +29,28 @@ PS C:\> Remove-PveFirewallAlias -Level Cluster -Name myserver
## PARAMETERS ## 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 ### -Level
The firewall level: Cluster, Node, Vm, or Container. The firewall level: Cluster, Node, Vm, or Container.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Accepted values: Cluster, Node, Vm, Container Accepted values: Cluster, Node, Vm, Container
Required: True Required: True
@@ -46,43 +60,13 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Name
The alias name to remove. The alias name to remove.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@@ -91,6 +75,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -106,13 +105,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -VmId
Shows what would happen if the cmdlet runs. The cmdlet is not run. The VM/Container ID. Required when Level is Vm or Container.
```yaml ```yaml
Type: SwitchParameter Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -121,13 +120,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -154,7 +153,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+16 -17
View File
@@ -29,13 +29,28 @@ PS C:\> Remove-PveFirewallGroup -Group webservers
## PARAMETERS ## 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 ### -Group
The security group name to remove. The security group name to remove.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -74,21 +89,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+39 -41
View File
@@ -29,14 +29,28 @@ PS C:\> Remove-PveFirewallIpSet -Level Cluster -Name trusted
## PARAMETERS ## 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 ### -Level
The firewall level: Cluster, Node, Vm, or Container. The firewall level: Cluster, Node, Vm, or Container.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Accepted values: Cluster, Node, Vm, Container Accepted values: Cluster, Node, Vm, Container
Required: True Required: True
@@ -46,43 +60,13 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Name
The IP set name to remove. The IP set name to remove.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@@ -91,6 +75,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -106,13 +105,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -VmId
Shows what would happen if the cmdlet runs. The cmdlet is not run. The VM/Container ID. Required when Level is Vm or Container.
```yaml ```yaml
Type: SwitchParameter Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -121,13 +120,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -154,7 +153,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+45 -48
View File
@@ -13,9 +13,8 @@ Removes an entry from a firewall IP set.
## SYNTAX ## SYNTAX
``` ```
Remove-PveFirewallIpSetEntry [-Level] <String> [-Node <String>] [-VmId <Int32>] -Name <String> Remove-PveFirewallIpSetEntry [-Level] <String> [-Node <String>] [-VmId <Int32>] -Name <String> -Cidr <String>
-Cidr <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
[<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -30,14 +29,43 @@ PS C:\> Remove-PveFirewallIpSetEntry -Level Cluster -Name trusted -Cidr 10.0.0.0
## PARAMETERS ## 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 ### -Level
The firewall level: Cluster, Node, Vm, or Container. The firewall level: Cluster, Node, Vm, or Container.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Accepted values: Cluster, Node, Vm, Container Accepted values: Cluster, Node, Vm, Container
Required: True Required: True
@@ -47,43 +75,13 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Name
The IP set name. The IP set name.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@@ -92,15 +90,15 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Cidr ### -Node
The CIDR network address to remove. The node name. Required when Level is Node, Vm, or Container.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: False
Position: Named Position: Named
Default value: None Default value: None
Accept pipeline input: False Accept pipeline input: False
@@ -122,13 +120,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -VmId
Shows what would happen if the cmdlet runs. The cmdlet is not run. The VM/Container ID. Required when Level is Vm or Container.
```yaml ```yaml
Type: SwitchParameter Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -137,13 +135,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -170,7 +168,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+25 -27
View File
@@ -29,14 +29,28 @@ PS C:\> Remove-PveFirewallRule -Level Cluster -Position 0
## PARAMETERS ## 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 ### -Level
The firewall level: Cluster, Node, Vm, or Container. The firewall level: Cluster, Node, Vm, or Container.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Accepted values: Cluster, Node, Vm, Container Accepted values: Cluster, Node, Vm, Container
Required: True Required: True
@@ -52,22 +66,7 @@ The node name. Required when Level is Node, Vm, or Container.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: 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 Required: False
Position: Named Position: Named
@@ -82,7 +81,7 @@ The rule position to remove.
```yaml ```yaml
Type: Int32 Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@@ -106,13 +105,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -VmId
Shows what would happen if the cmdlet runs. The cmdlet is not run. The VM/Container ID. Required when Level is Vm or Container.
```yaml ```yaml
Type: SwitchParameter Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -121,13 +120,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -154,7 +153,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+18 -19
View File
@@ -13,8 +13,8 @@ Removes a Proxmox VE group.
## SYNTAX ## SYNTAX
``` ```
Remove-PveGroup [-GroupId] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] Remove-PveGroup [-GroupId] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-WhatIf] [-Confirm] [<CommonParameters>] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -29,13 +29,28 @@ PS C:\> Remove-PveGroup -GroupId "example"
## PARAMETERS ## 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 ### -GroupId
The group identifier to remove. The group identifier to remove.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -74,21 +89,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+18 -19
View File
@@ -13,8 +13,8 @@ Removes a resource pool from Proxmox VE.
## SYNTAX ## SYNTAX
``` ```
Remove-PvePool [-PoolId] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] Remove-PvePool [-PoolId] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-WhatIf] [-Confirm] [<CommonParameters>] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -29,13 +29,28 @@ PS C:\> Remove-PvePool -PoolId "example"
## PARAMETERS ## 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 ### -PoolId
The pool ID to remove. The pool ID to remove.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -74,21 +89,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+16 -17
View File
@@ -29,13 +29,28 @@ PS C:\> Remove-PveSdnController -Controller "example"
## PARAMETERS ## 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 ### -Controller
The controller identifier to remove. The controller identifier to remove.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -74,21 +89,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+18 -19
View File
@@ -13,8 +13,8 @@ Removes an SDN DNS plugin from Proxmox VE.
## SYNTAX ## SYNTAX
``` ```
Remove-PveSdnDns [-Dns] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] Remove-PveSdnDns [-Dns] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-WhatIf] [-Confirm] [<CommonParameters>] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -29,13 +29,28 @@ PS C:\> Remove-PveSdnDns -Dns "example"
## PARAMETERS ## 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 ### -Dns
The DNS plugin identifier to remove. The DNS plugin identifier to remove.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -74,21 +89,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+18 -19
View File
@@ -13,8 +13,8 @@ Removes an SDN IPAM plugin from Proxmox VE.
## SYNTAX ## SYNTAX
``` ```
Remove-PveSdnIpam [-Ipam] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] Remove-PveSdnIpam [-Ipam] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-WhatIf] [-Confirm] [<CommonParameters>] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -29,13 +29,28 @@ PS C:\> Remove-PveSdnIpam -Ipam "example"
## PARAMETERS ## 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 ### -Ipam
The IPAM plugin identifier to remove. The IPAM plugin identifier to remove.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -74,21 +89,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -107,7 +107,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+48 -49
View File
@@ -13,8 +13,8 @@ Removes a content volume from a Proxmox VE storage.
## SYNTAX ## SYNTAX
``` ```
Remove-PveStorageContent [-Node] <String> [-Storage] <String> [-Volume] <String> Remove-PveStorageContent [-Node] <String> [-Storage] <String> [-Volume] <String> [-Session <PveSession>]
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -29,13 +29,28 @@ PS C:\> Remove-PveStorageContent -Node pve1 -Storage local -Volume "local:iso/ub
## PARAMETERS ## 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 ### -Node
The PVE node name. The PVE node name.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -44,36 +59,6 @@ Accept pipeline input: False
Accept wildcard characters: 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
```
### -Volume
The volume identifier to remove.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -89,6 +74,36 @@ Accept pipeline input: False
Accept wildcard characters: 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
```
### -Volume
The volume identifier to remove.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -WhatIf ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -137,7 +137,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+51 -52
View File
@@ -29,45 +29,15 @@ PS C:\> Remove-PveVmDisk -Node pve1 -VmId 100 -IdList scsi0 -Force
## PARAMETERS ## PARAMETERS
### -Node ### -Confirm
The PVE node name. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) 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 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 Position: Named
Default value: None Default value: None
Accept pipeline input: False Accept pipeline input: False
@@ -80,7 +50,7 @@ Force removal of disk images from storage.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -89,6 +59,36 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -104,6 +104,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+17 -2
View File
@@ -13,8 +13,8 @@ schema: 2.0.0
## SYNTAX ## SYNTAX
``` ```
Reset-PveVm -Node <String> -VmId <Int32> [-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>] Reset-PveVm -Node <String> -VmId <Int32> [-Wait] [-Timeout <Int32>] [-Session <PveSession>]
[-WhatIf] [-Confirm] [<CommonParameters>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -137,6 +137,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### 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). 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).
+43 -44
View File
@@ -13,8 +13,8 @@ Resizes a disk attached to an LXC container.
## SYNTAX ## SYNTAX
``` ```
Resize-PveContainerDisk -Node <String> -VmId <Int32> -Disk <String> -Size <String> Resize-PveContainerDisk -Node <String> -VmId <Int32> -Disk <String> -Size <String> [-Session <PveSession>]
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -29,33 +29,18 @@ PS C:\> Resize-PveContainerDisk -Node pve1 -VmId 100 -Disk rootfs -Size +5G
## PARAMETERS ## PARAMETERS
### -Node ### -Confirm
The PVE node name. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
Required: True Required: False
Position: Named Position: Named
Default value: None Default value: None
Accept pipeline input: True (ByPropertyName) 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 Accept wildcard characters: False
``` ```
@@ -65,7 +50,7 @@ The disk/volume to resize (e.g. rootfs, mp0).
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@@ -74,18 +59,18 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Size ### -Node
New disk size (e.g. 50G or +5G to grow). The PVE node name.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
Default value: None Default value: None
Accept pipeline input: False Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False Accept wildcard characters: False
``` ```
@@ -104,6 +89,36 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Size
New disk size (e.g. 50G or +5G to grow).
```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.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -WhatIf ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+52 -53
View File
@@ -29,13 +29,28 @@ PS C:\> Resume-PveContainer -Node pve1 -VmId 100 -Wait
## PARAMETERS ## 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 ### -Node
The PVE node name. The PVE node name.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@@ -44,51 +59,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: 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
```
### -Wait
Wait for the task to complete before returning.
```yaml
Type: SwitchParameter
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
```
### -Session ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -104,13 +74,43 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -Timeout
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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.
```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 ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -119,13 +119,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+17 -2
View File
@@ -13,8 +13,8 @@ schema: 2.0.0
## SYNTAX ## SYNTAX
``` ```
Resume-PveVm -Node <String> -VmId <Int32> [-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>] Resume-PveVm -Node <String> -VmId <Int32> [-Wait] [-Timeout <Int32>] [-Session <PveSession>]
[-WhatIf] [-Confirm] [<CommonParameters>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -137,6 +137,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### 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). 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).
+72 -75
View File
@@ -30,75 +30,13 @@ PS C:\> Send-PveFile -Node pve1 -Storage local -Path ./ubuntu.iso -ContentType i
## PARAMETERS ## 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
Checksum value to verify the upload. Checksum value to verify the upload.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -113,8 +51,7 @@ Checksum algorithm (md5, sha1, sha256, sha512).
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Accepted values: md5, sha1, sha256, sha512 Accepted values: md5, sha1, sha256, sha512
Required: False Required: False
@@ -124,13 +61,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Wait ### -Confirm
Wait for the task to complete before returning. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
Required: False Required: False
Position: Named Position: Named
@@ -139,6 +76,52 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -154,13 +137,28 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -Storage
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -169,13 +167,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -202,7 +200,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+48 -49
View File
@@ -30,43 +30,28 @@ PS C:\> Set-PveApiToken -UserId root@pam -TokenId mytoken -Comment 'Updated'
## PARAMETERS ## 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
Comment describing the token. Comment describing the token.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: 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 Required: False
Position: Named Position: Named
@@ -81,7 +66,7 @@ Expiration as Unix epoch (0 = no expiration).
```yaml ```yaml
Type: Int64 Type: Int64
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -96,7 +81,7 @@ Whether the token uses privilege separation.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -120,6 +105,36 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -168,7 +168,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+167 -171
View File
@@ -13,10 +13,10 @@ Updates a scheduled backup job on Proxmox VE.
## SYNTAX ## SYNTAX
``` ```
Set-PveBackupJob [-Id] <String> [-Schedule <String>] [-Storage <String>] [-Mode <String>] Set-PveBackupJob [-Id] <String> [-Schedule <String>] [-Storage <String>] [-Mode <String>] [-VmId <String>]
[-VmId <String>] [-All] [-Compress <String>] [-Node <String>] [-MailTo <String>] [-All] [-Compress <String>] [-Node <String>] [-MailTo <String>] [-MailNotification <String>] [-Enabled]
[-MailNotification <String>] [-Enabled] [-Comment <String>] [-PruneBackups <String>] [-Comment <String>] [-PruneBackups <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>] [-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -31,169 +31,13 @@ PS C:\> Set-PveBackupJob -Id backup-abc -Schedule '0 3 * * *'
## PARAMETERS ## 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 ### -All
Back up all VMs. Back up all VMs.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False
Position: Named
Default value: None
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 Required: False
Position: Named Position: Named
@@ -208,7 +52,130 @@ A comment or description for the backup job.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False
Position: Named
Default value: None
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 Required: False
Position: Named Position: Named
@@ -223,7 +190,22 @@ Prune-backups configuration string.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Schedule
Cron-style schedule expression.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -247,13 +229,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -Storage
Shows what would happen if the cmdlet runs. The cmdlet is not run. The target storage for backups.
```yaml ```yaml
Type: SwitchParameter Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -262,13 +244,28 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -VmId
Prompts you for confirmation before running the cmdlet. 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 ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -295,7 +292,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+32 -33
View File
@@ -29,28 +29,28 @@ PS C:\> Set-PveDomain -Realm myldap -Comment 'Updated'
## PARAMETERS ## 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 ### -Comment
Updated comment or description for the domain. Updated comment or description for the domain.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: 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 Required: False
Position: Named Position: Named
@@ -65,7 +65,7 @@ Set as the default authentication domain.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -74,6 +74,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -104,21 +119,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -137,7 +137,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+70 -72
View File
@@ -30,75 +30,13 @@ PS C:\> Set-PveFirewallAlias -Level Cluster -Name myserver -Cidr 10.0.0.2/32
## PARAMETERS ## 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 ### -Cidr
The updated CIDR network address. The updated CIDR network address.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -113,7 +51,68 @@ Updated comment for the alias.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: 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.
```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 Required: False
Position: Named Position: Named
@@ -137,13 +136,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -VmId
Shows what would happen if the cmdlet runs. The cmdlet is not run. The VM/Container ID. Required when Level is Vm or Container.
```yaml ```yaml
Type: SwitchParameter Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -152,13 +151,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -185,7 +184,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+61 -63
View File
@@ -13,9 +13,9 @@ Updates an entry in a firewall IP set.
## SYNTAX ## SYNTAX
``` ```
Set-PveFirewallIpSetEntry [-Level] <String> [-Node <String>] [-VmId <Int32>] -Name <String> Set-PveFirewallIpSetEntry [-Level] <String> [-Node <String>] [-VmId <Int32>] -Name <String> -Cidr <String>
-Cidr <String> [-NoMatch] [-Comment <String>] [-Session <PveSession>] [-NoMatch] [-Comment <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -30,14 +30,58 @@ PS C:\> Set-PveFirewallIpSetEntry -Level Cluster -Name trusted -Cidr 10.0.0.0/24
## PARAMETERS ## 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 ### -Level
The firewall level: Cluster, Node, Vm, or Container. The firewall level: Cluster, Node, Vm, or Container.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Accepted values: Cluster, Node, Vm, Container Accepted values: Cluster, Node, Vm, Container
Required: True Required: True
@@ -47,58 +91,13 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Name
The IP set name. The IP set name.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Cidr
The CIDR network address to update.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True Required: True
Position: Named Position: Named
@@ -113,7 +112,7 @@ Exclude this entry from the IP set match.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -122,13 +121,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Comment ### -Node
Updated comment for the entry. The node name. Required when Level is Node, Vm, or Container.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -152,13 +151,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -VmId
Shows what would happen if the cmdlet runs. The cmdlet is not run. The VM/Container ID. Required when Level is Vm or Container.
```yaml ```yaml
Type: SwitchParameter Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -167,13 +166,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -200,7 +199,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+127 -132
View File
@@ -13,10 +13,9 @@ Updates firewall options at the specified level.
## SYNTAX ## SYNTAX
``` ```
Set-PveFirewallOptions [-Level] <String> [-Node <String>] [-VmId <Int32>] [-Enable] Set-PveFirewallOptions [-Level] <String> [-Node <String>] [-VmId <Int32>] [-Enable] [-PolicyIn <String>]
[-PolicyIn <String>] [-PolicyOut <String>] [-LogLevelIn <String>] [-LogLevelOut <String>] [-Dhcp] [-PolicyOut <String>] [-LogLevelIn <String>] [-LogLevelOut <String>] [-Dhcp] [-Ndp] [-MacFilter] [-IpFilter]
[-Ndp] [-MacFilter] [-IpFilter] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
[-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -31,30 +30,13 @@ PS C:\> Set-PveFirewallOptions -Level Cluster -Enable -PolicyIn DROP
## PARAMETERS ## PARAMETERS
### -Level ### -Confirm
The firewall level: Cluster, Node, Vm, or Container. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
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 Required: False
Position: Named Position: Named
@@ -63,13 +45,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -VmId ### -Dhcp
The VM/Container ID. Required when Level is Vm or Container. Enable DHCP.
```yaml ```yaml
Type: Int32 Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -84,7 +66,113 @@ Enable or disable the firewall.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -IpFilter
Enable IP filter.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
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
```
### -LogLevelIn
Log level for incoming traffic.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -LogLevelOut
Log level for outgoing traffic.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -MacFilter
Enable MAC address filter.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Ndp
Enable NDP.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
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 Required: False
Position: Named Position: Named
@@ -99,8 +187,7 @@ Default policy for incoming traffic.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Accepted values: ACCEPT, DROP, REJECT Accepted values: ACCEPT, DROP, REJECT
Required: False Required: False
@@ -116,8 +203,7 @@ Default policy for outgoing traffic.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Accepted values: ACCEPT, DROP, REJECT Accepted values: ACCEPT, DROP, REJECT
Required: False Required: False
@@ -127,96 +213,6 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -LogLevelIn
Log level for incoming traffic.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -LogLevelOut
Log level for outgoing traffic.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Dhcp
Enable DHCP.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Ndp
Enable NDP.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -MacFilter
Enable MAC address filter.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -IpFilter
Enable IP filter.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Session ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -232,13 +228,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -VmId
Shows what would happen if the cmdlet runs. The cmdlet is not run. The VM/Container ID. Required when Level is Vm or Container.
```yaml ```yaml
Type: SwitchParameter Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -247,13 +243,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -280,7 +276,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+188 -193
View File
@@ -13,11 +13,10 @@ Updates a firewall rule.
## SYNTAX ## SYNTAX
``` ```
Set-PveFirewallRule [-Level] <String> [-Node <String>] [-VmId <Int32>] -Position <Int32> Set-PveFirewallRule [-Level] <String> [-Node <String>] [-VmId <Int32>] -Position <Int32> [-Type <String>]
[-Type <String>] [-Action <String>] [-Enable] [-Source <String>] [-Dest <String>] [-Proto <String>] [-Action <String>] [-Enable] [-Source <String>] [-Dest <String>] [-Proto <String>] [-Dport <String>]
[-Dport <String>] [-Sport <String>] [-Comment <String>] [-Macro <String>] [-Log <String>] [-Sport <String>] [-Comment <String>] [-Macro <String>] [-Log <String>] [-Iface <String>]
[-Iface <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
[<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -32,93 +31,13 @@ PS C:\> Set-PveFirewallRule -Level Cluster -Position 0 -Enable
## PARAMETERS ## 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 ### -Action
The rule action: ACCEPT, DROP, or REJECT. The rule action: ACCEPT, DROP, or REJECT.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Accepted values: ACCEPT, DROP, REJECT Accepted values: ACCEPT, DROP, REJECT
Required: False Required: False
@@ -128,103 +47,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -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
```
### -Source
Source address or alias.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Dest
Destination address or alias.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
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.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -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
```
### -Comment ### -Comment
Rule comment. Rule comment.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -233,13 +62,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Macro ### -Confirm
Macro name. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
Required: False Required: False
Position: Named Position: Named
@@ -248,13 +77,43 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Log ### -Dest
Log level. Destination address or alias.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Dport
Destination port.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Enable
Enable the rule.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -269,7 +128,98 @@ Network interface.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
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
```
### -Log
Log level.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Macro
Macro name.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
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
```
### -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
Parameter Sets: (All)
Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -293,13 +243,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -Source
Shows what would happen if the cmdlet runs. The cmdlet is not run. Source address or alias.
```yaml ```yaml
Type: SwitchParameter Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -308,13 +258,59 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -Sport
Prompts you for confirmation before running the cmdlet. 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 ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -341,7 +337,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+31 -32
View File
@@ -29,28 +29,13 @@ PS C:\> Set-PveGroup -GroupId admins -Comment 'Updated'
## PARAMETERS ## 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 ### -Comment
Updated comment or description. Updated comment or description.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -59,6 +44,36 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -89,21 +104,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -122,7 +122,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+19 -4
View File
@@ -13,10 +13,10 @@ schema: 2.0.0
## SYNTAX ## SYNTAX
``` ```
Set-PveNetwork [-Node] <String> [-Iface] <String> [-Address <String>] [-Netmask <String>] [-Gateway <String>] Set-PveNetwork [-Node] <String> [-Iface] <String> -Type <String> [-Address <String>] [-Netmask <String>]
[-Address6 <String>] [-Netmask6 <Int32>] [-Gateway6 <String>] [-BridgePorts <String>] [-BondSlaves <String>] [-Gateway <String>] [-Address6 <String>] [-Netmask6 <Int32>] [-Gateway6 <String>] [-BridgePorts <String>]
[-Mtu <Int32>] [-Autostart] [-Comments <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-BondSlaves <String>] [-Mtu <Int32>] [-Autostart] [-Comments <String>] [-Session <PveSession>]
[-WhatIf] [-Confirm] [<CommonParameters>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -289,6 +289,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### 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). 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).
+21 -22
View File
@@ -29,18 +29,18 @@ PS C:\> Set-PveNodeConfig -Node pve1 -Description 'Primary node'
## PARAMETERS ## PARAMETERS
### -Node ### -Confirm
The PVE node name. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
Required: True Required: False
Position: 0 Position: Named
Default value: None Default value: None
Accept pipeline input: True (ByPropertyName) Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
@@ -50,7 +50,7 @@ Node description or comment.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -59,18 +59,18 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Wakeonlan ### -Node
Wake-on-LAN configuration. The PVE node name.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: True
Position: Named Position: 0
Default value: None Default value: None
Accept pipeline input: False Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False Accept wildcard characters: False
``` ```
@@ -89,13 +89,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -Wakeonlan
Shows what would happen if the cmdlet runs. The cmdlet is not run. Wake-on-LAN configuration.
```yaml ```yaml
Type: SwitchParameter Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -104,13 +104,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -137,7 +137,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+39 -40
View File
@@ -29,31 +29,16 @@ PS C:\> Set-PveNodeDns -Node pve1 -Search example.com -Dns1 8.8.8.8
## PARAMETERS ## PARAMETERS
### -Node ### -Confirm
The PVE node name. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
Required: True Required: False
Position: 0 Position: Named
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 Default value: None
Accept pipeline input: False Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
@@ -65,7 +50,7 @@ Primary DNS server address.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -80,7 +65,7 @@ Secondary DNS server address.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -95,7 +80,7 @@ Tertiary DNS server address.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -104,6 +89,36 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -134,21 +149,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -167,7 +167,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+22 -23
View File
@@ -29,16 +29,16 @@ PS C:\> Set-PvePassword -UserId admin@pve -Password (Read-Host -AsSecureString)
## PARAMETERS ## PARAMETERS
### -UserId ### -Confirm
The user ID in user@realm format. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
Required: True Required: False
Position: 0 Position: Named
Default value: None Default value: None
Accept pipeline input: False Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
@@ -50,7 +50,7 @@ The new password for the user.
```yaml ```yaml
Type: SecureString Type: SecureString
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 1 Position: 1
@@ -74,6 +74,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -122,7 +122,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
+36 -37
View File
@@ -29,28 +29,13 @@ PS C:\> Set-PvePool -PoolId production -Comment 'Updated'
## PARAMETERS ## PARAMETERS
### -PoolId
The pool ID to update.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Comment ### -Comment
An optional comment or description. An optional comment or description.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -59,13 +44,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Members ### -Confirm
Comma-separated list of members to add. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
Required: False Required: False
Position: Named Position: Named
@@ -80,7 +65,7 @@ Comma-separated list of members to remove.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -89,6 +74,36 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Members
Comma-separated list of members to add.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -PoolId
The pool ID to update.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -119,21 +134,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+23 -24
View File
@@ -29,18 +29,18 @@ PS C:\> Set-PveRole -RoleId MyRole -Privileges 'VM.Audit,VM.Console'
## PARAMETERS ## PARAMETERS
### -RoleId ### -Confirm
The role identifier. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
Required: True Required: False
Position: 0 Position: Named
Default value: None Default value: None
Accept pipeline input: True (ByPropertyName) Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
@@ -50,7 +50,7 @@ Comma-separated list of privileges.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 1 Position: 1
@@ -59,6 +59,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -89,21 +104,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -122,7 +122,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+36 -37
View File
@@ -29,13 +29,43 @@ PS C:\> Set-PveSdnController -Controller bgp1 -Asn 65002
## PARAMETERS ## PARAMETERS
### -Asn
The Autonomous System Number for BGP/EVPN.
```yaml
Type: Int32
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
```
### -Controller ### -Controller
The SDN controller identifier. The SDN controller identifier.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -44,13 +74,13 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Asn ### -Node
The Autonomous System Number for BGP/EVPN. The node this controller is configured on.
```yaml ```yaml
Type: Int32 Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -65,22 +95,7 @@ Comma-separated list of BGP peer addresses.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Node
The node this controller is configured on.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -119,21 +134,6 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+40 -41
View File
@@ -29,13 +29,28 @@ PS C:\> Set-PveSdnDns -Dns pdns1 -Url https://dns2.example.com
## PARAMETERS ## 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 ### -Dns
The SDN DNS plugin identifier. The SDN DNS plugin identifier.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -44,28 +59,13 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False 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 ### -Key
The TSIG key for DNS updates. The TSIG key for DNS updates.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -80,22 +80,7 @@ The IPv6 reverse DNS mask length.
```yaml ```yaml
Type: Int32 Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Ttl
The TTL for DNS records.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -119,13 +104,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -Ttl
Shows what would happen if the cmdlet runs. The cmdlet is not run. The TTL for DNS records.
```yaml ```yaml
Type: SwitchParameter Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -134,13 +119,28 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -Url
Prompts you for confirmation before running the cmdlet. 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
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -167,7 +167,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+41 -42
View File
@@ -13,8 +13,8 @@ Updates an SDN IPAM plugin configuration in Proxmox VE.
## SYNTAX ## SYNTAX
``` ```
Set-PveSdnIpam [-Ipam] <String> [-Url <String>] [-Token <String>] [-Section <Int32>] Set-PveSdnIpam [-Ipam] <String> [-Url <String>] [-Token <String>] [-Section <Int32>] [-Session <PveSession>]
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -29,13 +29,28 @@ PS C:\> Set-PveSdnIpam -Ipam myipam -Url https://ipam.example.com
## PARAMETERS ## 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 ### -Ipam
The SDN IPAM plugin identifier. The SDN IPAM plugin identifier.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -44,43 +59,13 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False 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 ### -Section
The section ID in the IPAM server. The section ID in the IPAM server.
```yaml ```yaml
Type: Int32 Type: Int32
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -104,13 +89,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -Token
Shows what would happen if the cmdlet runs. The cmdlet is not run. The API token for the IPAM server.
```yaml ```yaml
Type: SwitchParameter Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -119,13 +104,28 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -Url
Prompts you for confirmation before running the cmdlet. 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 ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+73 -74
View File
@@ -13,9 +13,9 @@ Updates an SDN subnet configuration in Proxmox VE.
## SYNTAX ## SYNTAX
``` ```
Set-PveSdnSubnet [-Vnet] <String> [-Subnet] <String> [-Gateway <String>] [-Snat] Set-PveSdnSubnet [-Vnet] <String> [-Subnet] <String> [-Gateway <String>] [-Snat] [-DnsZonePrefix <String>]
[-DnsZonePrefix <String>] [-DhcpRange <String>] [-Session <PveSession>] [-DhcpRange <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -30,73 +30,13 @@ PS C:\> Set-PveSdnSubnet -Vnet myvnet -Subnet 10.0.0.0/24 -Gateway 10.0.0.1
## PARAMETERS ## PARAMETERS
### -Vnet ### -Confirm
The SDN VNet name. Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
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:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Snat
Enable SNAT for this subnet.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -DnsZonePrefix
DNS zone prefix for automatic registration.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -111,7 +51,37 @@ DHCP range for this subnet.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -DnsZonePrefix
DNS zone prefix for automatic registration.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Gateway
Gateway address for this subnet.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -135,13 +105,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -Snat
Shows what would happen if the cmdlet runs. The cmdlet is not run. Enable SNAT for this subnet.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -150,13 +120,43 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -Subnet
Prompts you for confirmation before running the cmdlet. 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 ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -183,7 +183,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+53 -54
View File
@@ -29,28 +29,13 @@ PS C:\> Set-PveSdnVnet -Vnet myvnet -Zone myzone
## PARAMETERS ## 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 ### -Alias
An alias for the VNet. An alias for the VNet.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -59,43 +44,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Zone ### -Confirm
The zone this VNet belongs to. Prompts you for confirmation before running the cmdlet.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Tag
VLAN tag for this VNet.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VlanAware
Enable VLAN-aware bridging.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
Required: False Required: False
Position: Named Position: Named
@@ -119,6 +74,51 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Tag
VLAN tag for this VNet.
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -VlanAware
Enable VLAN-aware bridging.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
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: True (ByPropertyName)
Accept wildcard characters: False
```
### -WhatIf ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. Shows what would happen if the cmdlet runs. The cmdlet is not run.
@@ -134,13 +134,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -Zone
Prompts you for confirmation before running the cmdlet. The zone this VNet belongs to.
```yaml ```yaml
Type: SwitchParameter Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -167,7 +167,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+31 -32
View File
@@ -29,18 +29,18 @@ PS C:\> Set-PveSdnZone -Zone myzone -Dns pdns1
## PARAMETERS ## PARAMETERS
### -Zone ### -Confirm
The SDN zone name. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
Required: True Required: False
Position: 0 Position: Named
Default value: None Default value: None
Accept pipeline input: True (ByPropertyName) Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
@@ -50,22 +50,7 @@ DNS server for automatic registration.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Reversedns
Reverse DNS server.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -80,7 +65,22 @@ DNS zone name for registration.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Reversedns
Reverse DNS server.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -119,18 +119,18 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -Zone
Prompts you for confirmation before running the cmdlet. The SDN zone name.
```yaml ```yaml
Type: SwitchParameter Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases:
Required: False Required: True
Position: Named Position: 0
Default value: None Default value: None
Accept pipeline input: False Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False Accept wildcard characters: False
``` ```
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+51 -52
View File
@@ -14,8 +14,8 @@ Updates a Proxmox VE storage definition.
``` ```
Set-PveStorage [-Storage] <String> [-Content <String>] [-Nodes <String>] [-Enabled] [-Shared] Set-PveStorage [-Storage] <String> [-Content <String>] [-Nodes <String>] [-Enabled] [-Shared]
[-AdditionalConfig <Hashtable>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-AdditionalConfig <Hashtable>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-WhatIf] [-Confirm] [<CommonParameters>] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -30,18 +30,33 @@ PS C:\> Set-PveStorage -Storage local -Content 'images,iso,backup'
## PARAMETERS ## PARAMETERS
### -Storage ### -AdditionalConfig
The storage identifier. Additional configuration parameters as a hashtable.
```yaml ```yaml
Type: String Type: Hashtable
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: False
Position: 0 Position: Named
Default value: None Default value: None
Accept pipeline input: True (ByPropertyName) 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 Accept wildcard characters: False
``` ```
@@ -51,22 +66,7 @@ Comma-separated content types.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Nodes
Comma-separated list of nodes.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -81,7 +81,7 @@ Whether the storage is enabled.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -90,28 +90,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Shared ### -Nodes
Whether the storage is shared. Comma-separated list of nodes.
```yaml ```yaml
Type: SwitchParameter Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: 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
Parameter Sets: (All)
Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -135,13 +120,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -Shared
Shows what would happen if the cmdlet runs. The cmdlet is not run. Whether the storage is shared.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -150,13 +135,28 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -Storage
Prompts you for confirmation before running the cmdlet. 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 ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -183,7 +183,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+47 -48
View File
@@ -29,13 +29,28 @@ PS C:\> Set-PveStorageContent -Node pve1 -Storage local -Volume 'local:iso/ubunt
## PARAMETERS ## 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 ### -Node
The PVE node name. The PVE node name.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -44,43 +59,13 @@ Accept pipeline input: False
Accept wildcard characters: 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
```
### -Volume
The volume identifier to update.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Notes ### -Notes
Notes or description for the volume. Notes or description for the volume.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -104,6 +89,36 @@ Accept pipeline input: False
Accept wildcard characters: 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
```
### -Volume
The volume identifier to update.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -WhatIf ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+68 -70
View File
@@ -13,9 +13,8 @@ Sets a user password inside the guest via the QEMU guest agent.
## SYNTAX ## SYNTAX
``` ```
Set-PveVmGuestPassword [-Node] <String> [-VmId] <Int32> -Username <String> -Password <SecureString> Set-PveVmGuestPassword [-Node] <String> [-VmId] <Int32> -Username <String> -Password <SecureString> [-Crypted]
[-Crypted] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
[<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -30,60 +29,15 @@ PS C:\> Set-PveVmGuestPassword -Node pve1 -VmId 100 -Username root -Password (Re
## PARAMETERS ## PARAMETERS
### -Node ### -Confirm
The PVE node name. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
Required: True Required: False
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
Position: Named Position: Named
Default value: None Default value: None
Accept pipeline input: False Accept pipeline input: False
@@ -96,7 +50,7 @@ Indicates the password is already crypted/hashed.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -105,6 +59,36 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -120,6 +104,36 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -168,7 +167,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.Int32 ### System.Int32
+16 -1
View File
@@ -13,7 +13,7 @@ schema: 2.0.0
## SYNTAX ## 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>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
@@ -137,6 +137,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### 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). 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).
+23 -24
View File
@@ -29,13 +29,28 @@ PS C:\> Start-PveNodeVms -Node pve1
## PARAMETERS ## 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 ### -Node
The PVE node name. The PVE node name.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -44,21 +59,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -74,13 +74,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -VmIds
Shows what would happen if the cmdlet runs. The cmdlet is not run. Comma-separated list of VM IDs to start.
```yaml ```yaml
Type: SwitchParameter Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -89,13 +89,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -122,7 +122,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+17 -2
View File
@@ -13,8 +13,8 @@ schema: 2.0.0
## SYNTAX ## SYNTAX
``` ```
Start-PveVm -Node <String> -VmId <Int32> [-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>] Start-PveVm -Node <String> -VmId <Int32> [-Wait] [-Timeout <Int32>] [-Session <PveSession>]
[-WhatIf] [-Confirm] [<CommonParameters>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -137,6 +137,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### 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). 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).
+16 -1
View File
@@ -13,7 +13,7 @@ schema: 2.0.0
## SYNTAX ## 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>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
@@ -137,6 +137,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### 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). 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).
+27 -28
View File
@@ -29,28 +29,13 @@ PS C:\> Stop-PveNodeVms -Node pve1
## PARAMETERS ## PARAMETERS
### -Node ### -Confirm
The PVE node name. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
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:
Required: False Required: False
Position: Named Position: Named
@@ -65,7 +50,7 @@ Force stop VMs without waiting for graceful shutdown.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -74,6 +59,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -89,13 +89,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -VmIds
Shows what would happen if the cmdlet runs. The cmdlet is not run. Comma-separated list of VM IDs to stop.
```yaml ```yaml
Type: SwitchParameter Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -104,13 +104,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -137,7 +137,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+33 -34
View File
@@ -13,8 +13,8 @@ Stops a running task on a Proxmox VE node.
## SYNTAX ## SYNTAX
``` ```
Stop-PveTask [-Node] <String> [-Upid] <String> [-Session <PveSession>] Stop-PveTask [-Node] <String> [-Upid] <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>] [-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -29,13 +29,28 @@ PS C:\> Stop-PveTask -Node pve1 -Upid 'UPID:pve1:...'
## PARAMETERS ## 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 ### -Node
The PVE node name. The PVE node name.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
@@ -44,21 +59,6 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Upid
The task UPID.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -Session ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -74,6 +74,21 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Upid
The task UPID.
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -WhatIf ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -122,7 +122,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+17 -2
View File
@@ -13,8 +13,8 @@ schema: 2.0.0
## SYNTAX ## SYNTAX
``` ```
Stop-PveVm -Node <String> -VmId <Int32> [-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>] Stop-PveVm -Node <String> -VmId <Int32> [-Wait] [-Timeout <Int32>] [-Session <PveSession>]
[-WhatIf] [-Confirm] [<CommonParameters>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -137,6 +137,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### 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). 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).
+52 -53
View File
@@ -29,13 +29,28 @@ PS C:\> Suspend-PveContainer -Node pve1 -VmId 100 -Wait
## PARAMETERS ## 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 ### -Node
The PVE node name. The PVE node name.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@@ -44,51 +59,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: 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
```
### -Wait
Wait for the task to complete before returning.
```yaml
Type: SwitchParameter
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
```
### -Session ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -104,13 +74,43 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -WhatIf ### -Timeout
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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.
```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 ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: wi Aliases:
Required: False Required: False
Position: Named Position: Named
@@ -119,13 +119,13 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -WhatIf
Prompts you for confirmation before running the cmdlet. Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml ```yaml
Type: SwitchParameter Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: cf Aliases: wi
Required: False Required: False
Position: Named Position: Named
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.String ### System.String
+17 -2
View File
@@ -13,8 +13,8 @@ schema: 2.0.0
## SYNTAX ## SYNTAX
``` ```
Suspend-PveVm -Node <String> -VmId <Int32> [-Wait] [-Session <PveSession>] [-ProgressAction <ActionPreference>] Suspend-PveVm -Node <String> -VmId <Int32> [-Wait] [-Timeout <Int32>] [-Session <PveSession>]
[-WhatIf] [-Confirm] [<CommonParameters>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -137,6 +137,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### 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). 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).
+53 -54
View File
@@ -13,8 +13,8 @@ Writes content to a file on the guest filesystem via the QEMU guest agent.
## SYNTAX ## SYNTAX
``` ```
Write-PveVmGuestFile [-Node] <String> [-VmId] <Int32> -File <String> -Content <String> Write-PveVmGuestFile [-Node] <String> [-VmId] <Int32> -File <String> -Content <String> [-Session <PveSession>]
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
``` ```
## DESCRIPTION ## DESCRIPTION
@@ -29,45 +29,15 @@ PS C:\> Write-PveVmGuestFile -Node pve1 -VmId 100 -File /tmp/test.txt -Content '
## PARAMETERS ## PARAMETERS
### -Node ### -Confirm
The PVE node name. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
Type: String Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases: cf
Required: True Required: False
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
Position: Named Position: Named
Default value: None Default value: None
Accept pipeline input: False Accept pipeline input: False
@@ -80,7 +50,7 @@ The content to write to the file.
```yaml ```yaml
Type: String Type: String
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
Required: True Required: True
Position: Named Position: Named
@@ -89,6 +59,36 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -Session
{{ Fill Session Description }} {{ Fill Session Description }}
@@ -104,6 +104,21 @@ Accept pipeline input: False
Accept wildcard characters: 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 ### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run. 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 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 ### -ProgressAction
{{ Fill ProgressAction Description }} {{ Fill ProgressAction Description }}
@@ -152,7 +152,6 @@ Accept wildcard characters: False
### CommonParameters ### 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). 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 ## INPUTS
### System.Int32 ### System.Int32
+47 -10
View File
@@ -1,20 +1,28 @@
#!/usr/bin/env pwsh #!/usr/bin/env pwsh
<# <#
.SYNOPSIS .SYNOPSIS
Generates platyPS markdown help stubs and MAML XML help for PSProxmoxVE. Generates platyPS markdown help and MAML XML help for PSProxmoxVE.
.DESCRIPTION .DESCRIPTION
This script: This script:
1. Builds the module to publish/netstandard2.0/ 1. Builds the module to publish/netstandard2.0/
2. Installs platyPS if needed 2. Installs platyPS if needed
3. Generates markdown help stubs in docs/cmdlets/ 3. Creates markdown stubs for NEW cmdlets only (preserves existing docs)
4. Generates MAML XML help in publish/netstandard2.0/ 4. Updates existing markdown docs (merges parameter changes, preserves descriptions/examples)
5. Copies the MAML XML to src/PSProxmoxVE/ for inclusion in builds 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 .NOTES
Run from the repository root: Run from the repository root:
pwsh -NoProfile -File ./generate-help.ps1 pwsh -NoProfile -File ./generate-help.ps1
#> #>
param(
[switch]$Force
)
$ErrorActionPreference = 'Stop' $ErrorActionPreference = 'Stop'
Set-StrictMode -Version Latest Set-StrictMode -Version Latest
@@ -25,7 +33,10 @@ Push-Location $repoRoot
try { try {
# Step 1: Build the module # Step 1: Build the module
Write-Host "Building module..." -ForegroundColor Cyan 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 Remove-Item ./publish/netstandard2.0/*.deps.json, ./publish/netstandard2.0/*.runtimeconfig.json -ErrorAction SilentlyContinue
# Step 2: Install platyPS if needed # Step 2: Install platyPS if needed
@@ -45,14 +56,40 @@ try {
New-Item -ItemType Directory -Path $docsDir -Force | Out-Null New-Item -ItemType Directory -Path $docsDir -Force | Out-Null
} }
# Step 5: Generate markdown help stubs # Step 5: Generate or update markdown help
Write-Host "Generating markdown help stubs..." -ForegroundColor Cyan $existingDocs = Get-ChildItem "$docsDir/*.md" -ErrorAction SilentlyContinue
New-MarkdownHelp -Module PSProxmoxVE -OutputFolder $docsDir -Force | Out-Null
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 $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 Write-Host "Generating MAML XML help..." -ForegroundColor Cyan
New-ExternalHelp -Path $docsDir -OutputPath ./publish/netstandard2.0/ -Force | Out-Null New-ExternalHelp -Path $docsDir -OutputPath ./publish/netstandard2.0/ -Force | Out-Null
File diff suppressed because it is too large Load Diff