diff --git a/docs/cmdlets/Get-PveClusterResource.md b/docs/cmdlets/Get-PveClusterResource.md index 6ca141d..d931465 100644 --- a/docs/cmdlets/Get-PveClusterResource.md +++ b/docs/cmdlets/Get-PveClusterResource.md @@ -38,22 +38,6 @@ Returns only VM resources across the cluster. ## PARAMETERS -### -Type -Filter by resource type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: vm, lxc, node, storage, sdn - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Node Filter results to a specific node name. @@ -84,6 +68,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Type +Filter by resource type. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: vm, lxc, node, storage, sdn + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/Get-PveContainerInterface.md b/docs/cmdlets/Get-PveContainerInterface.md index bc87c77..4854c5f 100644 --- a/docs/cmdlets/Get-PveContainerInterface.md +++ b/docs/cmdlets/Get-PveContainerInterface.md @@ -46,21 +46,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VmId -The container identifier. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - ### -Session {{ Fill Session Description }} @@ -76,6 +61,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/Get-PveFirewallAlias.md b/docs/cmdlets/Get-PveFirewallAlias.md index e5a3163..17f036d 100644 --- a/docs/cmdlets/Get-PveFirewallAlias.md +++ b/docs/cmdlets/Get-PveFirewallAlias.md @@ -47,8 +47,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Node -The node name. Required when Level is Node, Vm, or Container. +### -Name +Optional alias name to filter by. ```yaml Type: String @@ -62,23 +62,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VmId -The VM/Container ID. Required when Level is Vm or Container. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Optional alias name to filter by. +### -Node +The node name. Required when Level is Node, Vm, or Container. ```yaml Type: String @@ -107,6 +92,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -VmId +The VM/Container ID. Required when Level is Vm or Container. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/Get-PveFirewallIpSet.md b/docs/cmdlets/Get-PveFirewallIpSet.md index 6e3cfc3..3650ed5 100644 --- a/docs/cmdlets/Get-PveFirewallIpSet.md +++ b/docs/cmdlets/Get-PveFirewallIpSet.md @@ -47,8 +47,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Node -The node name. Required when Level is Node, Vm, or Container. +### -Name +Optional IP set name to filter by. ```yaml Type: String @@ -62,23 +62,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VmId -The VM/Container ID. Required when Level is Vm or Container. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Optional IP set name to filter by. +### -Node +The node name. Required when Level is Node, Vm, or Container. ```yaml Type: String @@ -107,6 +92,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -VmId +The VM/Container ID. Required when Level is Vm or Container. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/Get-PveFirewallIpSetEntry.md b/docs/cmdlets/Get-PveFirewallIpSetEntry.md index 168240b..adf7420 100644 --- a/docs/cmdlets/Get-PveFirewallIpSetEntry.md +++ b/docs/cmdlets/Get-PveFirewallIpSetEntry.md @@ -47,36 +47,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Node -The node name. Required when Level is Node, Vm, or Container. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmId -The VM/Container ID. Required when Level is Vm or Container. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Name The IP set name. @@ -92,6 +62,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Node +The node name. Required when Level is Node, Vm, or Container. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -107,6 +92,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -VmId +The VM/Container ID. Required when Level is Vm or Container. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/Get-PveFirewallOptions.md b/docs/cmdlets/Get-PveFirewallOptions.md index 88fa5e9..8525c1d 100644 --- a/docs/cmdlets/Get-PveFirewallOptions.md +++ b/docs/cmdlets/Get-PveFirewallOptions.md @@ -62,11 +62,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VmId -The VM/Container ID. Required when Level is Vm or Container. +### -Session +{{ Fill Session Description }} ```yaml -Type: Int32 +Type: PveSession Parameter Sets: (All) Aliases: @@ -77,11 +77,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Session -{{ Fill Session Description }} +### -VmId +The VM/Container ID. Required when Level is Vm or Container. ```yaml -Type: PveSession +Type: Int32 Parameter Sets: (All) Aliases: diff --git a/docs/cmdlets/Get-PveFirewallRef.md b/docs/cmdlets/Get-PveFirewallRef.md index 7b37bef..f079ae8 100644 --- a/docs/cmdlets/Get-PveFirewallRef.md +++ b/docs/cmdlets/Get-PveFirewallRef.md @@ -13,8 +13,8 @@ Lists firewall references at the specified level. ## SYNTAX ``` -Get-PveFirewallRef [-Level] [-Node ] [-VmId ] [-Type ] - [-Session ] [-ProgressAction ] [] +Get-PveFirewallRef [-Level] [-Node ] [-VmId ] [-Type ] [-Session ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -62,11 +62,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VmId -The VM/Container ID. Required when Level is Vm or Container. +### -Session +{{ Fill Session Description }} ```yaml -Type: Int32 +Type: PveSession Parameter Sets: (All) Aliases: @@ -92,11 +92,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Session -{{ Fill Session Description }} +### -VmId +The VM/Container ID. Required when Level is Vm or Container. ```yaml -Type: PveSession +Type: Int32 Parameter Sets: (All) Aliases: diff --git a/docs/cmdlets/Get-PveFirewallRule.md b/docs/cmdlets/Get-PveFirewallRule.md index e0c6d9b..e9500b0 100644 --- a/docs/cmdlets/Get-PveFirewallRule.md +++ b/docs/cmdlets/Get-PveFirewallRule.md @@ -62,21 +62,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VmId -The VM/Container ID. Required when Level is Vm or Container. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Position Optional rule position to filter by. @@ -107,6 +92,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -VmId +The VM/Container ID. Required when Level is Vm or Container. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/Get-PveStorageStatus.md b/docs/cmdlets/Get-PveStorageStatus.md index 61bc044..bf139ea 100644 --- a/docs/cmdlets/Get-PveStorageStatus.md +++ b/docs/cmdlets/Get-PveStorageStatus.md @@ -46,21 +46,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Storage -The storage pool name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - ### -Session {{ Fill Session Description }} @@ -76,6 +61,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Storage +The storage pool name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/Get-PveTaskList.md b/docs/cmdlets/Get-PveTaskList.md index c6364d7..aa635b2 100644 --- a/docs/cmdlets/Get-PveTaskList.md +++ b/docs/cmdlets/Get-PveTaskList.md @@ -38,6 +38,21 @@ Returns the 10 most recent tasks for VM 100. ## PARAMETERS +### -Limit +Maximum number of tasks to return. Defaults to 50. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 50 +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Node The PVE node name. @@ -53,11 +68,11 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -VmId -Filter tasks by VM ID. +### -Session +{{ Fill Session Description }} ```yaml -Type: Int32 +Type: PveSession Parameter Sets: (All) Aliases: @@ -99,29 +114,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Limit -Maximum number of tasks to return. Defaults to 50. +### -VmId +Filter tasks by VM ID. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: 50 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Session -{{ Fill Session Description }} - -```yaml -Type: PveSession -Parameter Sets: (All) -Aliases: - Required: False Position: Named Default value: None diff --git a/docs/cmdlets/Get-PveVm.md b/docs/cmdlets/Get-PveVm.md index 97667d1..f92e6ad 100644 --- a/docs/cmdlets/Get-PveVm.md +++ b/docs/cmdlets/Get-PveVm.md @@ -14,7 +14,7 @@ schema: 2.0.0 ``` Get-PveVm [-Node ] [-VmId ] [-Name ] [-Status ] [-Tag ] [-TemplatesOnly] - [-Session ] [-ProgressAction ] [] + [-Detailed] [-Session ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -152,6 +152,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Detailed +Include detailed status (QmpStatus) via per-VM API call. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/docs/cmdlets/Get-PveVmGuestFsInfo.md b/docs/cmdlets/Get-PveVmGuestFsInfo.md index 5239855..cab0da5 100644 --- a/docs/cmdlets/Get-PveVmGuestFsInfo.md +++ b/docs/cmdlets/Get-PveVmGuestFsInfo.md @@ -46,21 +46,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VmId -The VM identifier. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - ### -Session {{ Fill Session Description }} @@ -76,6 +61,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/Get-PveVmGuestOsInfo.md b/docs/cmdlets/Get-PveVmGuestOsInfo.md index e095449..14ea04e 100644 --- a/docs/cmdlets/Get-PveVmGuestOsInfo.md +++ b/docs/cmdlets/Get-PveVmGuestOsInfo.md @@ -46,21 +46,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VmId -The VM identifier. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - ### -Session {{ Fill Session Description }} @@ -76,6 +61,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/Import-PveOva.md b/docs/cmdlets/Import-PveOva.md index c9b018a..e003753 100644 --- a/docs/cmdlets/Import-PveOva.md +++ b/docs/cmdlets/Import-PveOva.md @@ -32,6 +32,66 @@ Imports an OVA file into a new VM on node pve1. ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cores +Override CPU core count. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Memory +Override memory size in MiB. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Override the VM name from the OVF. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Node The PVE node name. @@ -47,21 +107,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Storage -The storage pool for OVA upload. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Path Local path to the OVA file. @@ -77,6 +122,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Storage +The storage pool for OVA upload. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TargetStorage Target storage for imported VM disks. @@ -107,51 +182,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Override the VM name from the OVF. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Memory -Override memory size in MiB. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cores -Override CPU core count. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Wait Wait for all tasks to complete before returning. @@ -167,21 +197,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Session -{{ Fill Session Description }} - -```yaml -Type: PveSession -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -197,21 +212,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/Import-PveVmDisk.md b/docs/cmdlets/Import-PveVmDisk.md index 7ed3e94..96267a9 100644 --- a/docs/cmdlets/Import-PveVmDisk.md +++ b/docs/cmdlets/Import-PveVmDisk.md @@ -13,7 +13,7 @@ Imports a disk image into a Proxmox VE virtual machine. ## SYNTAX ``` -Import-PveVmDisk [-Disk] -Node -VmId -TargetStorage -Source +Import-PveVmDisk -Node -VmId [-Disk] -TargetStorage -Source [-Format ] [-Wait] [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` @@ -32,33 +32,18 @@ Imports a cloud image into VM 100. ## PARAMETERS -### -Node -The PVE node name. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VmId -The VM identifier. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -77,36 +62,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetStorage -Target storage for the imported disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Source -Import source (e.g. local:iso/image.img or local:import/vm.ova/disk.vmdk). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Format Target disk format (qcow2, raw, vmdk). @@ -123,18 +78,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Wait -Wait for the import task to complete. +### -Node +The PVE node name. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -153,13 +108,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Source +Import source (e.g. local:iso/image.img or local:import/vm.ova/disk.vmdk). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetStorage +Target storage for the imported disk. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the import task to complete. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -168,13 +168,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named diff --git a/docs/cmdlets/Invoke-PveSdnApply.md b/docs/cmdlets/Invoke-PveSdnApply.md index 7951961..f4e0ad7 100644 --- a/docs/cmdlets/Invoke-PveSdnApply.md +++ b/docs/cmdlets/Invoke-PveSdnApply.md @@ -31,6 +31,21 @@ Applies all pending SDN configuration changes. ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -61,21 +76,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/Invoke-PveVmGuestExec.md b/docs/cmdlets/Invoke-PveVmGuestExec.md index 37a4cf3..5ddd616 100644 --- a/docs/cmdlets/Invoke-PveVmGuestExec.md +++ b/docs/cmdlets/Invoke-PveVmGuestExec.md @@ -14,7 +14,8 @@ schema: 2.0.0 ``` Invoke-PveVmGuestExec [-Node] [-VmId] [-Command] [-Args ] - [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] + [-Timeout ] [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -152,6 +153,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Timeout +Timeout in seconds to wait for command completion. Defaults to 300. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/docs/cmdlets/Invoke-PveVmGuestFsTrim.md b/docs/cmdlets/Invoke-PveVmGuestFsTrim.md index c9d2f40..b554699 100644 --- a/docs/cmdlets/Invoke-PveVmGuestFsTrim.md +++ b/docs/cmdlets/Invoke-PveVmGuestFsTrim.md @@ -31,6 +31,21 @@ Triggers fstrim on VM 100. ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Node The PVE node name. @@ -46,6 +61,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -VmId The VM identifier. @@ -61,21 +91,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Session -{{ Fill Session Description }} - -```yaml -Type: PveSession -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -91,21 +106,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/Move-PveContainerVolume.md b/docs/cmdlets/Move-PveContainerVolume.md index c0717ef..219d8d0 100644 --- a/docs/cmdlets/Move-PveContainerVolume.md +++ b/docs/cmdlets/Move-PveContainerVolume.md @@ -31,6 +31,36 @@ Moves the rootfs volume of container 100 to local-lvm storage. ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Delete +Delete the original volume after move (default true). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Node The PVE node name. @@ -46,6 +76,36 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Storage +The target storage identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -VmId The container identifier. @@ -76,36 +136,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Storage -The target storage identifier. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Delete -Delete the original volume after move (default true). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Wait Wait for the task to complete before returning. @@ -121,21 +151,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Session -{{ Fill Session Description }} - -```yaml -Type: PveSession -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -151,21 +166,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/Move-PveVmDisk.md b/docs/cmdlets/Move-PveVmDisk.md index 9c40f5c..f4130ad 100644 --- a/docs/cmdlets/Move-PveVmDisk.md +++ b/docs/cmdlets/Move-PveVmDisk.md @@ -14,8 +14,7 @@ Moves a VM disk to a different storage. ``` Move-PveVmDisk -Node -VmId -Disk -Storage [-Format ] [-Delete] - [-Wait] [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] + [-Wait] [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -32,53 +31,38 @@ Moves the scsi0 disk of VM 100 to local-lvm storage. ## PARAMETERS -### -Node -The PVE node name. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VmId -The VM identifier. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Disk -The disk slot to move (e.g. scsi0, virtio0). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Storage -The target storage identifier. +### -Delete +Delete the original disk after move (default true). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: True +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disk +The disk slot to move (e.g. scsi0, virtio0). ```yaml Type: String @@ -108,33 +92,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Delete -Delete the original disk after move (default true). +### -Node +The PVE node name. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Wait for the task to complete before returning. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -153,13 +122,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Storage +The target storage identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -168,13 +167,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named diff --git a/docs/cmdlets/New-PveBackup.md b/docs/cmdlets/New-PveBackup.md index 85e3d61..d6046dc 100644 --- a/docs/cmdlets/New-PveBackup.md +++ b/docs/cmdlets/New-PveBackup.md @@ -32,43 +32,29 @@ Creates a snapshot backup of VM 100 and waits for completion. ## PARAMETERS -### -Node -The PVE node name. +### -Compress +The compression algorithm. ```yaml Type: String Parameter Sets: (All) Aliases: +Accepted values: zstd, lzo, gzip, none -Required: True -Position: 0 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -VmId -The VM identifier. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Storage -The target storage for the backup. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -93,14 +79,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Compress -The compression algorithm. +### -Node +The PVE node name. ```yaml Type: String Parameter Sets: (All) Aliases: -Accepted values: zstd, lzo, gzip, none + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -109,11 +109,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Wait -Wait for the task to complete before returning. +### -Storage +The target storage for the backup. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: @@ -139,11 +139,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Session -{{ Fill Session Description }} +### -VmId +The VM identifier. ```yaml -Type: PveSession +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -169,21 +184,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/New-PveBackupJob.md b/docs/cmdlets/New-PveBackupJob.md index baea0fc..292b006 100644 --- a/docs/cmdlets/New-PveBackupJob.md +++ b/docs/cmdlets/New-PveBackupJob.md @@ -33,67 +33,6 @@ Creates a nightly backup job at 2 AM. ## PARAMETERS -### -Schedule -Cron-style schedule expression (e.g., '0 2 * * *'). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Storage -The target storage for backups. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mode -The backup mode. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: snapshot, suspend, stop - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmId -Comma-separated list of VM IDs to back up. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -All Back up all VMs. @@ -109,83 +48,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Compress -The compression algorithm. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: zstd, lzo, gzip, none - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Node -The node to restrict the backup job to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTo -Email address(es) for notifications. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailNotification -When to send email notifications. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: always, failure - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Whether the backup job is enabled. Default is enabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Comment A comment or description for the backup job. @@ -201,6 +63,114 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Compress +The compression algorithm. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: zstd, lzo, gzip, none + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enabled +Whether the backup job is enabled. Default is enabled. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailNotification +When to send email notifications. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: always, failure + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MailTo +Email address(es) for notifications. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mode +The backup mode. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: snapshot, suspend, stop + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The node to restrict the backup job to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PruneBackups Prune-backups configuration string. @@ -216,6 +186,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Schedule +Cron-style schedule expression (e.g., '0 2 * * *'). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -231,13 +216,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Storage +The target storage for backups. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +Comma-separated list of VM IDs to back up. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -246,13 +246,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named diff --git a/docs/cmdlets/New-PveContainerTemplate.md b/docs/cmdlets/New-PveContainerTemplate.md index 29be4b6..20d288e 100644 --- a/docs/cmdlets/New-PveContainerTemplate.md +++ b/docs/cmdlets/New-PveContainerTemplate.md @@ -31,6 +31,21 @@ Converts container 100 to a template. ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Node The PVE node name. @@ -46,21 +61,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -VmId -The container identifier. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - ### -Session {{ Fill Session Description }} @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -91,21 +106,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/New-PveDomain.md b/docs/cmdlets/New-PveDomain.md index cb734f0..c3fd783 100644 --- a/docs/cmdlets/New-PveDomain.md +++ b/docs/cmdlets/New-PveDomain.md @@ -31,37 +31,6 @@ Creates a new LDAP authentication domain. ## PARAMETERS -### -Realm -The realm identifier. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The domain type (pam, pve, ad, ldap, openid). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: pam, pve, ad, ldap, openid - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Comment Comment or description for the domain. @@ -77,6 +46,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Default Set as the default authentication domain. @@ -92,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Realm +The realm identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -107,6 +106,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Type +The domain type (pam, pve, ad, ldap, openid). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: pam, pve, ad, ldap, openid + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -122,21 +137,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/New-PveFirewallAlias.md b/docs/cmdlets/New-PveFirewallAlias.md index 7c2d6e2..02a42c8 100644 --- a/docs/cmdlets/New-PveFirewallAlias.md +++ b/docs/cmdlets/New-PveFirewallAlias.md @@ -32,67 +32,6 @@ Creates a cluster-level firewall alias. ## PARAMETERS -### -Level -The firewall level: Cluster, Node, Vm, or Container. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Cluster, Node, Vm, Container - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Node -The node name. Required when Level is Node, Vm, or Container. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmId -The VM/Container ID. Required when Level is Vm or Container. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The alias name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Cidr The CIDR network address. @@ -123,6 +62,67 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Level +The firewall level: Cluster, Node, Vm, or Container. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: Cluster, Node, Vm, Container + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The alias name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The node name. Required when Level is Node, Vm, or Container. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -138,6 +138,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -VmId +The VM/Container ID. Required when Level is Vm or Container. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -153,21 +168,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/New-PveFirewallGroup.md b/docs/cmdlets/New-PveFirewallGroup.md index 0dfa6c8..4c3c0e9 100644 --- a/docs/cmdlets/New-PveFirewallGroup.md +++ b/docs/cmdlets/New-PveFirewallGroup.md @@ -31,21 +31,6 @@ Creates a security group named webservers. ## PARAMETERS -### -Group -The security group name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Comment Optional comment for the security group. @@ -61,6 +46,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +The security group name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -91,21 +106,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/cmdlets/New-PveFirewallIpSet.md b/docs/cmdlets/New-PveFirewallIpSet.md index a941736..8f146d9 100644 --- a/docs/cmdlets/New-PveFirewallIpSet.md +++ b/docs/cmdlets/New-PveFirewallIpSet.md @@ -31,6 +31,36 @@ Creates a cluster-level IP set named trusted. ## PARAMETERS +### -Comment +Optional comment for the IP set. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Level The firewall level: Cluster, Node, Vm, or Container. @@ -47,36 +77,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Node -The node name. Required when Level is Node, Vm, or Container. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmId -The VM/Container ID. Required when Level is Vm or Container. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Name The IP set name. @@ -92,8 +92,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Comment -Optional comment for the IP set. +### -Node +The node name. Required when Level is Node, Vm, or Container. ```yaml Type: String @@ -122,13 +122,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -VmId +The VM/Container ID. Required when Level is Vm or Container. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -137,13 +137,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named diff --git a/docs/cmdlets/New-PveFirewallIpSetEntry.md b/docs/cmdlets/New-PveFirewallIpSetEntry.md index 2ff5174..d779703 100644 --- a/docs/cmdlets/New-PveFirewallIpSetEntry.md +++ b/docs/cmdlets/New-PveFirewallIpSetEntry.md @@ -13,9 +13,9 @@ Adds an entry to a firewall IP set. ## SYNTAX ``` -New-PveFirewallIpSetEntry [-Level] [-Node ] [-VmId ] -Name - -Cidr [-NoMatch] [-Comment ] [-Session ] [-ProgressAction ] - [-WhatIf] [-Confirm] [] +New-PveFirewallIpSetEntry [-Level] [-Node ] [-VmId ] -Name -Cidr + [-NoMatch] [-Comment ] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -30,14 +30,58 @@ PS C:\> New-PveFirewallIpSetEntry -Level Cluster -Name trusted -Cidr 10.0.0.0/24 ## PARAMETERS +### -Cidr +The CIDR network address to add. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +Optional comment for the entry. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Level The firewall level: Cluster, Node, Vm, or Container. ```yaml Type: String Parameter Sets: (All) -Aliases: - +Aliases: Accepted values: Cluster, Node, Vm, Container Required: True @@ -47,58 +91,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Node -The node name. Required when Level is Node, Vm, or Container. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmId -The VM/Container ID. Required when Level is Vm or Container. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Name The IP set name. ```yaml Type: String Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cidr -The CIDR network address to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -113,7 +112,7 @@ Exclude this entry from the IP set match. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -122,13 +121,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Comment -Optional comment for the entry. +### -Node +The node name. Required when Level is Node, Vm, or Container. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -152,13 +151,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -VmId +The VM/Container ID. Required when Level is Vm or Container. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -167,13 +166,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -200,7 +199,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/New-PveFirewallRule.md b/docs/cmdlets/New-PveFirewallRule.md index 0bf782a..24d9b86 100644 --- a/docs/cmdlets/New-PveFirewallRule.md +++ b/docs/cmdlets/New-PveFirewallRule.md @@ -31,78 +31,13 @@ PS C:\> New-PveFirewallRule -Level Cluster -Type in -Action ACCEPT -Proto tcp -D ## PARAMETERS -### -Level -The firewall level: Cluster, Node, Vm, or Container. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Accepted values: Cluster, Node, Vm, Container - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Node -The node name. Required when Level is Node, Vm, or Container. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmId -The VM/Container ID. Required when Level is Vm or Container. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The rule type: in, out, or group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Accepted values: in, out, group - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Action The rule action: ACCEPT, DROP, or REJECT. ```yaml Type: String Parameter Sets: (All) -Aliases: - +Aliases: Accepted values: ACCEPT, DROP, REJECT Required: True @@ -112,13 +47,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enable -Enable the rule. +### -Comment +Rule comment. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -127,13 +62,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Source -Source address or alias. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -148,22 +83,7 @@ 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: +Aliases: Required: False Position: Named @@ -178,7 +98,7 @@ Destination port. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -187,58 +107,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Sport -Source port. +### -Enable +Enable the rule. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -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: +Aliases: Required: False Position: Named @@ -253,7 +128,83 @@ Network interface. ```yaml Type: String 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 Position: Named @@ -277,13 +228,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Source +Source address or alias. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -292,13 +243,59 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Sport +Source port. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The rule type: in, out, or group. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: in, out, group + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM/Container ID. Required when Level is Vm or Container. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -325,7 +322,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/New-PveGroup.md b/docs/cmdlets/New-PveGroup.md index c11f7ca..4fe3c69 100644 --- a/docs/cmdlets/New-PveGroup.md +++ b/docs/cmdlets/New-PveGroup.md @@ -29,28 +29,13 @@ PS C:\> New-PveGroup -GroupId admins -Comment 'Admin group' ## PARAMETERS -### -GroupId -The group identifier. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Comment Comment or description for the group. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -59,6 +44,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +The group identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -89,21 +104,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -122,7 +122,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/New-PvePool.md b/docs/cmdlets/New-PvePool.md index af97ded..4893176 100644 --- a/docs/cmdlets/New-PvePool.md +++ b/docs/cmdlets/New-PvePool.md @@ -13,8 +13,8 @@ Creates a new resource pool in Proxmox VE. ## SYNTAX ``` -New-PvePool [-PoolId] [-Comment ] [-Session ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] +New-PvePool [-PoolId] [-Comment ] [-Session ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -29,28 +29,13 @@ PS C:\> New-PvePool -PoolId production -Comment 'Production VMs' ## PARAMETERS -### -PoolId -The pool ID to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Comment An optional comment or description for the pool. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -59,6 +44,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PoolId +The pool ID to create. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -89,21 +104,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -122,7 +122,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/New-PveSdnController.md b/docs/cmdlets/New-PveSdnController.md index 97c4b51..5379798 100644 --- a/docs/cmdlets/New-PveSdnController.md +++ b/docs/cmdlets/New-PveSdnController.md @@ -13,9 +13,8 @@ Creates a new SDN controller in Proxmox VE. ## SYNTAX ``` -New-PveSdnController [-Controller] [-Type] [-Asn ] [-Peers ] - [-Node ] [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] +New-PveSdnController [-Controller] [-Type] [-Asn ] [-Peers ] [-Node ] + [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -30,13 +29,43 @@ PS C:\> New-PveSdnController -Controller bgp1 -Type bgp -Asn 65001 ## 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 The controller identifier. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -45,30 +74,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -The controller type. +### -Node +The node this controller is configured on. ```yaml Type: String Parameter Sets: (All) -Aliases: - -Accepted values: evpn, bgp - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Asn -The Autonomous System Number for BGP/EVPN. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -83,22 +95,7 @@ Comma-separated list of BGP peer addresses. ```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 this controller is configured on. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -122,6 +119,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Type +The controller type. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: evpn, bgp + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -137,21 +150,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -170,7 +168,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/New-PveSdnDns.md b/docs/cmdlets/New-PveSdnDns.md index bbbd601..dd4ffd9 100644 --- a/docs/cmdlets/New-PveSdnDns.md +++ b/docs/cmdlets/New-PveSdnDns.md @@ -30,13 +30,28 @@ PS C:\> New-PveSdnDns -Dns pdns1 -Type powerdns -Url https://dns.example.com -Ke ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Dns The DNS plugin identifier. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -45,45 +60,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -The DNS plugin type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Accepted values: powerdns - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url -The URL of the DNS service API. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Key The API key for the DNS service. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -98,22 +81,7 @@ The IPv6 reverse zone mask length. ```yaml Type: Int32 Parameter Sets: (All) -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: +Aliases: Required: False Position: Named @@ -137,13 +105,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Ttl +The TTL (time-to-live) for DNS records. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -152,13 +120,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Type +The DNS plugin type. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: powerdns + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Url +The URL of the DNS service API. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -185,7 +184,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/New-PveSdnIpam.md b/docs/cmdlets/New-PveSdnIpam.md index 2654df3..3d6ef8c 100644 --- a/docs/cmdlets/New-PveSdnIpam.md +++ b/docs/cmdlets/New-PveSdnIpam.md @@ -29,13 +29,28 @@ PS C:\> New-PveSdnIpam -Ipam pveipam -Type pve ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Ipam The IPAM plugin identifier. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -44,60 +59,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -The IPAM plugin type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Accepted values: pve, netbox, phpipam - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Url -The URL of the external IPAM service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Token -The API token for the external IPAM service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Section The configuration section identifier. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -121,13 +89,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Token +The API token for the external IPAM service. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -136,13 +104,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Type +The IPAM plugin type. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: pve, netbox, phpipam + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Url +The URL of the external IPAM service. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -169,7 +168,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/New-PveStorageDisk.md b/docs/cmdlets/New-PveStorageDisk.md index e2e0c18..c89691a 100644 --- a/docs/cmdlets/New-PveStorageDisk.md +++ b/docs/cmdlets/New-PveStorageDisk.md @@ -30,31 +30,16 @@ PS C:\> New-PveStorageDisk -Node pve1 -Storage local-lvm -Filename vm-100-disk-1 ## PARAMETERS -### -Node -The PVE node name. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Storage -The storage pool name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -66,7 +51,7 @@ The filename for the new disk (e.g. vm-100-disk-1). ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 @@ -75,29 +60,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Size -The size of the disk (e.g. 32G, 100M). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Format The disk image format (raw, qcow2, vmdk). ```yaml Type: String Parameter Sets: (All) -Aliases: - +Aliases: Accepted values: raw, qcow2, vmdk Required: False @@ -107,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -122,6 +106,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Size +The size of the disk (e.g. 32G, 100M). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Storage +The storage pool name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -137,21 +151,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -170,7 +169,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/Read-PveVmGuestFile.md b/docs/cmdlets/Read-PveVmGuestFile.md index b04dbf1..3c0539a 100644 --- a/docs/cmdlets/Read-PveVmGuestFile.md +++ b/docs/cmdlets/Read-PveVmGuestFile.md @@ -29,43 +29,13 @@ PS C:\> Read-PveVmGuestFile -Node pve1 -VmId 100 -File /etc/hostname ## PARAMETERS -### -Node -The PVE node name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmId -The VM identifier. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - ### -File The file path inside the guest to read. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -74,6 +44,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -89,6 +74,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -ProgressAction {{ Fill ProgressAction Description }} @@ -107,7 +107,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.Int32 diff --git a/docs/cmdlets/Remove-PveBackupJob.md b/docs/cmdlets/Remove-PveBackupJob.md index 66651ff..ee09b75 100644 --- a/docs/cmdlets/Remove-PveBackupJob.md +++ b/docs/cmdlets/Remove-PveBackupJob.md @@ -13,8 +13,8 @@ Removes a scheduled backup job from Proxmox VE. ## SYNTAX ``` -Remove-PveBackupJob [-Id] [-Session ] [-ProgressAction ] - [-WhatIf] [-Confirm] [] +Remove-PveBackupJob [-Id] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -29,13 +29,28 @@ PS C:\> Remove-PveBackupJob -Id "example" ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id The backup job ID. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -74,21 +89,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -107,7 +107,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Remove-PveDomain.md b/docs/cmdlets/Remove-PveDomain.md index a998e7e..dab3fbb 100644 --- a/docs/cmdlets/Remove-PveDomain.md +++ b/docs/cmdlets/Remove-PveDomain.md @@ -13,8 +13,8 @@ Removes a Proxmox VE authentication domain/realm. ## SYNTAX ``` -Remove-PveDomain [-Realm] [-Session ] [-ProgressAction ] - [-WhatIf] [-Confirm] [] +Remove-PveDomain [-Realm] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -29,13 +29,28 @@ PS C:\> Remove-PveDomain -Realm "example" ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Realm The realm identifier to remove. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -74,21 +89,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -107,7 +107,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Remove-PveFirewallAlias.md b/docs/cmdlets/Remove-PveFirewallAlias.md index 0d758f8..21c63e0 100644 --- a/docs/cmdlets/Remove-PveFirewallAlias.md +++ b/docs/cmdlets/Remove-PveFirewallAlias.md @@ -29,14 +29,28 @@ PS C:\> Remove-PveFirewallAlias -Level Cluster -Name myserver ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Level The firewall level: Cluster, Node, Vm, or Container. ```yaml Type: String Parameter Sets: (All) -Aliases: - +Aliases: Accepted values: Cluster, Node, Vm, Container Required: True @@ -46,43 +60,13 @@ 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 remove. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -91,6 +75,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Node +The node name. Required when Level is Node, Vm, or Container. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -106,13 +105,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -VmId +The VM/Container ID. Required when Level is Vm or Container. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -121,13 +120,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -154,7 +153,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/Remove-PveFirewallGroup.md b/docs/cmdlets/Remove-PveFirewallGroup.md index d586ec7..28a2192 100644 --- a/docs/cmdlets/Remove-PveFirewallGroup.md +++ b/docs/cmdlets/Remove-PveFirewallGroup.md @@ -29,13 +29,28 @@ PS C:\> Remove-PveFirewallGroup -Group webservers ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Group The security group name to remove. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -74,21 +89,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -107,7 +107,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/Remove-PveFirewallIpSet.md b/docs/cmdlets/Remove-PveFirewallIpSet.md index 0081bc1..db6352f 100644 --- a/docs/cmdlets/Remove-PveFirewallIpSet.md +++ b/docs/cmdlets/Remove-PveFirewallIpSet.md @@ -29,14 +29,28 @@ PS C:\> Remove-PveFirewallIpSet -Level Cluster -Name trusted ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Level The firewall level: Cluster, Node, Vm, or Container. ```yaml Type: String Parameter Sets: (All) -Aliases: - +Aliases: Accepted values: Cluster, Node, Vm, Container Required: True @@ -46,43 +60,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Node -The node name. Required when Level is Node, Vm, or Container. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmId -The VM/Container ID. Required when Level is Vm or Container. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Name The IP set name to remove. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -91,6 +75,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Node +The node name. Required when Level is Node, Vm, or Container. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -106,13 +105,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -VmId +The VM/Container ID. Required when Level is Vm or Container. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -121,13 +120,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -154,7 +153,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/Remove-PveFirewallIpSetEntry.md b/docs/cmdlets/Remove-PveFirewallIpSetEntry.md index caa17d6..e976761 100644 --- a/docs/cmdlets/Remove-PveFirewallIpSetEntry.md +++ b/docs/cmdlets/Remove-PveFirewallIpSetEntry.md @@ -13,9 +13,8 @@ Removes an entry from a firewall IP set. ## SYNTAX ``` -Remove-PveFirewallIpSetEntry [-Level] [-Node ] [-VmId ] -Name - -Cidr [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] +Remove-PveFirewallIpSetEntry [-Level] [-Node ] [-VmId ] -Name -Cidr + [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -30,14 +29,43 @@ PS C:\> Remove-PveFirewallIpSetEntry -Level Cluster -Name trusted -Cidr 10.0.0.0 ## PARAMETERS +### -Cidr +The CIDR network address to remove. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Level The firewall level: Cluster, Node, Vm, or Container. ```yaml Type: String Parameter Sets: (All) -Aliases: - +Aliases: Accepted values: Cluster, Node, Vm, Container Required: True @@ -47,43 +75,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Node -The node name. Required when Level is Node, Vm, or Container. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmId -The VM/Container ID. Required when Level is Vm or Container. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Name The IP set name. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -92,15 +90,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Cidr -The CIDR network address to remove. +### -Node +The node name. Required when Level is Node, Vm, or Container. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -122,13 +120,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -VmId +The VM/Container ID. Required when Level is Vm or Container. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -137,13 +135,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -170,7 +168,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/Remove-PveFirewallRule.md b/docs/cmdlets/Remove-PveFirewallRule.md index 3c59b33..e7d36af 100644 --- a/docs/cmdlets/Remove-PveFirewallRule.md +++ b/docs/cmdlets/Remove-PveFirewallRule.md @@ -29,14 +29,28 @@ PS C:\> Remove-PveFirewallRule -Level Cluster -Position 0 ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Level The firewall level: Cluster, Node, Vm, or Container. ```yaml Type: String Parameter Sets: (All) -Aliases: - +Aliases: Accepted values: Cluster, Node, Vm, Container Required: True @@ -52,22 +66,7 @@ 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: +Aliases: Required: False Position: Named @@ -82,7 +81,7 @@ The rule position to remove. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -106,13 +105,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -VmId +The VM/Container ID. Required when Level is Vm or Container. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -121,13 +120,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -154,7 +153,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/Remove-PveGroup.md b/docs/cmdlets/Remove-PveGroup.md index da7297f..5516098 100644 --- a/docs/cmdlets/Remove-PveGroup.md +++ b/docs/cmdlets/Remove-PveGroup.md @@ -13,8 +13,8 @@ Removes a Proxmox VE group. ## SYNTAX ``` -Remove-PveGroup [-GroupId] [-Session ] [-ProgressAction ] - [-WhatIf] [-Confirm] [] +Remove-PveGroup [-GroupId] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -29,13 +29,28 @@ PS C:\> Remove-PveGroup -GroupId "example" ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -GroupId The group identifier to remove. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -74,21 +89,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -107,7 +107,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Remove-PvePool.md b/docs/cmdlets/Remove-PvePool.md index 5b40522..6804384 100644 --- a/docs/cmdlets/Remove-PvePool.md +++ b/docs/cmdlets/Remove-PvePool.md @@ -13,8 +13,8 @@ Removes a resource pool from Proxmox VE. ## SYNTAX ``` -Remove-PvePool [-PoolId] [-Session ] [-ProgressAction ] - [-WhatIf] [-Confirm] [] +Remove-PvePool [-PoolId] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -29,13 +29,28 @@ PS C:\> Remove-PvePool -PoolId "example" ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PoolId The pool ID to remove. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -74,21 +89,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -107,7 +107,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Remove-PveSdnController.md b/docs/cmdlets/Remove-PveSdnController.md index 16dab4d..2281155 100644 --- a/docs/cmdlets/Remove-PveSdnController.md +++ b/docs/cmdlets/Remove-PveSdnController.md @@ -29,13 +29,28 @@ PS C:\> Remove-PveSdnController -Controller "example" ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Controller The controller identifier to remove. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -74,21 +89,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -107,7 +107,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Remove-PveSdnDns.md b/docs/cmdlets/Remove-PveSdnDns.md index a2c7623..956b619 100644 --- a/docs/cmdlets/Remove-PveSdnDns.md +++ b/docs/cmdlets/Remove-PveSdnDns.md @@ -13,8 +13,8 @@ Removes an SDN DNS plugin from Proxmox VE. ## SYNTAX ``` -Remove-PveSdnDns [-Dns] [-Session ] [-ProgressAction ] - [-WhatIf] [-Confirm] [] +Remove-PveSdnDns [-Dns] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -29,13 +29,28 @@ PS C:\> Remove-PveSdnDns -Dns "example" ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Dns The DNS plugin identifier to remove. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -74,21 +89,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -107,7 +107,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Remove-PveSdnIpam.md b/docs/cmdlets/Remove-PveSdnIpam.md index df43ca7..2ca7931 100644 --- a/docs/cmdlets/Remove-PveSdnIpam.md +++ b/docs/cmdlets/Remove-PveSdnIpam.md @@ -13,8 +13,8 @@ Removes an SDN IPAM plugin from Proxmox VE. ## SYNTAX ``` -Remove-PveSdnIpam [-Ipam] [-Session ] [-ProgressAction ] - [-WhatIf] [-Confirm] [] +Remove-PveSdnIpam [-Ipam] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -29,13 +29,28 @@ PS C:\> Remove-PveSdnIpam -Ipam "example" ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Ipam The IPAM plugin identifier to remove. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -74,21 +89,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -107,7 +107,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Remove-PveStorageContent.md b/docs/cmdlets/Remove-PveStorageContent.md index 1b35d0e..885cc93 100644 --- a/docs/cmdlets/Remove-PveStorageContent.md +++ b/docs/cmdlets/Remove-PveStorageContent.md @@ -13,8 +13,8 @@ Removes a content volume from a Proxmox VE storage. ## SYNTAX ``` -Remove-PveStorageContent [-Node] [-Storage] [-Volume] - [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] +Remove-PveStorageContent [-Node] [-Storage] [-Volume] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -29,13 +29,28 @@ PS C:\> Remove-PveStorageContent -Node pve1 -Storage local -Volume "local:iso/ub ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Node The PVE node name. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -44,36 +59,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Storage -The storage pool name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: 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 {{ Fill Session Description }} @@ -89,6 +74,36 @@ 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 +``` + +### -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 Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -104,21 +119,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -137,7 +137,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Remove-PveVmDisk.md b/docs/cmdlets/Remove-PveVmDisk.md index 2a589e8..4c0141a 100644 --- a/docs/cmdlets/Remove-PveVmDisk.md +++ b/docs/cmdlets/Remove-PveVmDisk.md @@ -29,45 +29,15 @@ PS C:\> Remove-PveVmDisk -Node pve1 -VmId 100 -IdList scsi0 -Force ## PARAMETERS -### -Node -The PVE node name. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VmId -The VM identifier. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IdList -Comma-separated list of disk IDs to unlink (e.g. scsi0,scsi1). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -80,7 +50,7 @@ Force removal of disk images from storage. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -89,6 +59,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IdList +Comma-separated list of disk IDs to unlink (e.g. scsi0,scsi1). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -104,6 +104,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -119,21 +134,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -152,7 +152,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Reset-PveVm.md b/docs/cmdlets/Reset-PveVm.md index 1d2cb95..d43d18e 100644 --- a/docs/cmdlets/Reset-PveVm.md +++ b/docs/cmdlets/Reset-PveVm.md @@ -13,8 +13,8 @@ schema: 2.0.0 ## SYNTAX ``` -Reset-PveVm -Node -VmId [-Wait] [-Session ] [-ProgressAction ] - [-WhatIf] [-Confirm] [] +Reset-PveVm -Node -VmId [-Wait] [-Timeout ] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -137,6 +137,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Timeout +Timeout in seconds for -Wait (default 60). + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/docs/cmdlets/Resize-PveContainerDisk.md b/docs/cmdlets/Resize-PveContainerDisk.md index d3f3b1e..83f4860 100644 --- a/docs/cmdlets/Resize-PveContainerDisk.md +++ b/docs/cmdlets/Resize-PveContainerDisk.md @@ -13,8 +13,8 @@ Resizes a disk attached to an LXC container. ## SYNTAX ``` -Resize-PveContainerDisk -Node -VmId -Disk -Size - [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] +Resize-PveContainerDisk -Node -VmId -Disk -Size [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -29,33 +29,18 @@ PS C:\> Resize-PveContainerDisk -Node pve1 -VmId 100 -Disk rootfs -Size +5G ## PARAMETERS -### -Node -The PVE node name. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VmId -The container identifier. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -65,7 +50,7 @@ The disk/volume to resize (e.g. rootfs, mp0). ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -74,18 +59,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Size -New disk size (e.g. 50G or +5G to grow). +### -Node +The PVE node name. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -104,6 +89,36 @@ Accept pipeline input: 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 Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -119,21 +134,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -152,7 +152,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Resume-PveContainer.md b/docs/cmdlets/Resume-PveContainer.md index 2f28e3b..d4cba7f 100644 --- a/docs/cmdlets/Resume-PveContainer.md +++ b/docs/cmdlets/Resume-PveContainer.md @@ -29,13 +29,28 @@ PS C:\> Resume-PveContainer -Node pve1 -VmId 100 -Wait ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Node The PVE node name. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -44,51 +59,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -VmId -The container identifier. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -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 {{ Fill Session Description }} @@ -104,13 +74,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Timeout +Timeout in seconds for -Wait (default 60). + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 60 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -119,13 +119,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -152,7 +152,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Resume-PveVm.md b/docs/cmdlets/Resume-PveVm.md index 46408f5..e76258e 100644 --- a/docs/cmdlets/Resume-PveVm.md +++ b/docs/cmdlets/Resume-PveVm.md @@ -13,8 +13,8 @@ schema: 2.0.0 ## SYNTAX ``` -Resume-PveVm -Node -VmId [-Wait] [-Session ] [-ProgressAction ] - [-WhatIf] [-Confirm] [] +Resume-PveVm -Node -VmId [-Wait] [-Timeout ] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -137,6 +137,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Timeout +Timeout in seconds for -Wait (default 60). + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/docs/cmdlets/Send-PveFile.md b/docs/cmdlets/Send-PveFile.md index 13657ff..4aeb990 100644 --- a/docs/cmdlets/Send-PveFile.md +++ b/docs/cmdlets/Send-PveFile.md @@ -30,75 +30,13 @@ PS C:\> Send-PveFile -Node pve1 -Storage local -Path ./ubuntu.iso -ContentType i ## PARAMETERS -### -Node -The PVE node name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Storage -The storage pool name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Local path to the file to upload. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentType -Content type: iso, vztmpl, or import. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Accepted values: iso, vztmpl, import - -Required: False -Position: 3 -Default value: iso -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Checksum Checksum value to verify the upload. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -113,8 +51,7 @@ Checksum algorithm (md5, sha1, sha256, sha512). ```yaml Type: String Parameter Sets: (All) -Aliases: - +Aliases: Accepted values: md5, sha1, sha256, sha512 Required: False @@ -124,13 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Wait -Wait for the task to complete before returning. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -139,6 +76,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ContentType +Content type: iso, vztmpl, or import. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: iso, vztmpl, import + +Required: False +Position: 3 +Default value: iso +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Local path to the file to upload. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -154,13 +137,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Storage +The storage pool name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -169,13 +167,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -202,7 +200,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/Set-PveApiToken.md b/docs/cmdlets/Set-PveApiToken.md index 315ec0d..bd32a7f 100644 --- a/docs/cmdlets/Set-PveApiToken.md +++ b/docs/cmdlets/Set-PveApiToken.md @@ -30,43 +30,28 @@ PS C:\> Set-PveApiToken -UserId root@pam -TokenId mytoken -Comment 'Updated' ## PARAMETERS -### -UserId -The user ID (e.g. 'user@realm'). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TokenId -The token identifier. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - ### -Comment Comment describing the token. ```yaml Type: String 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 @@ -81,7 +66,7 @@ Expiration as Unix epoch (0 = no expiration). ```yaml Type: Int64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -96,7 +81,7 @@ Whether the token uses privilege separation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -120,6 +105,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TokenId +The token identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserId +The user ID (e.g. 'user@realm'). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -135,21 +150,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -168,7 +168,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Set-PveBackupJob.md b/docs/cmdlets/Set-PveBackupJob.md index e616a75..49a5b53 100644 --- a/docs/cmdlets/Set-PveBackupJob.md +++ b/docs/cmdlets/Set-PveBackupJob.md @@ -13,10 +13,10 @@ Updates a scheduled backup job on Proxmox VE. ## SYNTAX ``` -Set-PveBackupJob [-Id] [-Schedule ] [-Storage ] [-Mode ] - [-VmId ] [-All] [-Compress ] [-Node ] [-MailTo ] - [-MailNotification ] [-Enabled] [-Comment ] [-PruneBackups ] - [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] +Set-PveBackupJob [-Id] [-Schedule ] [-Storage ] [-Mode ] [-VmId ] + [-All] [-Compress ] [-Node ] [-MailTo ] [-MailNotification ] [-Enabled] + [-Comment ] [-PruneBackups ] [-Session ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,169 +31,13 @@ PS C:\> Set-PveBackupJob -Id backup-abc -Schedule '0 3 * * *' ## PARAMETERS -### -Id -The backup job ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Schedule -Cron-style schedule expression. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Storage -The target storage for backups. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mode -The backup mode. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Accepted values: snapshot, suspend, stop - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmId -Comma-separated list of VM IDs to back up. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -All Back up all VMs. ```yaml Type: SwitchParameter Parameter Sets: (All) -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: +Aliases: Required: False Position: Named @@ -208,7 +52,130 @@ A comment or description for the backup job. ```yaml Type: String 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 Position: Named @@ -223,7 +190,22 @@ Prune-backups configuration string. ```yaml Type: String 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 Position: Named @@ -247,13 +229,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Storage +The target storage for backups. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -262,13 +244,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -VmId +Comma-separated list of VM IDs to back up. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -295,7 +292,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Set-PveDomain.md b/docs/cmdlets/Set-PveDomain.md index 36939f4..bd02602 100644 --- a/docs/cmdlets/Set-PveDomain.md +++ b/docs/cmdlets/Set-PveDomain.md @@ -29,28 +29,28 @@ PS C:\> Set-PveDomain -Realm myldap -Comment 'Updated' ## PARAMETERS -### -Realm -The realm identifier. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - ### -Comment Updated comment or description for the domain. ```yaml Type: String 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 @@ -65,7 +65,7 @@ Set as the default authentication domain. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -74,6 +74,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Realm +The realm identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -104,21 +119,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -137,7 +137,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Set-PveFirewallAlias.md b/docs/cmdlets/Set-PveFirewallAlias.md index 30fae8d..30e13d8 100644 --- a/docs/cmdlets/Set-PveFirewallAlias.md +++ b/docs/cmdlets/Set-PveFirewallAlias.md @@ -30,75 +30,13 @@ PS C:\> Set-PveFirewallAlias -Level Cluster -Name myserver -Cidr 10.0.0.2/32 ## PARAMETERS -### -Level -The firewall level: Cluster, Node, Vm, or Container. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Accepted values: Cluster, Node, Vm, Container - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Node -The node name. Required when Level is Node, Vm, or Container. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmId -The VM/Container ID. Required when Level is Vm or Container. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -The alias name to update. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Cidr The updated CIDR network address. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -113,7 +51,68 @@ Updated comment for the alias. ```yaml Type: String 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 Position: Named @@ -137,13 +136,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -VmId +The VM/Container ID. Required when Level is Vm or Container. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -152,13 +151,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -185,7 +184,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/Set-PveFirewallIpSetEntry.md b/docs/cmdlets/Set-PveFirewallIpSetEntry.md index 3a7a041..322ca49 100644 --- a/docs/cmdlets/Set-PveFirewallIpSetEntry.md +++ b/docs/cmdlets/Set-PveFirewallIpSetEntry.md @@ -13,9 +13,9 @@ Updates an entry in a firewall IP set. ## SYNTAX ``` -Set-PveFirewallIpSetEntry [-Level] [-Node ] [-VmId ] -Name - -Cidr [-NoMatch] [-Comment ] [-Session ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] +Set-PveFirewallIpSetEntry [-Level] [-Node ] [-VmId ] -Name -Cidr + [-NoMatch] [-Comment ] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -30,14 +30,58 @@ PS C:\> Set-PveFirewallIpSetEntry -Level Cluster -Name trusted -Cidr 10.0.0.0/24 ## PARAMETERS +### -Cidr +The CIDR network address to update. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comment +Updated comment for the entry. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Level The firewall level: Cluster, Node, Vm, or Container. ```yaml Type: String Parameter Sets: (All) -Aliases: - +Aliases: Accepted values: Cluster, Node, Vm, Container Required: True @@ -47,58 +91,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Node -The node name. Required when Level is Node, Vm, or Container. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmId -The VM/Container ID. Required when Level is Vm or Container. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Name The IP set name. ```yaml Type: String Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cidr -The CIDR network address to update. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -113,7 +112,7 @@ Exclude this entry from the IP set match. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -122,13 +121,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Comment -Updated comment for the entry. +### -Node +The node name. Required when Level is Node, Vm, or Container. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -152,13 +151,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -VmId +The VM/Container ID. Required when Level is Vm or Container. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -167,13 +166,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -200,7 +199,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/Set-PveFirewallOptions.md b/docs/cmdlets/Set-PveFirewallOptions.md index 6ef639c..b422ce4 100644 --- a/docs/cmdlets/Set-PveFirewallOptions.md +++ b/docs/cmdlets/Set-PveFirewallOptions.md @@ -13,10 +13,9 @@ Updates firewall options at the specified level. ## SYNTAX ``` -Set-PveFirewallOptions [-Level] [-Node ] [-VmId ] [-Enable] - [-PolicyIn ] [-PolicyOut ] [-LogLevelIn ] [-LogLevelOut ] [-Dhcp] - [-Ndp] [-MacFilter] [-IpFilter] [-Session ] [-ProgressAction ] - [-WhatIf] [-Confirm] [] +Set-PveFirewallOptions [-Level] [-Node ] [-VmId ] [-Enable] [-PolicyIn ] + [-PolicyOut ] [-LogLevelIn ] [-LogLevelOut ] [-Dhcp] [-Ndp] [-MacFilter] [-IpFilter] + [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,30 +30,13 @@ PS C:\> Set-PveFirewallOptions -Level Cluster -Enable -PolicyIn DROP ## PARAMETERS -### -Level -The firewall level: Cluster, Node, Vm, or Container. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: - -Accepted values: Cluster, Node, Vm, Container - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Node -The node name. Required when Level is Node, Vm, or Container. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -63,13 +45,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VmId -The VM/Container ID. Required when Level is Vm or Container. +### -Dhcp +Enable DHCP. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -84,7 +66,113 @@ Enable or disable the firewall. ```yaml Type: SwitchParameter 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 Position: Named @@ -99,8 +187,7 @@ Default policy for incoming traffic. ```yaml Type: String Parameter Sets: (All) -Aliases: - +Aliases: Accepted values: ACCEPT, DROP, REJECT Required: False @@ -116,8 +203,7 @@ Default policy for outgoing traffic. ```yaml Type: String Parameter Sets: (All) -Aliases: - +Aliases: Accepted values: ACCEPT, DROP, REJECT Required: False @@ -127,96 +213,6 @@ 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 -``` - -### -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 {{ Fill Session Description }} @@ -232,13 +228,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -VmId +The VM/Container ID. Required when Level is Vm or Container. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -247,13 +243,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -280,7 +276,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/Set-PveFirewallRule.md b/docs/cmdlets/Set-PveFirewallRule.md index 06c8f90..752dc8a 100644 --- a/docs/cmdlets/Set-PveFirewallRule.md +++ b/docs/cmdlets/Set-PveFirewallRule.md @@ -13,11 +13,10 @@ Updates a firewall rule. ## SYNTAX ``` -Set-PveFirewallRule [-Level] [-Node ] [-VmId ] -Position - [-Type ] [-Action ] [-Enable] [-Source ] [-Dest ] [-Proto ] - [-Dport ] [-Sport ] [-Comment ] [-Macro ] [-Log ] - [-Iface ] [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] +Set-PveFirewallRule [-Level] [-Node ] [-VmId ] -Position [-Type ] + [-Action ] [-Enable] [-Source ] [-Dest ] [-Proto ] [-Dport ] + [-Sport ] [-Comment ] [-Macro ] [-Log ] [-Iface ] + [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -32,93 +31,13 @@ PS C:\> Set-PveFirewallRule -Level Cluster -Position 0 -Enable ## PARAMETERS -### -Level -The firewall level: Cluster, Node, Vm, or Container. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Accepted values: Cluster, Node, Vm, Container - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Node -The node name. Required when Level is Node, Vm, or Container. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmId -The VM/Container ID. Required when Level is Vm or Container. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Position -The rule position to update. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -The rule type: in, out, or group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Accepted values: in, out, group - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Action The rule action: ACCEPT, DROP, or REJECT. ```yaml Type: String Parameter Sets: (All) -Aliases: - +Aliases: Accepted values: ACCEPT, DROP, REJECT Required: False @@ -128,103 +47,13 @@ Accept pipeline input: 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 Rule comment. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -233,13 +62,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Macro -Macro name. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -248,13 +77,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Log -Log level. +### -Dest +Destination address or alias. ```yaml Type: String 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 Position: Named @@ -269,7 +128,98 @@ Network interface. ```yaml Type: String 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 Position: Named @@ -293,13 +243,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Source +Source address or alias. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -308,13 +258,59 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Sport +Source port. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The rule type: in, out, or group. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: in, out, group + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM/Container ID. Required when Level is Vm or Container. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -341,7 +337,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/Set-PveGroup.md b/docs/cmdlets/Set-PveGroup.md index fdfa362..79bbd28 100644 --- a/docs/cmdlets/Set-PveGroup.md +++ b/docs/cmdlets/Set-PveGroup.md @@ -29,28 +29,13 @@ PS C:\> Set-PveGroup -GroupId admins -Comment 'Updated' ## PARAMETERS -### -GroupId -The group identifier. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - ### -Comment Updated comment or description. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -59,6 +44,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GroupId +The group identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -89,21 +104,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -122,7 +122,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Set-PveNetwork.md b/docs/cmdlets/Set-PveNetwork.md index 7c88910..9c452f4 100644 --- a/docs/cmdlets/Set-PveNetwork.md +++ b/docs/cmdlets/Set-PveNetwork.md @@ -13,10 +13,10 @@ schema: 2.0.0 ## SYNTAX ``` -Set-PveNetwork [-Node] [-Iface] [-Address ] [-Netmask ] [-Gateway ] - [-Address6 ] [-Netmask6 ] [-Gateway6 ] [-BridgePorts ] [-BondSlaves ] - [-Mtu ] [-Autostart] [-Comments ] [-Session ] [-ProgressAction ] - [-WhatIf] [-Confirm] [] +Set-PveNetwork [-Node] [-Iface] -Type [-Address ] [-Netmask ] + [-Gateway ] [-Address6 ] [-Netmask6 ] [-Gateway6 ] [-BridgePorts ] + [-BondSlaves ] [-Mtu ] [-Autostart] [-Comments ] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -289,6 +289,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Type +Interface type (bridge, bond, eth, vlan, OVSBridge). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/docs/cmdlets/Set-PveNodeConfig.md b/docs/cmdlets/Set-PveNodeConfig.md index e9a0ab6..19982a6 100644 --- a/docs/cmdlets/Set-PveNodeConfig.md +++ b/docs/cmdlets/Set-PveNodeConfig.md @@ -29,18 +29,18 @@ PS C:\> Set-PveNodeConfig -Node pve1 -Description 'Primary node' ## PARAMETERS -### -Node -The PVE node name. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 0 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -50,7 +50,7 @@ Node description or comment. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -59,18 +59,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Wakeonlan -Wake-on-LAN configuration. +### -Node +The PVE node name. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: -Required: False -Position: Named +Required: True +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -89,13 +89,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Wakeonlan +Wake-on-LAN configuration. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -104,13 +104,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -137,7 +137,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Set-PveNodeDns.md b/docs/cmdlets/Set-PveNodeDns.md index 4d43369..146d97f 100644 --- a/docs/cmdlets/Set-PveNodeDns.md +++ b/docs/cmdlets/Set-PveNodeDns.md @@ -29,31 +29,16 @@ PS C:\> Set-PveNodeDns -Node pve1 -Search example.com -Dns1 8.8.8.8 ## PARAMETERS -### -Node -The PVE node name. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Search -The DNS search domain. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -65,7 +50,7 @@ Primary DNS server address. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -80,7 +65,7 @@ Secondary DNS server address. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -95,7 +80,7 @@ Tertiary DNS server address. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -104,6 +89,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Search +The DNS search domain. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -134,21 +149,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -167,7 +167,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Set-PvePassword.md b/docs/cmdlets/Set-PvePassword.md index f87add6..0be5b9e 100644 --- a/docs/cmdlets/Set-PvePassword.md +++ b/docs/cmdlets/Set-PvePassword.md @@ -29,16 +29,16 @@ PS C:\> Set-PvePassword -UserId admin@pve -Password (Read-Host -AsSecureString) ## PARAMETERS -### -UserId -The user ID in user@realm format. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 0 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -50,7 +50,7 @@ The new password for the user. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -74,6 +74,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UserId +The user ID in user@realm format. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -89,21 +104,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -122,7 +122,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### None diff --git a/docs/cmdlets/Set-PvePool.md b/docs/cmdlets/Set-PvePool.md index de67b8f..979c4e3 100644 --- a/docs/cmdlets/Set-PvePool.md +++ b/docs/cmdlets/Set-PvePool.md @@ -29,28 +29,13 @@ PS C:\> Set-PvePool -PoolId production -Comment 'Updated' ## 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 An optional comment or description. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -59,13 +44,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Members -Comma-separated list of members to add. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -80,7 +65,7 @@ Comma-separated list of members to remove. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -89,6 +74,36 @@ Accept pipeline input: 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 {{ Fill Session Description }} @@ -119,21 +134,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -152,7 +152,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Set-PveRole.md b/docs/cmdlets/Set-PveRole.md index 13555a1..047f672 100644 --- a/docs/cmdlets/Set-PveRole.md +++ b/docs/cmdlets/Set-PveRole.md @@ -29,18 +29,18 @@ PS C:\> Set-PveRole -RoleId MyRole -Privileges 'VM.Audit,VM.Console' ## PARAMETERS -### -RoleId -The role identifier. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 0 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -50,7 +50,7 @@ Comma-separated list of privileges. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -59,6 +59,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RoleId +The role identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -89,21 +104,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -122,7 +122,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Set-PveSdnController.md b/docs/cmdlets/Set-PveSdnController.md index 9502787..b394ebf 100644 --- a/docs/cmdlets/Set-PveSdnController.md +++ b/docs/cmdlets/Set-PveSdnController.md @@ -29,13 +29,43 @@ PS C:\> Set-PveSdnController -Controller bgp1 -Asn 65002 ## 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 The SDN controller identifier. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -44,13 +74,13 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Asn -The Autonomous System Number for BGP/EVPN. +### -Node +The node this controller is configured on. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -65,22 +95,7 @@ Comma-separated list of BGP peer addresses. ```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 this controller is configured on. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -119,21 +134,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -152,7 +152,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Set-PveSdnDns.md b/docs/cmdlets/Set-PveSdnDns.md index 56a2045..c82c2b7 100644 --- a/docs/cmdlets/Set-PveSdnDns.md +++ b/docs/cmdlets/Set-PveSdnDns.md @@ -29,13 +29,28 @@ PS C:\> Set-PveSdnDns -Dns pdns1 -Url https://dns2.example.com ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Dns The SDN DNS plugin identifier. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -44,28 +59,13 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Url -The DNS server URL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Key The TSIG key for DNS updates. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -80,22 +80,7 @@ The IPv6 reverse DNS mask length. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ttl -The TTL for DNS records. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -119,13 +104,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Ttl +The TTL for DNS records. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -134,13 +119,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -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 +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -167,7 +167,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Set-PveSdnIpam.md b/docs/cmdlets/Set-PveSdnIpam.md index d5b6541..c6363a3 100644 --- a/docs/cmdlets/Set-PveSdnIpam.md +++ b/docs/cmdlets/Set-PveSdnIpam.md @@ -13,8 +13,8 @@ Updates an SDN IPAM plugin configuration in Proxmox VE. ## SYNTAX ``` -Set-PveSdnIpam [-Ipam] [-Url ] [-Token ] [-Section ] - [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] +Set-PveSdnIpam [-Ipam] [-Url ] [-Token ] [-Section ] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -29,13 +29,28 @@ PS C:\> Set-PveSdnIpam -Ipam myipam -Url https://ipam.example.com ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Ipam The SDN IPAM plugin identifier. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -44,43 +59,13 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Url -The IPAM server URL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Token -The API token for the IPAM server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Section The section ID in the IPAM server. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -104,13 +89,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Token +The API token for the IPAM server. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -119,13 +104,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Url +The IPAM server URL. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -152,7 +152,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Set-PveSdnSubnet.md b/docs/cmdlets/Set-PveSdnSubnet.md index 861e82b..50af610 100644 --- a/docs/cmdlets/Set-PveSdnSubnet.md +++ b/docs/cmdlets/Set-PveSdnSubnet.md @@ -13,9 +13,9 @@ Updates an SDN subnet configuration in Proxmox VE. ## SYNTAX ``` -Set-PveSdnSubnet [-Vnet] [-Subnet] [-Gateway ] [-Snat] - [-DnsZonePrefix ] [-DhcpRange ] [-Session ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] +Set-PveSdnSubnet [-Vnet] [-Subnet] [-Gateway ] [-Snat] [-DnsZonePrefix ] + [-DhcpRange ] [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -30,73 +30,13 @@ PS C:\> Set-PveSdnSubnet -Vnet myvnet -Subnet 10.0.0.0/24 -Gateway 10.0.0.1 ## PARAMETERS -### -Vnet -The SDN VNet name. - -```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. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -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: +Aliases: cf Required: False Position: Named @@ -111,7 +51,37 @@ DHCP range for this subnet. ```yaml Type: String 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 Position: Named @@ -135,13 +105,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Snat +Enable SNAT for this subnet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -150,13 +120,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Subnet +The subnet CIDR. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Vnet +The SDN VNet name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -183,7 +183,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Set-PveSdnVnet.md b/docs/cmdlets/Set-PveSdnVnet.md index 072526f..99a52d4 100644 --- a/docs/cmdlets/Set-PveSdnVnet.md +++ b/docs/cmdlets/Set-PveSdnVnet.md @@ -29,28 +29,13 @@ PS C:\> Set-PveSdnVnet -Vnet myvnet -Zone myzone ## PARAMETERS -### -Vnet -The SDN VNet name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - ### -Alias An alias for the VNet. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -59,43 +44,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Zone -The zone this VNet belongs to. - -```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. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -119,6 +74,51 @@ 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 +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 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 ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Zone +The zone this VNet belongs to. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -167,7 +167,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Set-PveSdnZone.md b/docs/cmdlets/Set-PveSdnZone.md index 07609c8..c92f049 100644 --- a/docs/cmdlets/Set-PveSdnZone.md +++ b/docs/cmdlets/Set-PveSdnZone.md @@ -29,18 +29,18 @@ PS C:\> Set-PveSdnZone -Zone myzone -Dns pdns1 ## PARAMETERS -### -Zone -The SDN zone name. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 0 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -50,22 +50,7 @@ DNS server 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 -``` - -### -Reversedns -Reverse DNS server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -80,7 +65,22 @@ DNS zone name for registration. ```yaml Type: String 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 Position: Named @@ -119,18 +119,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Zone +The SDN zone name. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -152,7 +152,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Set-PveStorage.md b/docs/cmdlets/Set-PveStorage.md index 5487234..b087931 100644 --- a/docs/cmdlets/Set-PveStorage.md +++ b/docs/cmdlets/Set-PveStorage.md @@ -14,8 +14,8 @@ Updates a Proxmox VE storage definition. ``` Set-PveStorage [-Storage] [-Content ] [-Nodes ] [-Enabled] [-Shared] - [-AdditionalConfig ] [-Session ] [-ProgressAction ] - [-WhatIf] [-Confirm] [] + [-AdditionalConfig ] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -30,18 +30,33 @@ PS C:\> Set-PveStorage -Storage local -Content 'images,iso,backup' ## PARAMETERS -### -Storage -The storage identifier. +### -AdditionalConfig +Additional configuration parameters as a hashtable. ```yaml -Type: String +Type: Hashtable Parameter Sets: (All) -Aliases: +Aliases: -Required: True -Position: 0 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 ``` @@ -51,22 +66,7 @@ Comma-separated content types. ```yaml Type: String Parameter Sets: (All) -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: +Aliases: Required: False Position: Named @@ -81,7 +81,7 @@ Whether the storage is enabled. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -90,28 +90,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Shared -Whether the storage is shared. +### -Nodes +Comma-separated list of nodes. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdditionalConfig -Additional configuration parameters as a hashtable. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -135,13 +120,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Shared +Whether the storage is shared. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -150,13 +135,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Storage +The storage identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -183,7 +183,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Set-PveStorageContent.md b/docs/cmdlets/Set-PveStorageContent.md index a2db146..750c4b4 100644 --- a/docs/cmdlets/Set-PveStorageContent.md +++ b/docs/cmdlets/Set-PveStorageContent.md @@ -29,13 +29,28 @@ PS C:\> Set-PveStorageContent -Node pve1 -Storage local -Volume 'local:iso/ubunt ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Node The PVE node name. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -44,43 +59,13 @@ 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 -``` - -### -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 or description for the volume. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -104,6 +89,36 @@ 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 +``` + +### -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 Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -119,21 +134,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -152,7 +152,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Set-PveVmGuestPassword.md b/docs/cmdlets/Set-PveVmGuestPassword.md index 1209e4d..c6a359e 100644 --- a/docs/cmdlets/Set-PveVmGuestPassword.md +++ b/docs/cmdlets/Set-PveVmGuestPassword.md @@ -13,9 +13,8 @@ Sets a user password inside the guest via the QEMU guest agent. ## SYNTAX ``` -Set-PveVmGuestPassword [-Node] [-VmId] -Username -Password - [-Crypted] [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] - [] +Set-PveVmGuestPassword [-Node] [-VmId] -Username -Password [-Crypted] + [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -30,60 +29,15 @@ PS C:\> Set-PveVmGuestPassword -Node pve1 -VmId 100 -Username root -Password (Re ## PARAMETERS -### -Node -The PVE node name. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmId -The VM identifier. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Username -The username whose password to set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Password -The new password. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -96,7 +50,7 @@ Indicates the password is already crypted/hashed. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -105,6 +59,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +The new password. + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -120,6 +104,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Username +The username whose password to set. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -135,21 +149,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -168,7 +167,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.Int32 diff --git a/docs/cmdlets/Start-PveContainer.md b/docs/cmdlets/Start-PveContainer.md index bfc860c..8dd2b45 100644 --- a/docs/cmdlets/Start-PveContainer.md +++ b/docs/cmdlets/Start-PveContainer.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -Start-PveContainer -Node -VmId [-Wait] [-Session ] +Start-PveContainer -Node -VmId [-Wait] [-Timeout ] [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` @@ -137,6 +137,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Timeout +Timeout in seconds for -Wait (default 60). + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/docs/cmdlets/Start-PveNodeVms.md b/docs/cmdlets/Start-PveNodeVms.md index 410e243..79264d6 100644 --- a/docs/cmdlets/Start-PveNodeVms.md +++ b/docs/cmdlets/Start-PveNodeVms.md @@ -29,13 +29,28 @@ PS C:\> Start-PveNodeVms -Node pve1 ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Node The PVE node name. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -44,21 +59,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -VmIds -Comma-separated list of VM IDs to start. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Session {{ Fill Session Description }} @@ -74,13 +74,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -VmIds +Comma-separated list of VM IDs to start. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -89,13 +89,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -122,7 +122,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Start-PveVm.md b/docs/cmdlets/Start-PveVm.md index 141a37b..8d36682 100644 --- a/docs/cmdlets/Start-PveVm.md +++ b/docs/cmdlets/Start-PveVm.md @@ -13,8 +13,8 @@ schema: 2.0.0 ## SYNTAX ``` -Start-PveVm -Node -VmId [-Wait] [-Session ] [-ProgressAction ] - [-WhatIf] [-Confirm] [] +Start-PveVm -Node -VmId [-Wait] [-Timeout ] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -137,6 +137,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Timeout +Timeout in seconds for -Wait (default 60). + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/docs/cmdlets/Stop-PveContainer.md b/docs/cmdlets/Stop-PveContainer.md index 2577614..3f8c3ac 100644 --- a/docs/cmdlets/Stop-PveContainer.md +++ b/docs/cmdlets/Stop-PveContainer.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -Stop-PveContainer -Node -VmId [-Wait] [-Session ] +Stop-PveContainer -Node -VmId [-Wait] [-Timeout ] [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` @@ -137,6 +137,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Timeout +Timeout in seconds for -Wait (default 60). + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/docs/cmdlets/Stop-PveNodeVms.md b/docs/cmdlets/Stop-PveNodeVms.md index e89d442..c1c6527 100644 --- a/docs/cmdlets/Stop-PveNodeVms.md +++ b/docs/cmdlets/Stop-PveNodeVms.md @@ -29,28 +29,13 @@ PS C:\> Stop-PveNodeVms -Node pve1 ## PARAMETERS -### -Node -The PVE node name. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VmIds -Comma-separated list of VM IDs to stop. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -65,7 +50,7 @@ Force stop VMs without waiting for graceful shutdown. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -74,6 +59,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -89,13 +89,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -VmIds +Comma-separated list of VM IDs to stop. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -104,13 +104,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -137,7 +137,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Stop-PveTask.md b/docs/cmdlets/Stop-PveTask.md index 0a2880b..d855f23 100644 --- a/docs/cmdlets/Stop-PveTask.md +++ b/docs/cmdlets/Stop-PveTask.md @@ -13,8 +13,8 @@ Stops a running task on a Proxmox VE node. ## SYNTAX ``` -Stop-PveTask [-Node] [-Upid] [-Session ] - [-ProgressAction ] [-WhatIf] [-Confirm] [] +Stop-PveTask [-Node] [-Upid] [-Session ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -29,13 +29,28 @@ PS C:\> Stop-PveTask -Node pve1 -Upid 'UPID:pve1:...' ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Node The PVE node name. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -44,21 +59,6 @@ Accept pipeline input: 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 {{ Fill Session Description }} @@ -74,6 +74,21 @@ Accept pipeline input: 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 Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -89,21 +104,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -122,7 +122,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Stop-PveVm.md b/docs/cmdlets/Stop-PveVm.md index b80dc64..17ef92a 100644 --- a/docs/cmdlets/Stop-PveVm.md +++ b/docs/cmdlets/Stop-PveVm.md @@ -13,8 +13,8 @@ schema: 2.0.0 ## SYNTAX ``` -Stop-PveVm -Node -VmId [-Wait] [-Session ] [-ProgressAction ] - [-WhatIf] [-Confirm] [] +Stop-PveVm -Node -VmId [-Wait] [-Timeout ] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -137,6 +137,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Timeout +Timeout in seconds for -Wait (default 60). + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/docs/cmdlets/Suspend-PveContainer.md b/docs/cmdlets/Suspend-PveContainer.md index ebf39d4..cae9cb4 100644 --- a/docs/cmdlets/Suspend-PveContainer.md +++ b/docs/cmdlets/Suspend-PveContainer.md @@ -29,13 +29,28 @@ PS C:\> Suspend-PveContainer -Node pve1 -VmId 100 -Wait ## PARAMETERS +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Node The PVE node name. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -44,51 +59,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -VmId -The container identifier. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -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 {{ Fill Session Description }} @@ -104,13 +74,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. +### -Timeout +Timeout in seconds for -Wait (default 60). + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 60 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: Required: False Position: Named @@ -119,13 +119,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -152,7 +152,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.String diff --git a/docs/cmdlets/Suspend-PveVm.md b/docs/cmdlets/Suspend-PveVm.md index c9ec0ad..ca0a7c3 100644 --- a/docs/cmdlets/Suspend-PveVm.md +++ b/docs/cmdlets/Suspend-PveVm.md @@ -13,8 +13,8 @@ schema: 2.0.0 ## SYNTAX ``` -Suspend-PveVm -Node -VmId [-Wait] [-Session ] [-ProgressAction ] - [-WhatIf] [-Confirm] [] +Suspend-PveVm -Node -VmId [-Wait] [-Timeout ] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -137,6 +137,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Timeout +Timeout in seconds for -Wait (default 60). + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/docs/cmdlets/Write-PveVmGuestFile.md b/docs/cmdlets/Write-PveVmGuestFile.md index 6aa62ed..be343cd 100644 --- a/docs/cmdlets/Write-PveVmGuestFile.md +++ b/docs/cmdlets/Write-PveVmGuestFile.md @@ -13,8 +13,8 @@ Writes content to a file on the guest filesystem via the QEMU guest agent. ## SYNTAX ``` -Write-PveVmGuestFile [-Node] [-VmId] -File -Content - [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] +Write-PveVmGuestFile [-Node] [-VmId] -File -Content [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -29,45 +29,15 @@ PS C:\> Write-PveVmGuestFile -Node pve1 -VmId 100 -File /tmp/test.txt -Content ' ## PARAMETERS -### -Node -The PVE node name. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmId -The VM identifier. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -File -The file path inside the guest to write. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -80,7 +50,7 @@ The content to write to the file. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -89,6 +59,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -File +The file path inside the guest to write. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Session {{ Fill Session Description }} @@ -104,6 +104,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -119,21 +134,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ProgressAction {{ Fill ProgressAction Description }} @@ -152,7 +152,6 @@ Accept wildcard characters: False ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). - ## INPUTS ### System.Int32 diff --git a/generate-help.ps1 b/generate-help.ps1 index 2d1af83..7898881 100644 --- a/generate-help.ps1 +++ b/generate-help.ps1 @@ -1,20 +1,28 @@ #!/usr/bin/env pwsh <# .SYNOPSIS - Generates platyPS markdown help stubs and MAML XML help for PSProxmoxVE. + Generates platyPS markdown help and MAML XML help for PSProxmoxVE. .DESCRIPTION This script: 1. Builds the module to publish/netstandard2.0/ 2. Installs platyPS if needed - 3. Generates markdown help stubs in docs/cmdlets/ - 4. Generates MAML XML help in publish/netstandard2.0/ - 5. Copies the MAML XML to src/PSProxmoxVE/ for inclusion in builds + 3. Creates markdown stubs for NEW cmdlets only (preserves existing docs) + 4. Updates existing markdown docs (merges parameter changes, preserves descriptions/examples) + 5. Generates MAML XML help from the markdown + 6. Copies the MAML XML to src/PSProxmoxVE/ for inclusion in builds + +.PARAMETER Force + Regenerate all markdown from scratch, overwriting hand-written content. + Use with caution — this will replace all descriptions and examples. .NOTES Run from the repository root: pwsh -NoProfile -File ./generate-help.ps1 #> +param( + [switch]$Force +) $ErrorActionPreference = 'Stop' Set-StrictMode -Version Latest @@ -25,7 +33,10 @@ Push-Location $repoRoot try { # Step 1: Build the module Write-Host "Building module..." -ForegroundColor Cyan - dotnet publish src/PSProxmoxVE/PSProxmoxVE.csproj --configuration Release --framework netstandard2.0 --output ./publish/netstandard2.0 | Out-Null + dotnet publish src/PSProxmoxVE/PSProxmoxVE.csproj ` + --configuration Release ` + --framework netstandard2.0 ` + --output ./publish/netstandard2.0 | Out-Null Remove-Item ./publish/netstandard2.0/*.deps.json, ./publish/netstandard2.0/*.runtimeconfig.json -ErrorAction SilentlyContinue # Step 2: Install platyPS if needed @@ -45,14 +56,40 @@ try { New-Item -ItemType Directory -Path $docsDir -Force | Out-Null } - # Step 5: Generate markdown help stubs - Write-Host "Generating markdown help stubs..." -ForegroundColor Cyan - New-MarkdownHelp -Module PSProxmoxVE -OutputFolder $docsDir -Force | Out-Null + # Step 5: Generate or update markdown help + $existingDocs = Get-ChildItem "$docsDir/*.md" -ErrorAction SilentlyContinue + + if ($Force -or $existingDocs.Count -eq 0) { + # Full generation — creates all markdown from scratch + Write-Host "Generating all markdown help (full)..." -ForegroundColor Cyan + New-MarkdownHelp -Module PSProxmoxVE -OutputFolder $docsDir -Force | Out-Null + } + else { + # Update existing docs: merge parameter/syntax changes, preserve descriptions & examples + Write-Host "Updating existing markdown help (merge)..." -ForegroundColor Cyan + Update-MarkdownHelp -Path $docsDir -Force | Out-Null + + # Create stubs for any NEW cmdlets not yet documented + $documentedCmdlets = @($existingDocs | ForEach-Object { $_.BaseName }) + $moduleCmdlets = @((Get-Command -Module PSProxmoxVE -CommandType Cmdlet).Name) + $newCmdlets = @($moduleCmdlets | Where-Object { $_ -notin $documentedCmdlets }) + + if ($newCmdlets.Count -gt 0) { + Write-Host " Creating stubs for $($newCmdlets.Count) new cmdlet(s):" -ForegroundColor Yellow + foreach ($cmdlet in $newCmdlets) { + Write-Host " + $cmdlet" -ForegroundColor Yellow + New-MarkdownHelp -Command $cmdlet -OutputFolder $docsDir -Force | Out-Null + } + } + else { + Write-Host " No new cmdlets to document" -ForegroundColor Green + } + } $mdCount = (Get-ChildItem "$docsDir/*.md" | Measure-Object).Count - Write-Host " Generated $mdCount markdown files" -ForegroundColor Green + Write-Host " Markdown files: $mdCount" -ForegroundColor Green - # Step 6: Generate MAML XML help + # Step 6: Generate MAML XML help from markdown Write-Host "Generating MAML XML help..." -ForegroundColor Cyan New-ExternalHelp -Path $docsDir -OutputPath ./publish/netstandard2.0/ -Force | Out-Null diff --git a/src/PSProxmoxVE/PSProxmoxVE.dll-Help.xml b/src/PSProxmoxVE/PSProxmoxVE.dll-Help.xml index 2d5c9d6..97685d1 100644 --- a/src/PSProxmoxVE/PSProxmoxVE.dll-Help.xml +++ b/src/PSProxmoxVE/PSProxmoxVE.dll-Help.xml @@ -1236,6 +1236,243 @@ + + + Get-PveBackupInfo + Get + PveBackupInfo + + Lists guests not covered by any backup job. + + + + Returns information about VMs and containers that are not included in any scheduled backup job. Useful for backup compliance auditing. + + + + Get-PveBackupInfo + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Management.Automation.PSObject + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveBackupInfo + + Returns all guests not covered by any backup job. + + + + + + + + Get-PveBackupJob + Get + PveBackupJob + + Lists Proxmox VE backup jobs. + + + + Returns scheduled backup job configurations from the Proxmox VE cluster. Optionally filter by job ID. + + + + Get-PveBackupJob + + Id + + The backup job ID to retrieve. When omitted, all jobs are returned. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Id + + The backup job ID to retrieve. When omitted, all jobs are returned. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Backup.PveBackupJob + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveBackupJob + + Returns all backup jobs. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-PveBackupJob -Id "backup-abc123" + + Returns the backup job with the specified ID. + + + + + Get-PveCloudInitConfig @@ -1387,6 +1624,171 @@ + + + Get-PveClusterResource + Get + PveClusterResource + + Lists resources across the Proxmox VE cluster. + + + + Returns cluster-wide resources (VMs, containers, nodes, storage, SDN). Optionally filter by resource type or node name. + + + + Get-PveClusterResource + + Type + + Filter by resource type. + + + vm + lxc + node + storage + sdn + + String + + String + + + None + + + Node + + Filter results to a specific node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Node + + Filter results to a specific node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Type + + Filter by resource type. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Cluster.PveClusterResource + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveClusterResource + + Returns all cluster resources. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-PveClusterResource -Type vm + + Returns only VM resources across the cluster. + + + + + Get-PveContainer @@ -1769,6 +2171,157 @@ + + + Get-PveContainerInterface + Get + PveContainerInterface + + Gets network interface information for an LXC container. + + + + Retrieves network interface information for the specified LXC container via the Proxmox VE API, including interface names, MAC addresses, and IP addresses. + + + + Get-PveContainerInterface + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Containers.PveContainerInterface + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveContainerInterface -Node "pve1" -VmId 100 + + Returns network interface information for container 100 on node pve1. + + + + + Get-PveContainerSnapshot @@ -1944,6 +2497,1622 @@ + + + Get-PveDomain + Get + PveDomain + + Lists Proxmox VE authentication domains/realms. + + + + Returns all authentication domains (realms) from the Proxmox VE access management system. Optionally filter by a specific realm name. + + + + Get-PveDomain + + Realm + + Optional realm name to filter results. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Realm + + Optional realm name to filter results. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Users.PveDomain + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveDomain + + Returns all authentication domains. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-PveDomain -Realm "pam" + + Returns only the pam authentication domain. + + + + + + + + Get-PveFirewallAlias + Get + PveFirewallAlias + + Lists firewall aliases at the specified level. + + + + Returns firewall alias definitions at the Cluster, Node, Vm, or Container level. Optionally filter by alias name. + + + + Get-PveFirewallAlias + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Name + + Optional alias name to filter by. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + Name + + Optional alias name to filter by. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Firewall.PveFirewallAlias + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveFirewallAlias -Level Cluster + + Returns all cluster-level firewall aliases. + + + + + + + + Get-PveFirewallGroup + Get + PveFirewallGroup + + Lists firewall security groups or rules within a group. + + + + Returns firewall security groups. When a group name is specified, returns the rules within that group. + + + + Get-PveFirewallGroup + + Group + + The security group name. If specified, returns rules within the group. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Group + + The security group name. If specified, returns rules within the group. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Firewall.PveFirewallGroup + + + + + + + + PSProxmoxVE.Core.Models.Firewall.PveFirewallRule + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveFirewallGroup + + Returns all firewall security groups. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-PveFirewallGroup -Group "webservers" + + Returns the rules within the webservers security group. + + + + + + + + Get-PveFirewallIpSet + Get + PveFirewallIpSet + + Lists firewall IP sets at the specified level. + + + + Returns firewall IP set definitions at the Cluster, Node, Vm, or Container level. Optionally filter by IP set name. + + + + Get-PveFirewallIpSet + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Name + + Optional IP set name to filter by. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + Name + + Optional IP set name to filter by. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Firewall.PveFirewallIpSet + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveFirewallIpSet -Level Cluster + + Returns all cluster-level IP sets. + + + + + + + + Get-PveFirewallIpSetEntry + Get + PveFirewallIpSetEntry + + Lists entries in a firewall IP set. + + + + Returns all entries (CIDR addresses) within the specified firewall IP set at the given level. + + + + Get-PveFirewallIpSetEntry + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Name + + The IP set name. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + Name + + The IP set name. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Firewall.PveFirewallIpSetEntry + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveFirewallIpSetEntry -Level Cluster -Name "trusted" + + Returns all entries in the cluster-level IP set named trusted. + + + + + + + + Get-PveFirewallOptions + Get + PveFirewallOptions + + Gets firewall options at the specified level. + + + + Returns firewall configuration options at the Cluster, Node, Vm, or Container level. + + + + Get-PveFirewallOptions + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Firewall.PveFirewallOptions + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveFirewallOptions -Level Cluster + + Returns the cluster-level firewall options. + + + + + + + + Get-PveFirewallRef + Get + PveFirewallRef + + Lists firewall references at the specified level. + + + + Returns firewall references (aliases, IP sets, etc.) available at the Cluster, Node, Vm, or Container level. Optionally filter by type. + + + + Get-PveFirewallRef + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Type + + Optional type filter for references. + + String + + String + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Type + + Optional type filter for references. + + String + + String + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Firewall.PveFirewallRef + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveFirewallRef -Level Cluster + + Returns all cluster-level firewall references. + + + + + + + + Get-PveFirewallRule + Get + PveFirewallRule + + Lists firewall rules at the specified level. + + + + Returns firewall rules at the Cluster, Node, Vm, or Container level. Optionally filter by rule position. + + + + Get-PveFirewallRule + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Position + + Optional rule position to filter by. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Position + + Optional rule position to filter by. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Firewall.PveFirewallRule + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveFirewallRule -Level Cluster + + Returns all cluster-level firewall rules. + + + + + + + + Get-PveGroup + Get + PveGroup + + Lists Proxmox VE groups. + + + + Returns all groups from the Proxmox VE access management system. Optionally filter by a specific group ID. + + + + Get-PveGroup + + GroupId + + Optional group ID to filter results. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + GroupId + + Optional group ID to filter results. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Users.PveGroup + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveGroup + + Returns all groups. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-PveGroup -GroupId "admins" + + Returns the specified group. + + + + + Get-PveNetwork @@ -2259,6 +4428,260 @@ + + + Get-PveNodeConfig + Get + PveNodeConfig + + Returns the configuration of a Proxmox VE node. + + + + Retrieves the node configuration from the /nodes/{node}/config endpoint, including description, wakeonlan settings and other node-level properties. + + + + Get-PveNodeConfig + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Management.Automation.PSObject + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveNodeConfig -Node "pve1" + + Returns the configuration for node pve1. + + + + + + + + Get-PveNodeDns + Get + PveNodeDns + + Returns the DNS configuration of a Proxmox VE node. + + + + Retrieves the DNS settings (search domain and nameservers) for the specified node from the /nodes/{node}/dns endpoint. + + + + Get-PveNodeDns + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Management.Automation.PSObject + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveNodeDns -Node "pve1" + + Returns the DNS configuration for node pve1. + + + + + Get-PveNodeStatus @@ -2537,6 +4960,140 @@ + + + Get-PvePool + Get + PvePool + + Lists Proxmox VE resource pools. + + + + Returns resource pool configurations from the Proxmox VE cluster. Optionally filter by pool ID to retrieve a specific pool with its members. + + + + Get-PvePool + + PoolId + + The pool ID to retrieve. When omitted, all pools are returned. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + PoolId + + The pool ID to retrieve. When omitted, all pools are returned. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Cluster.PvePool + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PvePool + + Returns all resource pools. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-PvePool -PoolId "production" + + Returns the specified pool with its members. + + + + + Get-PveRole @@ -2664,6 +5221,387 @@ + + + Get-PveSdnController + Get + PveSdnController + + Lists SDN controllers in Proxmox VE. + + + + Returns Software-Defined Networking controller definitions. Optionally filters by controller identifier. Requires Proxmox VE 8.0 or later. + + + + Get-PveSdnController + + Controller + + Filter by controller identifier. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Controller + + Filter by controller identifier. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Network.PveSdnController + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveSdnController + + Returns all SDN controllers. + + + + + + + + Get-PveSdnDns + Get + PveSdnDns + + Lists SDN DNS plugins in Proxmox VE. + + + + Returns Software-Defined Networking DNS plugin definitions. Optionally filters by DNS identifier. Requires Proxmox VE 8.0 or later. + + + + Get-PveSdnDns + + Dns + + Filter by DNS plugin identifier. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Dns + + Filter by DNS plugin identifier. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Network.PveSdnDns + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveSdnDns + + Returns all SDN DNS plugins. + + + + + + + + Get-PveSdnIpam + Get + PveSdnIpam + + Lists SDN IPAM plugins in Proxmox VE. + + + + Returns Software-Defined Networking IPAM plugin definitions. Optionally filters by IPAM identifier. Requires Proxmox VE 8.0 or later. + + + + Get-PveSdnIpam + + Ipam + + Filter by IPAM plugin identifier. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Ipam + + Filter by IPAM plugin identifier. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Network.PveSdnIpam + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveSdnIpam + + Returns all SDN IPAM plugins. + + + + + Get-PveSdnSubnet @@ -3642,6 +6580,157 @@ + + + Get-PveStorageStatus + Get + PveStorageStatus + + Returns the status of a Proxmox VE storage on a node. + + + + Retrieves capacity, usage and activation status for the specified storage on the given node from the /nodes/{node}/storage/{storage}/status endpoint. + + + + Get-PveStorageStatus + + Node + + The PVE node name. + + String + + String + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Storage.PveStorageStatus + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveStorageStatus -Node "pve1" -Storage "local-lvm" + + Returns the status of the local-lvm storage on node pve1. + + + + + Get-PveTask @@ -3793,6 +6882,240 @@ + + + Get-PveTaskList + Get + PveTaskList + + Lists tasks on a Proxmox VE node. + + + + Returns a list of recent tasks on the specified node. Use optional parameters to filter by VM ID, source, or task type. Unlike Get-PveTask which retrieves a single task by UPID, this cmdlet lists multiple tasks. + + + + Get-PveTaskList + + Node + + The PVE node name. + + String + + String + + + None + + + Limit + + Maximum number of tasks to return. Defaults to 50. + + Int32 + + Int32 + + + 50 + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Source + + Filter by task source: all or active. + + + all + active + + String + + String + + + None + + + TypeFilter + + Filter by task type (e.g., qmstart, vzdump). + + String + + String + + + None + + + VmId + + Filter tasks by VM ID. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Limit + + Maximum number of tasks to return. Defaults to 50. + + Int32 + + Int32 + + + 50 + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Source + + Filter by task source: all or active. + + String + + String + + + None + + + TypeFilter + + Filter by task type (e.g., qmstart, vzdump). + + String + + String + + + None + + + VmId + + Filter tasks by VM ID. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveTaskList -Node "pve1" + + Returns the 50 most recent tasks on node pve1. + + + + -------------------------- Example 2 -------------------------- + PS C:\> Get-PveTaskList -Node "pve1" -VmId 100 -Limit 10 + + Returns the 10 most recent tasks for VM 100. + + + + + Get-PveTemplate @@ -4204,6 +7527,17 @@ None + + Detailed + + Include detailed status (QmpStatus) via per-VM API call. + + + SwitchParameter + + + False + @@ -4303,6 +7637,18 @@ None + + Detailed + + Include detailed status (QmpStatus) via per-VM API call. + + SwitchParameter + + SwitchParameter + + + False + @@ -4499,6 +7845,157 @@ + + + Get-PveVmGuestFsInfo + Get + PveVmGuestFsInfo + + Gets filesystem information from the QEMU guest agent. + + + + Queries the QEMU guest agent running inside the specified VM for its filesystem information, including mount points, filesystem types, and usage statistics. The guest agent must be installed and running inside the VM. + + + + Get-PveVmGuestFsInfo + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveGuestFsInfo + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveVmGuestFsInfo -Node "pve1" -VmId 100 + + Returns filesystem information for VM 100. + + + + + Get-PveVmGuestNetwork @@ -4650,6 +8147,850 @@ + + + Get-PveVmGuestOsInfo + Get + PveVmGuestOsInfo + + Gets OS information from the QEMU guest agent. + + + + Queries the QEMU guest agent running inside the specified VM for its operating system information, including OS name, kernel version, and machine type. The guest agent must be installed and running inside the VM. + + + + Get-PveVmGuestOsInfo + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveGuestOsInfo + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Get-PveVmGuestOsInfo -Node "pve1" -VmId 100 + + Returns OS information for VM 100. + + + + + + + + Import-PveOva + Import + PveOva + + Imports an OVA file into a Proxmox VE virtual machine. + + + + Imports an OVA (Open Virtual Appliance) archive into Proxmox VE by parsing the embedded OVF descriptor, uploading the OVA, creating a new VM, and importing each disk. Use -Name, -Memory, or -Cores to override values from the OVF. Use -Wait to block until all import tasks complete. + + + + Import-PveOva + + Node + + The PVE node name. + + String + + String + + + None + + + Storage + + The storage pool for OVA upload. + + String + + String + + + None + + + Path + + Local path to the OVA file. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Cores + + Override CPU core count. + + Int32 + + Int32 + + + None + + + Memory + + Override memory size in MiB. + + Int32 + + Int32 + + + None + + + Name + + Override the VM name from the OVF. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + TargetStorage + + Target storage for imported VM disks. + + String + + String + + + None + + + VmId + + The VM identifier. Auto-assigned if omitted. + + Int32 + + Int32 + + + None + + + Wait + + Wait for all tasks to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Cores + + Override CPU core count. + + Int32 + + Int32 + + + None + + + Memory + + Override memory size in MiB. + + Int32 + + Int32 + + + None + + + Name + + Override the VM name from the OVF. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Path + + Local path to the OVA file. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The storage pool for OVA upload. + + String + + String + + + None + + + TargetStorage + + Target storage for imported VM disks. + + String + + String + + + None + + + VmId + + The VM identifier. Auto-assigned if omitted. + + Int32 + + Int32 + + + None + + + Wait + + Wait for all tasks to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveVm + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Import-PveOva -Node "pve1" -Storage "local" -Path "C:\VMs\appliance.ova" -TargetStorage "local-lvm" -Wait + + Imports an OVA file into a new VM on node pve1. + + + + + + + + Import-PveVmDisk + Import + PveVmDisk + + Imports a disk image into a Proxmox VE virtual machine. + + + + Imports a disk image file into the specified VM by setting a disk configuration key with the PVE import-from syntax. The image can be a file already on PVE storage, a VMDK inside an uploaded OVA archive, or an absolute path on the PVE node. Use -Wait to block until complete. + + + + Import-PveVmDisk + + Disk + + Target disk slot (e.g. scsi0, sata0, virtio0). + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Format + + Target disk format (qcow2, raw, vmdk). + + + qcow2 + raw + vmdk + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Source + + Import source (e.g. local:iso/image.img or local:import/vm.ova/disk.vmdk). + + String + + String + + + None + + + TargetStorage + + Target storage for the imported disk. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the import task to complete. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Disk + + Target disk slot (e.g. scsi0, sata0, virtio0). + + String + + String + + + None + + + Format + + Target disk format (qcow2, raw, vmdk). + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Source + + Import source (e.g. local:iso/image.img or local:import/vm.ova/disk.vmdk). + + String + + String + + + None + + + TargetStorage + + Target storage for the imported disk. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the import task to complete. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Import-PveVmDisk -Node "pve1" -VmId 100 -Disk scsi0 -TargetStorage "local-lvm" -Source "local:iso/noble-server-cloudimg-amd64.img" -Wait + + Imports a cloud image into VM 100. + + + + + Invoke-PveCloudInitRegenerate @@ -5066,6 +9407,155 @@ + + + Invoke-PveSdnApply + Invoke + PveSdnApply + + Applies pending SDN configuration changes in Proxmox VE. + + + + Applies all pending Software-Defined Networking configuration changes cluster-wide. Run this after making changes with Set-PveSdnZone, Set-PveSdnVnet, etc. + + + + Invoke-PveSdnApply + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Invoke-PveSdnApply + + Applies all pending SDN configuration changes. + + + + + Invoke-PveStorageDownload @@ -5473,6 +9963,18 @@ None + + Timeout + + Timeout in seconds to wait for command completion. Defaults to 300. + + Int32 + + Int32 + + + None + @@ -5572,6 +10074,18 @@ None + + Timeout + + Timeout in seconds to wait for command completion. Defaults to 300. + + Int32 + + Int32 + + + None + @@ -5609,6 +10123,203 @@ + + + Invoke-PveVmGuestFsTrim + Invoke + PveVmGuestFsTrim + + Invokes an fstrim operation inside the guest via the QEMU guest agent. + + + + Triggers an fstrim (filesystem trim) operation inside the guest operating system using the QEMU guest agent. This reclaims unused space on thin-provisioned storage. The guest agent must be installed and running inside the VM. + + + + Invoke-PveVmGuestFsTrim + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Invoke-PveVmGuestFsTrim -Node "pve1" -VmId 100 + + Triggers fstrim on VM 100. + + + + + Move-PveContainer @@ -5884,6 +10595,305 @@ + + + Move-PveContainerVolume + Move + PveContainerVolume + + Moves a container volume to a different storage. + + + + Moves the specified volume on an LXC container to a different storage backend via the Proxmox VE API. Optionally deletes the original volume after a successful move. Use -Wait to block until the move task completes. + + + + Move-PveContainerVolume + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Delete + + Delete the original volume after move (default true). + + + SwitchParameter + + + True + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The target storage identifier. + + String + + String + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Volume + + The volume to move (e.g. rootfs, mp0). + + String + + String + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Delete + + Delete the original volume after move (default true). + + SwitchParameter + + SwitchParameter + + + True + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The target storage identifier. + + String + + String + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Volume + + The volume to move (e.g. rootfs, mp0). + + String + + String + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Move-PveContainerVolume -Node "pve1" -VmId 100 -Volume "rootfs" -Storage "local-lvm" -Wait + + Moves the rootfs volume of container 100 to local-lvm storage. + + + + + Move-PveVm @@ -6159,6 +11169,334 @@ + + + Move-PveVmDisk + Move + PveVmDisk + + Moves a VM disk to a different storage. + + + + Moves the specified disk on a QEMU/KVM virtual machine to a different storage backend via the Proxmox VE API. Optionally deletes the original disk after a successful move. Use -Wait to block until the move task completes. + + + + Move-PveVmDisk + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Delete + + Delete the original disk after move (default true). + + + SwitchParameter + + + True + + + Disk + + The disk slot to move (e.g. scsi0, virtio0). + + String + + String + + + None + + + Format + + Target disk format (raw, qcow2, vmdk). + + + raw + qcow2 + vmdk + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The target storage identifier. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Delete + + Delete the original disk after move (default true). + + SwitchParameter + + SwitchParameter + + + True + + + Disk + + The disk slot to move (e.g. scsi0, virtio0). + + String + + String + + + None + + + Format + + Target disk format (raw, qcow2, vmdk). + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The target storage identifier. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Move-PveVmDisk -Node "pve1" -VmId 100 -Disk "scsi0" -Storage "local-lvm" -Wait + + Moves the scsi0 disk of VM 100 to local-lvm storage. + + + + + New-PveApiToken @@ -6427,6 +11765,791 @@ + + + New-PveBackup + New + PveBackup + + Creates an ad-hoc backup of a virtual machine via vzdump. + + + + Triggers an immediate backup (vzdump) of the specified VM on the given node. Returns a PveTask representing the backup operation. Use -Wait to block until the backup completes. + + + + New-PveBackup + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Compress + + The compression algorithm. + + + zstd + lzo + gzip + none + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Mode + + The backup mode. + + + snapshot + suspend + stop + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The target storage for the backup. + + String + + String + + + None + + + Timeout + + Timeout in seconds for -Wait (default 3600). + + Int32 + + Int32 + + + 3600 + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Compress + + The compression algorithm. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Mode + + The backup mode. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The target storage for the backup. + + String + + String + + + None + + + Timeout + + Timeout in seconds for -Wait (default 3600). + + Int32 + + Int32 + + + 3600 + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-PveBackup -Node "pve1" -VmId 100 -Storage "backup-store" -Mode snapshot -Wait + + Creates a snapshot backup of VM 100 and waits for completion. + + + + + + + + New-PveBackupJob + New + PveBackupJob + + Creates a scheduled backup job on Proxmox VE. + + + + Creates a new scheduled backup job in the Proxmox VE cluster configuration. Specify a cron-style schedule and target storage. + + + + New-PveBackupJob + + All + + Back up all VMs. + + + SwitchParameter + + + False + + + Comment + + A comment or description for the backup job. + + String + + String + + + None + + + Compress + + The compression algorithm. + + + zstd + lzo + gzip + none + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Enabled + + Whether the backup job is enabled. Default is enabled. + + + SwitchParameter + + + False + + + MailNotification + + When to send email notifications. + + + always + failure + + String + + String + + + None + + + MailTo + + Email address(es) for notifications. + + String + + String + + + None + + + Mode + + The backup mode. + + + snapshot + suspend + stop + + String + + String + + + None + + + Node + + The node to restrict the backup job to. + + String + + String + + + None + + + PruneBackups + + Prune-backups configuration string. + + String + + String + + + None + + + Schedule + + Cron-style schedule expression (e.g., '0 2 *'). + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The target storage for backups. + + String + + String + + + None + + + VmId + + Comma-separated list of VM IDs to back up. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + All + + Back up all VMs. + + SwitchParameter + + SwitchParameter + + + False + + + Comment + + A comment or description for the backup job. + + String + + String + + + None + + + Compress + + The compression algorithm. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Enabled + + Whether the backup job is enabled. Default is enabled. + + SwitchParameter + + SwitchParameter + + + False + + + MailNotification + + When to send email notifications. + + String + + String + + + None + + + MailTo + + Email address(es) for notifications. + + String + + String + + + None + + + Mode + + The backup mode. + + String + + String + + + None + + + Node + + The node to restrict the backup job to. + + String + + String + + + None + + + PruneBackups + + Prune-backups configuration string. + + String + + String + + + None + + + Schedule + + Cron-style schedule expression (e.g., '0 2 *'). + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The target storage for backups. + + String + + String + + + None + + + VmId + + Comma-separated list of VM IDs to back up. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-PveBackupJob -Schedule '0 2 * * *' -Storage backup-store + + Creates a nightly backup job at 2 AM. + + + + + New-PveContainer @@ -7225,6 +13348,2276 @@ + + + New-PveContainerTemplate + New + PveContainerTemplate + + Converts an LXC container to a template. + + + + Converts the specified LXC container into a template via the Proxmox VE API. This operation is irreversible -- once converted, the container cannot be started and can only be used as a base for cloning. + + + + New-PveContainerTemplate + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-PveContainerTemplate -Node "pve1" -VmId 100 + + Converts container 100 to a template. + + + + + + + + New-PveDomain + New + PveDomain + + Creates a new Proxmox VE authentication domain/realm. + + + + Adds a new authentication domain (realm) to the Proxmox VE access management system. + + + + New-PveDomain + + Realm + + The realm identifier. + + String + + String + + + None + + + Type + + The domain type (pam, pve, ad, ldap, openid). + + + pam + pve + ad + ldap + openid + + String + + String + + + None + + + Comment + + Comment or description for the domain. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Default + + Set as the default authentication domain. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Comment + + Comment or description for the domain. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Default + + Set as the default authentication domain. + + SwitchParameter + + SwitchParameter + + + False + + + Realm + + The realm identifier. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Type + + The domain type (pam, pve, ad, ldap, openid). + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Users.PveDomain + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-PveDomain -Realm myldap -Type ldap + + Creates a new LDAP authentication domain. + + + + + + + + New-PveFirewallAlias + New + PveFirewallAlias + + Creates a new firewall alias. + + + + Creates a new firewall alias at the specified level (Cluster, Node, Vm, or Container). + + + + New-PveFirewallAlias + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Cidr + + The CIDR network address. + + String + + String + + + None + + + Comment + + Optional comment for the alias. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Name + + The alias name. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Cidr + + The CIDR network address. + + String + + String + + + None + + + Comment + + Optional comment for the alias. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + Name + + The alias name. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-PveFirewallAlias -Level Cluster -Name myserver -Cidr 10.0.0.1/32 + + Creates a cluster-level firewall alias. + + + + + + + + New-PveFirewallGroup + New + PveFirewallGroup + + Creates a new firewall security group. + + + + Creates a new firewall security group with an optional comment. + + + + New-PveFirewallGroup + + Group + + The security group name. + + String + + String + + + None + + + Comment + + Optional comment for the security group. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Comment + + Optional comment for the security group. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Group + + The security group name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-PveFirewallGroup -Group webservers + + Creates a security group named webservers. + + + + + + + + New-PveFirewallIpSet + New + PveFirewallIpSet + + Creates a new firewall IP set. + + + + Creates a new firewall IP set at the specified level (Cluster, Node, Vm, or Container). + + + + New-PveFirewallIpSet + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Comment + + Optional comment for the IP set. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Name + + The IP set name. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Comment + + Optional comment for the IP set. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + Name + + The IP set name. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-PveFirewallIpSet -Level Cluster -Name trusted + + Creates a cluster-level IP set named trusted. + + + + + + + + New-PveFirewallIpSetEntry + New + PveFirewallIpSetEntry + + Adds an entry to a firewall IP set. + + + + Adds a new CIDR address entry to an existing firewall IP set. + + + + New-PveFirewallIpSetEntry + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Cidr + + The CIDR network address to add. + + String + + String + + + None + + + Comment + + Optional comment for the entry. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Name + + The IP set name. + + String + + String + + + None + + + NoMatch + + Exclude this entry from the IP set match. + + + SwitchParameter + + + False + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Cidr + + The CIDR network address to add. + + String + + String + + + None + + + Comment + + Optional comment for the entry. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + Name + + The IP set name. + + String + + String + + + None + + + NoMatch + + Exclude this entry from the IP set match. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-PveFirewallIpSetEntry -Level Cluster -Name trusted -Cidr 10.0.0.0/24 + + + + + + + + + + New-PveFirewallRule + New + PveFirewallRule + + Creates a new firewall rule. + + + + Creates a new firewall rule at the specified level (Cluster, Node, Vm, or Container). + + + + New-PveFirewallRule + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Action + + The rule action: ACCEPT, DROP, or REJECT. + + + ACCEPT + DROP + REJECT + + String + + String + + + None + + + Comment + + Rule comment. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Dest + + Destination address or alias. + + String + + String + + + None + + + Dport + + Destination port. + + String + + String + + + None + + + Enable + + Enable the rule. + + + SwitchParameter + + + False + + + Iface + + Network interface. + + String + + String + + + None + + + Log + + Log level. + + String + + String + + + None + + + Macro + + Macro name. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Proto + + Protocol (e.g., tcp, udp, icmp). + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Source + + Source address or alias. + + String + + String + + + None + + + Sport + + Source port. + + String + + String + + + None + + + Type + + The rule type: in, out, or group. + + + in + out + group + + String + + String + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Action + + The rule action: ACCEPT, DROP, or REJECT. + + String + + String + + + None + + + Comment + + Rule comment. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Dest + + Destination address or alias. + + String + + String + + + None + + + Dport + + Destination port. + + String + + String + + + None + + + Enable + + Enable the rule. + + SwitchParameter + + SwitchParameter + + + False + + + Iface + + Network interface. + + String + + String + + + None + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + Log + + Log level. + + String + + String + + + None + + + Macro + + Macro name. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Proto + + Protocol (e.g., tcp, udp, icmp). + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Source + + Source address or alias. + + String + + String + + + None + + + Sport + + Source port. + + String + + String + + + None + + + Type + + The rule type: in, out, or group. + + String + + String + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Firewall.PveFirewallRule + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-PveFirewallRule -Level Cluster -Type in -Action ACCEPT -Proto tcp -Dport 443 -Enable + + + + + + + + + + New-PveGroup + New + PveGroup + + Creates a new Proxmox VE group. + + + + Adds a new group to the Proxmox VE access management system. + + + + New-PveGroup + + GroupId + + The group identifier. + + String + + String + + + None + + + Comment + + Comment or description for the group. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Comment + + Comment or description for the group. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + GroupId + + The group identifier. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Users.PveGroup + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-PveGroup -GroupId admins -Comment 'Admin group' + + + + + + + New-PveNetwork @@ -7672,6 +16065,203 @@ + + + New-PvePool + New + PvePool + + Creates a new resource pool in Proxmox VE. + + + + Creates a new resource pool in the Proxmox VE cluster with the specified ID and optional comment. + + + + New-PvePool + + PoolId + + The pool ID to create. + + String + + String + + + None + + + Comment + + An optional comment or description for the pool. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Comment + + An optional comment or description for the pool. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + PoolId + + The pool ID to create. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-PvePool -PoolId production -Comment 'Production VMs' + + + + + + + New-PveRole @@ -7869,6 +16459,849 @@ + + + New-PveSdnController + New + PveSdnController + + Creates a new SDN controller in Proxmox VE. + + + + Adds a new Software-Defined Networking controller. Requires Proxmox VE 8.0 or later. + + + + New-PveSdnController + + Controller + + The controller identifier. + + String + + String + + + None + + + Type + + The controller type. + + + evpn + bgp + + String + + String + + + None + + + Asn + + The Autonomous System Number for BGP/EVPN. + + Int32 + + Int32 + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Node + + The node this controller is configured on. + + String + + String + + + None + + + Peers + + Comma-separated list of BGP peer addresses. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Asn + + The Autonomous System Number for BGP/EVPN. + + Int32 + + Int32 + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Controller + + The controller identifier. + + String + + String + + + None + + + Node + + The node this controller is configured on. + + String + + String + + + None + + + Peers + + Comma-separated list of BGP peer addresses. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Type + + The controller type. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-PveSdnController -Controller bgp1 -Type bgp -Asn 65001 + + + + + + + + + + New-PveSdnDns + New + PveSdnDns + + Creates a new SDN DNS plugin in Proxmox VE. + + + + Adds a new Software-Defined Networking DNS plugin. Requires Proxmox VE 8.0 or later. + + + + New-PveSdnDns + + Dns + + The DNS plugin identifier. + + String + + String + + + None + + + Type + + The DNS plugin type. + + + powerdns + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Key + + The API key for the DNS service. + + String + + String + + + None + + + ReverseMaskV6 + + The IPv6 reverse zone mask length. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Ttl + + The TTL (time-to-live) for DNS records. + + Int32 + + Int32 + + + None + + + Url + + The URL of the DNS service API. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Dns + + The DNS plugin identifier. + + String + + String + + + None + + + Key + + The API key for the DNS service. + + String + + String + + + None + + + ReverseMaskV6 + + The IPv6 reverse zone mask length. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Ttl + + The TTL (time-to-live) for DNS records. + + Int32 + + Int32 + + + None + + + Type + + The DNS plugin type. + + String + + String + + + None + + + Url + + The URL of the DNS service API. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-PveSdnDns -Dns pdns1 -Type powerdns -Url https://dns.example.com -Key mykey + + + + + + + + + + New-PveSdnIpam + New + PveSdnIpam + + Creates a new SDN IPAM plugin in Proxmox VE. + + + + Adds a new Software-Defined Networking IPAM plugin. Requires Proxmox VE 8.0 or later. + + + + New-PveSdnIpam + + Ipam + + The IPAM plugin identifier. + + String + + String + + + None + + + Type + + The IPAM plugin type. + + + pve + netbox + phpipam + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Section + + The configuration section identifier. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Token + + The API token for the external IPAM service. + + String + + String + + + None + + + Url + + The URL of the external IPAM service. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Ipam + + The IPAM plugin identifier. + + String + + String + + + None + + + Section + + The configuration section identifier. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Token + + The API token for the external IPAM service. + + String + + String + + + None + + + Type + + The IPAM plugin type. + + String + + String + + + None + + + Url + + The URL of the external IPAM service. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-PveSdnIpam -Ipam pveipam -Type pve + + + + + + + New-PveSdnSubnet @@ -9590,6 +19023,280 @@ + + + New-PveStorageDisk + New + PveStorageDisk + + Allocates a new disk image on a Proxmox VE storage. + + + + Creates a new disk image with the specified filename, size and optional format on the given storage and node. + + + + New-PveStorageDisk + + Node + + The PVE node name. + + String + + String + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + Filename + + The filename for the new disk (e.g. vm-100-disk-1). + + String + + String + + + None + + + Size + + The size of the disk (e.g. 32G, 100M). + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Format + + The disk image format (raw, qcow2, vmdk). + + + raw + qcow2 + vmdk + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Filename + + The filename for the new disk (e.g. vm-100-disk-1). + + String + + String + + + None + + + Format + + The disk image format (raw, qcow2, vmdk). + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Size + + The size of the disk (e.g. 32G, 100M). + + String + + String + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.String + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> New-PveStorageDisk -Node pve1 -Storage local-lvm -Filename vm-100-disk-1 -Size 32G + + + + + + + New-PveTemplate @@ -11029,6 +20736,181 @@ + + + Read-PveVmGuestFile + Read + PveVmGuestFile + + Reads a file from the guest filesystem via the QEMU guest agent. + + + + Reads the contents of a file inside the guest operating system using the QEMU guest agent. The guest agent must be installed and running inside the VM. + + + + Read-PveVmGuestFile + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + File + + The file path inside the guest to read. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + File + + The file path inside the guest to read. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + System.String + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Read-PveVmGuestFile -Node pve1 -VmId 100 -File /etc/hostname + + + + + + + Remove-PveApiToken @@ -11226,6 +21108,179 @@ + + + Remove-PveBackupJob + Remove + PveBackupJob + + Removes a scheduled backup job from Proxmox VE. + + + + Deletes a backup job from the Proxmox VE cluster configuration. + + + + Remove-PveBackupJob + + Id + + The backup job ID. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Id + + The backup job ID. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-PveBackupJob -Id "example" + + + + + + + Remove-PveContainer @@ -11744,6 +21799,1553 @@ + + + Remove-PveDomain + Remove + PveDomain + + Removes a Proxmox VE authentication domain/realm. + + + + Deletes the specified authentication domain (realm). + + + + Remove-PveDomain + + Realm + + The realm identifier to remove. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Realm + + The realm identifier to remove. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-PveDomain -Realm "example" + + + + + + + + + + Remove-PveFirewallAlias + Remove + PveFirewallAlias + + Removes a firewall alias. + + + + Removes the specified firewall alias at the given level. + + + + Remove-PveFirewallAlias + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Name + + The alias name to remove. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + Name + + The alias name to remove. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-PveFirewallAlias -Level Cluster -Name myserver + + + + + + + + + + Remove-PveFirewallGroup + Remove + PveFirewallGroup + + Removes a firewall security group. + + + + Removes the specified firewall security group. + + + + Remove-PveFirewallGroup + + Group + + The security group name to remove. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Group + + The security group name to remove. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-PveFirewallGroup -Group webservers + + + + + + + + + + Remove-PveFirewallIpSet + Remove + PveFirewallIpSet + + Removes a firewall IP set. + + + + Removes the specified firewall IP set at the given level. + + + + Remove-PveFirewallIpSet + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Name + + The IP set name to remove. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + Name + + The IP set name to remove. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-PveFirewallIpSet -Level Cluster -Name trusted + + + + + + + + + + Remove-PveFirewallIpSetEntry + Remove + PveFirewallIpSetEntry + + Removes an entry from a firewall IP set. + + + + Removes the specified CIDR entry from a firewall IP set. + + + + Remove-PveFirewallIpSetEntry + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Cidr + + The CIDR network address to remove. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Name + + The IP set name. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Cidr + + The CIDR network address to remove. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + Name + + The IP set name. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-PveFirewallIpSetEntry -Level Cluster -Name trusted -Cidr 10.0.0.0/24 + + + + + + + + + + Remove-PveFirewallRule + Remove + PveFirewallRule + + Removes a firewall rule. + + + + Removes the firewall rule at the specified position and level. + + + + Remove-PveFirewallRule + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Position + + The rule position to remove. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Position + + The rule position to remove. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-PveFirewallRule -Level Cluster -Position 0 + + + + + + + + + + Remove-PveGroup + Remove + PveGroup + + Removes a Proxmox VE group. + + + + Deletes the specified group from the Proxmox VE access management system. + + + + Remove-PveGroup + + GroupId + + The group identifier to remove. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + GroupId + + The group identifier to remove. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-PveGroup -GroupId "example" + + + + + + + Remove-PveNetwork @@ -11941,6 +23543,179 @@ + + + Remove-PvePool + Remove + PvePool + + Removes a resource pool from Proxmox VE. + + + + Deletes a resource pool from the Proxmox VE cluster configuration. + + + + Remove-PvePool + + PoolId + + The pool ID to remove. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + PoolId + + The pool ID to remove. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-PvePool -PoolId "example" + + + + + + + Remove-PveRole @@ -12114,6 +23889,525 @@ + + + Remove-PveSdnController + Remove + PveSdnController + + Removes an SDN controller from Proxmox VE. + + + + Deletes the specified Software-Defined Networking controller. + + + + Remove-PveSdnController + + Controller + + The controller identifier to remove. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Controller + + The controller identifier to remove. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-PveSdnController -Controller "example" + + + + + + + + + + Remove-PveSdnDns + Remove + PveSdnDns + + Removes an SDN DNS plugin from Proxmox VE. + + + + Deletes the specified Software-Defined Networking DNS plugin. + + + + Remove-PveSdnDns + + Dns + + The DNS plugin identifier to remove. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Dns + + The DNS plugin identifier to remove. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-PveSdnDns -Dns "example" + + + + + + + + + + Remove-PveSdnIpam + Remove + PveSdnIpam + + Removes an SDN IPAM plugin from Proxmox VE. + + + + Deletes the specified Software-Defined Networking IPAM plugin. + + + + Remove-PveSdnIpam + + Ipam + + The IPAM plugin identifier to remove. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Ipam + + The IPAM plugin identifier to remove. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-PveSdnIpam -Ipam "example" + + + + + + + Remove-PveSdnSubnet @@ -13074,6 +25368,227 @@ + + + Remove-PveStorageContent + Remove + PveStorageContent + + Removes a content volume from a Proxmox VE storage. + + + + Deletes the specified volume from the storage on the given node. + + + + Remove-PveStorageContent + + Node + + The PVE node name. + + String + + String + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + Volume + + The volume identifier to remove. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + Volume + + The volume identifier to remove. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-PveStorageContent -Node pve1 -Storage local -Volume "local:iso/ubuntu.iso" + + + + + + + Remove-PveTemplate @@ -13764,6 +26279,258 @@ + + + Remove-PveVmDisk + Remove + PveVmDisk + + Removes (unlinks) disks from a QEMU/KVM virtual machine. + + + + Detaches and optionally destroys one or more disks from a virtual machine. + + + + Remove-PveVmDisk + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Force + + Force removal of disk images from storage. + + + SwitchParameter + + + False + + + IdList + + Comma-separated list of disk IDs to unlink (e.g. scsi0,scsi1). + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Force + + Force removal of disk images from storage. + + SwitchParameter + + SwitchParameter + + + False + + + IdList + + Comma-separated list of disk IDs to unlink (e.g. scsi0,scsi1). + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Remove-PveVmDisk -Node pve1 -VmId 100 -IdList scsi0 -Force + + + + + + + Reset-PveVm @@ -13860,6 +26627,18 @@ None + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + None + @@ -13947,6 +26726,18 @@ None + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + None + @@ -13992,6 +26783,259 @@ + + + Resize-PveContainerDisk + Resize + PveContainerDisk + + Resizes a disk attached to an LXC container. + + + + Resizes the specified disk/volume on an LXC container. Use an absolute size (e.g., '50G') or a relative size prefixed with '+' (e.g., '+5G'). + + + + Resize-PveContainerDisk + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Disk + + The disk/volume to resize (e.g. rootfs, mp0). + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Size + + New disk size (e.g. 50G or +5G to grow). + + String + + String + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Disk + + The disk/volume to resize (e.g. rootfs, mp0). + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Size + + New disk size (e.g. 50G or +5G to grow). + + String + + String + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Resize-PveContainerDisk -Node pve1 -VmId 100 -Disk rootfs -Size +5G + + + + + + + Resize-PveVmDisk @@ -15260,6 +28304,258 @@ + + + Resume-PveContainer + Resume + PveContainer + + Resumes a suspended LXC container on a Proxmox VE node. + + + + Sends a resume command to the specified LXC container. Use -Wait to block until the resume task completes. + + + + Resume-PveContainer + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + 60 + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + 60 + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Resume-PveContainer -Node pve1 -VmId 100 -Wait + + + + + + + Resume-PveVm @@ -15356,6 +28652,18 @@ None + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + None + @@ -15443,6 +28751,18 @@ None + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + None + @@ -15490,19 +28810,19 @@ - Send-PveIso + Send-PveFile Send - PveIso + PveFile - {{ Fill in the Synopsis }} + Uploads a local file to a Proxmox VE storage. - {{ Fill in the Description }} + Uploads a file from the local filesystem to the specified node/storage using the Proxmox VE upload API. Supports ISO images, container templates, and disk images for import. - Send-PveIso + Send-PveFile Node @@ -15530,7 +28850,7 @@ Path - Local path to the ISO file to upload. + Local path to the file to upload. String @@ -15539,6 +28859,23 @@ None + + ContentType + + Content type: iso, vztmpl, or import. + + + iso + vztmpl + import + + String + + String + + + iso + Checksum @@ -15665,6 +29002,18 @@ False + + ContentType + + Content type: iso, vztmpl, or import. + + String + + String + + + iso + Node @@ -15680,7 +29029,7 @@ Path - Local path to the ISO file to upload. + Local path to the file to upload. String @@ -15778,9 +29127,751 @@ -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} + PS C:\> Send-PveFile -Node pve1 -Storage local -Path ./ubuntu.iso -ContentType iso -Wait - {{ Add example description here }} + + + + + + + + + Set-PveApiToken + Set + PveApiToken + + Updates a Proxmox VE API token configuration. + + + + Modifies properties of an existing API token such as its comment, expiration, or privilege separation setting. + + + + Set-PveApiToken + + UserId + + The user ID (e.g. 'user@realm'). + + String + + String + + + None + + + TokenId + + The token identifier. + + String + + String + + + None + + + Comment + + Comment describing the token. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Expire + + Expiration as Unix epoch (0 = no expiration). + + Int64 + + Int64 + + + None + + + PrivilegeSeparation + + Whether the token uses privilege separation. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Comment + + Comment describing the token. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Expire + + Expiration as Unix epoch (0 = no expiration). + + Int64 + + Int64 + + + None + + + PrivilegeSeparation + + Whether the token uses privilege separation. + + SwitchParameter + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + TokenId + + The token identifier. + + String + + String + + + None + + + UserId + + The user ID (e.g. 'user@realm'). + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveApiToken -UserId root@pam -TokenId mytoken -Comment 'Updated' + + + + + + + + + + Set-PveBackupJob + Set + PveBackupJob + + Updates a scheduled backup job on Proxmox VE. + + + + Modifies properties of an existing backup job. Only specified parameters are updated. + + + + Set-PveBackupJob + + Id + + The backup job ID. + + String + + String + + + None + + + All + + Back up all VMs. + + + SwitchParameter + + + False + + + Comment + + A comment or description for the backup job. + + String + + String + + + None + + + Compress + + The compression algorithm. + + + zstd + lzo + gzip + none + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Enabled + + Enable or disable the backup job. + + + SwitchParameter + + + False + + + MailNotification + + When to send email notifications. + + + always + failure + + String + + String + + + None + + + MailTo + + Email address(es) for notifications. + + String + + String + + + None + + + Mode + + The backup mode. + + + snapshot + suspend + stop + + String + + String + + + None + + + Node + + The node to restrict the backup job to. + + String + + String + + + None + + + PruneBackups + + Prune-backups configuration string. + + String + + String + + + None + + + Schedule + + Cron-style schedule expression. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The target storage for backups. + + String + + String + + + None + + + VmId + + Comma-separated list of VM IDs to back up. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + All + + Back up all VMs. + + SwitchParameter + + SwitchParameter + + + False + + + Comment + + A comment or description for the backup job. + + String + + String + + + None + + + Compress + + The compression algorithm. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Enabled + + Enable or disable the backup job. + + SwitchParameter + + SwitchParameter + + + False + + + Id + + The backup job ID. + + String + + String + + + None + + + MailNotification + + When to send email notifications. + + String + + String + + + None + + + MailTo + + Email address(es) for notifications. + + String + + String + + + None + + + Mode + + The backup mode. + + String + + String + + + None + + + Node + + The node to restrict the backup job to. + + String + + String + + + None + + + PruneBackups + + Prune-backups configuration string. + + String + + String + + + None + + + Schedule + + Cron-style schedule expression. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The target storage for backups. + + String + + String + + + None + + + VmId + + Comma-separated list of VM IDs to back up. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveBackupJob -Id backup-abc -Schedule '0 3 * * *' + + @@ -16619,6 +30710,2040 @@ + + + Set-PveDomain + Set + PveDomain + + Updates a Proxmox VE authentication domain/realm. + + + + Modifies properties of an existing authentication domain (realm). + + + + Set-PveDomain + + Realm + + The realm identifier. + + String + + String + + + None + + + Comment + + Updated comment or description for the domain. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Default + + Set as the default authentication domain. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Comment + + Updated comment or description for the domain. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Default + + Set as the default authentication domain. + + SwitchParameter + + SwitchParameter + + + False + + + Realm + + The realm identifier. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveDomain -Realm myldap -Comment 'Updated' + + + + + + + + + + Set-PveFirewallAlias + Set + PveFirewallAlias + + Updates a firewall alias. + + + + Modifies the CIDR or comment of an existing firewall alias. + + + + Set-PveFirewallAlias + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Cidr + + The updated CIDR network address. + + String + + String + + + None + + + Comment + + Updated comment for the alias. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Name + + The alias name to update. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Cidr + + The updated CIDR network address. + + String + + String + + + None + + + Comment + + Updated comment for the alias. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + Name + + The alias name to update. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveFirewallAlias -Level Cluster -Name myserver -Cidr 10.0.0.2/32 + + + + + + + + + + Set-PveFirewallIpSetEntry + Set + PveFirewallIpSetEntry + + Updates an entry in a firewall IP set. + + + + Modifies properties of an existing entry in a firewall IP set. + + + + Set-PveFirewallIpSetEntry + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Cidr + + The CIDR network address to update. + + String + + String + + + None + + + Comment + + Updated comment for the entry. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Name + + The IP set name. + + String + + String + + + None + + + NoMatch + + Exclude this entry from the IP set match. + + + SwitchParameter + + + False + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Cidr + + The CIDR network address to update. + + String + + String + + + None + + + Comment + + Updated comment for the entry. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + Name + + The IP set name. + + String + + String + + + None + + + NoMatch + + Exclude this entry from the IP set match. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveFirewallIpSetEntry -Level Cluster -Name trusted -Cidr 10.0.0.0/24 -Comment 'Updated' + + + + + + + + + + Set-PveFirewallOptions + Set + PveFirewallOptions + + Updates firewall options at the specified level. + + + + Modifies firewall configuration options at the Cluster, Node, Vm, or Container level. + + + + Set-PveFirewallOptions + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Dhcp + + Enable DHCP. + + + SwitchParameter + + + False + + + Enable + + Enable or disable the firewall. + + + SwitchParameter + + + False + + + IpFilter + + Enable IP filter. + + + SwitchParameter + + + False + + + LogLevelIn + + Log level for incoming traffic. + + String + + String + + + None + + + LogLevelOut + + Log level for outgoing traffic. + + String + + String + + + None + + + MacFilter + + Enable MAC address filter. + + + SwitchParameter + + + False + + + Ndp + + Enable NDP. + + + SwitchParameter + + + False + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + PolicyIn + + Default policy for incoming traffic. + + + ACCEPT + DROP + REJECT + + String + + String + + + None + + + PolicyOut + + Default policy for outgoing traffic. + + + ACCEPT + DROP + REJECT + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Dhcp + + Enable DHCP. + + SwitchParameter + + SwitchParameter + + + False + + + Enable + + Enable or disable the firewall. + + SwitchParameter + + SwitchParameter + + + False + + + IpFilter + + Enable IP filter. + + SwitchParameter + + SwitchParameter + + + False + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + LogLevelIn + + Log level for incoming traffic. + + String + + String + + + None + + + LogLevelOut + + Log level for outgoing traffic. + + String + + String + + + None + + + MacFilter + + Enable MAC address filter. + + SwitchParameter + + SwitchParameter + + + False + + + Ndp + + Enable NDP. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + PolicyIn + + Default policy for incoming traffic. + + String + + String + + + None + + + PolicyOut + + Default policy for outgoing traffic. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveFirewallOptions -Level Cluster -Enable -PolicyIn DROP + + + + + + + + + + Set-PveFirewallRule + Set + PveFirewallRule + + Updates a firewall rule. + + + + Modifies properties of an existing firewall rule at the specified position and level. + + + + Set-PveFirewallRule + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + + Cluster + Node + Vm + Container + + String + + String + + + None + + + Action + + The rule action: ACCEPT, DROP, or REJECT. + + + ACCEPT + DROP + REJECT + + String + + String + + + None + + + Comment + + Rule comment. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Dest + + Destination address or alias. + + String + + String + + + None + + + Dport + + Destination port. + + String + + String + + + None + + + Enable + + Enable the rule. + + + SwitchParameter + + + False + + + Iface + + Network interface. + + String + + String + + + None + + + Log + + Log level. + + String + + String + + + None + + + Macro + + Macro name. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Position + + The rule position to update. + + Int32 + + Int32 + + + None + + + Proto + + Protocol (e.g., tcp, udp, icmp). + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Source + + Source address or alias. + + String + + String + + + None + + + Sport + + Source port. + + String + + String + + + None + + + Type + + The rule type: in, out, or group. + + + in + out + group + + String + + String + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Action + + The rule action: ACCEPT, DROP, or REJECT. + + String + + String + + + None + + + Comment + + Rule comment. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Dest + + Destination address or alias. + + String + + String + + + None + + + Dport + + Destination port. + + String + + String + + + None + + + Enable + + Enable the rule. + + SwitchParameter + + SwitchParameter + + + False + + + Iface + + Network interface. + + String + + String + + + None + + + Level + + The firewall level: Cluster, Node, Vm, or Container. + + String + + String + + + None + + + Log + + Log level. + + String + + String + + + None + + + Macro + + Macro name. + + String + + String + + + None + + + Node + + The node name. Required when Level is Node, Vm, or Container. + + String + + String + + + None + + + Position + + The rule position to update. + + Int32 + + Int32 + + + None + + + Proto + + Protocol (e.g., tcp, udp, icmp). + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Source + + Source address or alias. + + String + + String + + + None + + + Sport + + Source port. + + String + + String + + + None + + + Type + + The rule type: in, out, or group. + + String + + String + + + None + + + VmId + + The VM/Container ID. Required when Level is Vm or Container. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveFirewallRule -Level Cluster -Position 0 -Enable + + + + + + + + + + Set-PveGroup + Set + PveGroup + + Updates a Proxmox VE group. + + + + Modifies properties of an existing group. + + + + Set-PveGroup + + GroupId + + The group identifier. + + String + + String + + + None + + + Comment + + Updated comment or description. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Comment + + Updated comment or description. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + GroupId + + The group identifier. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveGroup -GroupId admins -Comment 'Updated' + + + + + + + Set-PveNetwork @@ -16835,6 +32960,18 @@ None + + Type + + Interface type (bridge, bond, eth, vlan, OVSBridge). + + String + + String + + + None + @@ -17042,6 +33179,18 @@ None + + Type + + Interface type (bridge, bond, eth, vlan, OVSBridge). + + String + + String + + + None + @@ -17079,6 +33228,693 @@ + + + Set-PveNodeConfig + Set + PveNodeConfig + + Updates the configuration of a Proxmox VE node. + + + + Modifies node-level configuration properties such as description and wake-on-LAN settings. + + + + Set-PveNodeConfig + + Node + + The PVE node name. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Description + + Node description or comment. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Wakeonlan + + Wake-on-LAN configuration. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Description + + Node description or comment. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Wakeonlan + + Wake-on-LAN configuration. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveNodeConfig -Node pve1 -Description 'Primary node' + + + + + + + + + + Set-PveNodeDns + Set + PveNodeDns + + Updates the DNS configuration of a Proxmox VE node. + + + + Modifies the DNS settings (search domain and nameservers) for the specified node. + + + + Set-PveNodeDns + + Node + + The PVE node name. + + String + + String + + + None + + + Search + + The DNS search domain. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Dns1 + + Primary DNS server address. + + String + + String + + + None + + + Dns2 + + Secondary DNS server address. + + String + + String + + + None + + + Dns3 + + Tertiary DNS server address. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Dns1 + + Primary DNS server address. + + String + + String + + + None + + + Dns2 + + Secondary DNS server address. + + String + + String + + + None + + + Dns3 + + Tertiary DNS server address. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Search + + The DNS search domain. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveNodeDns -Node pve1 -Search example.com -Dns1 8.8.8.8 + + + + + + + + + + Set-PvePassword + Set + PvePassword + + Changes a Proxmox VE user's password. + + + + Updates the password for the specified user. The password is accepted as a SecureString. + + + + Set-PvePassword + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + Password + + The new password for the user. + + SecureString + + SecureString + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Password + + The new password for the user. + + SecureString + + SecureString + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PvePassword -UserId admin@pve -Password (Read-Host -AsSecureString) + + + + + + + Set-PvePermission @@ -17374,6 +34210,2548 @@ + + + Set-PvePool + Set + PvePool + + Updates a resource pool in Proxmox VE. + + + + Modifies an existing resource pool configuration. You can update the comment, add members, or remove members. + + + + Set-PvePool + + PoolId + + The pool ID to update. + + String + + String + + + None + + + Comment + + An optional comment or description. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Delete + + Comma-separated list of members to remove. + + String + + String + + + None + + + Members + + Comma-separated list of members to add. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Comment + + An optional comment or description. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Delete + + Comma-separated list of members to remove. + + String + + String + + + None + + + Members + + Comma-separated list of members to add. + + String + + String + + + None + + + PoolId + + The pool ID to update. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PvePool -PoolId production -Comment 'Updated' + + + + + + + + + + Set-PveRole + Set + PveRole + + Updates a Proxmox VE role's privileges. + + + + Modifies the privilege set for an existing custom role. + + + + Set-PveRole + + RoleId + + The role identifier. + + String + + String + + + None + + + Privileges + + Comma-separated list of privileges. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Privileges + + Comma-separated list of privileges. + + String + + String + + + None + + + RoleId + + The role identifier. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveRole -RoleId MyRole -Privileges 'VM.Audit,VM.Console' + + + + + + + + + + Set-PveSdnController + Set + PveSdnController + + Updates an SDN controller configuration in Proxmox VE. + + + + Modifies the specified SDN controller configuration. Changes are pending until Invoke-PveSdnApply is called. + + + + Set-PveSdnController + + Controller + + The SDN controller identifier. + + String + + String + + + None + + + Asn + + The Autonomous System Number for BGP/EVPN. + + Int32 + + Int32 + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Node + + The node this controller is configured on. + + String + + String + + + None + + + Peers + + Comma-separated list of BGP peer addresses. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Asn + + The Autonomous System Number for BGP/EVPN. + + Int32 + + Int32 + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Controller + + The SDN controller identifier. + + String + + String + + + None + + + Node + + The node this controller is configured on. + + String + + String + + + None + + + Peers + + Comma-separated list of BGP peer addresses. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveSdnController -Controller bgp1 -Asn 65002 + + + + + + + + + + Set-PveSdnDns + Set + PveSdnDns + + Updates an SDN DNS plugin configuration in Proxmox VE. + + + + Modifies the specified SDN DNS plugin configuration. Changes are pending until Invoke-PveSdnApply is called. + + + + Set-PveSdnDns + + Dns + + The SDN DNS plugin identifier. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Key + + The TSIG key for DNS updates. + + String + + String + + + None + + + ReverseMaskV6 + + The IPv6 reverse DNS mask length. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Ttl + + The TTL for DNS records. + + Int32 + + Int32 + + + None + + + Url + + The DNS server URL. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Dns + + The SDN DNS plugin identifier. + + String + + String + + + None + + + Key + + The TSIG key for DNS updates. + + String + + String + + + None + + + ReverseMaskV6 + + The IPv6 reverse DNS mask length. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Ttl + + The TTL for DNS records. + + Int32 + + Int32 + + + None + + + Url + + The DNS server URL. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveSdnDns -Dns pdns1 -Url https://dns2.example.com + + + + + + + + + + Set-PveSdnIpam + Set + PveSdnIpam + + Updates an SDN IPAM plugin configuration in Proxmox VE. + + + + Modifies the specified SDN IPAM plugin configuration. Changes are pending until Invoke-PveSdnApply is called. + + + + Set-PveSdnIpam + + Ipam + + The SDN IPAM plugin identifier. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Section + + The section ID in the IPAM server. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Token + + The API token for the IPAM server. + + String + + String + + + None + + + Url + + The IPAM server URL. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Ipam + + The SDN IPAM plugin identifier. + + String + + String + + + None + + + Section + + The section ID in the IPAM server. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Token + + The API token for the IPAM server. + + String + + String + + + None + + + Url + + The IPAM server URL. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveSdnIpam -Ipam myipam -Url https://ipam.example.com + + + + + + + + + + Set-PveSdnSubnet + Set + PveSdnSubnet + + Updates an SDN subnet configuration in Proxmox VE. + + + + Modifies the specified SDN subnet configuration on a VNet. Changes are pending until Invoke-PveSdnApply is called. + + + + Set-PveSdnSubnet + + Vnet + + The SDN VNet name. + + String + + String + + + None + + + Subnet + + The subnet CIDR. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + DhcpRange + + DHCP range for this subnet. + + String + + String + + + None + + + DnsZonePrefix + + DNS zone prefix for automatic registration. + + String + + String + + + None + + + Gateway + + Gateway address for this subnet. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Snat + + Enable SNAT for this subnet. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + DhcpRange + + DHCP range for this subnet. + + String + + String + + + None + + + DnsZonePrefix + + DNS zone prefix for automatic registration. + + String + + String + + + None + + + Gateway + + Gateway address for this subnet. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Snat + + Enable SNAT for this subnet. + + SwitchParameter + + SwitchParameter + + + False + + + Subnet + + The subnet CIDR. + + String + + String + + + None + + + Vnet + + The SDN VNet name. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveSdnSubnet -Vnet myvnet -Subnet 10.0.0.0/24 -Gateway 10.0.0.1 + + + + + + + + + + Set-PveSdnVnet + Set + PveSdnVnet + + Updates an SDN VNet configuration in Proxmox VE. + + + + Modifies the specified SDN VNet configuration. Changes are pending until Invoke-PveSdnApply is called. + + + + Set-PveSdnVnet + + Vnet + + The SDN VNet name. + + String + + String + + + None + + + Alias + + An alias for the VNet. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Tag + + VLAN tag for this VNet. + + Int32 + + Int32 + + + None + + + VlanAware + + Enable VLAN-aware bridging. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Zone + + The zone this VNet belongs to. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Alias + + An alias for the VNet. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Tag + + VLAN tag for this VNet. + + Int32 + + Int32 + + + None + + + VlanAware + + Enable VLAN-aware bridging. + + SwitchParameter + + SwitchParameter + + + False + + + Vnet + + The SDN VNet name. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Zone + + The zone this VNet belongs to. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveSdnVnet -Vnet myvnet -Zone myzone + + + + + + + + + + Set-PveSdnZone + Set + PveSdnZone + + Updates an SDN zone configuration in Proxmox VE. + + + + Modifies the specified SDN zone configuration. Changes are pending until Invoke-PveSdnApply is called. + + + + Set-PveSdnZone + + Zone + + The SDN zone name. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Dns + + DNS server for automatic registration. + + String + + String + + + None + + + DnsZone + + DNS zone name for registration. + + String + + String + + + None + + + Reversedns + + Reverse DNS server. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Dns + + DNS server for automatic registration. + + String + + String + + + None + + + DnsZone + + DNS zone name for registration. + + String + + String + + + None + + + Reversedns + + Reverse DNS server. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Zone + + The SDN zone name. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveSdnZone -Zone myzone -Dns pdns1 + + + + + + + + + + Set-PveStorage + Set + PveStorage + + Updates a Proxmox VE storage definition. + + + + Modifies the configuration of an existing storage definition. + + + + Set-PveStorage + + Storage + + The storage identifier. + + String + + String + + + None + + + AdditionalConfig + + Additional configuration parameters as a hashtable. + + Hashtable + + Hashtable + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Content + + Comma-separated content types. + + String + + String + + + None + + + Enabled + + Whether the storage is enabled. + + + SwitchParameter + + + False + + + Nodes + + Comma-separated list of nodes. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Shared + + Whether the storage is shared. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + AdditionalConfig + + Additional configuration parameters as a hashtable. + + Hashtable + + Hashtable + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Content + + Comma-separated content types. + + String + + String + + + None + + + Enabled + + Whether the storage is enabled. + + SwitchParameter + + SwitchParameter + + + False + + + Nodes + + Comma-separated list of nodes. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Shared + + Whether the storage is shared. + + SwitchParameter + + SwitchParameter + + + False + + + Storage + + The storage identifier. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveStorage -Storage local -Content 'images,iso,backup' + + + + + + + + + + Set-PveStorageContent + Set + PveStorageContent + + Updates properties of a content volume in Proxmox VE storage. + + + + Modifies metadata (such as notes/description) of an existing volume. + + + + Set-PveStorageContent + + Node + + The PVE node name. + + String + + String + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + Volume + + The volume identifier to update. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Notes + + Notes or description for the volume. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Notes + + Notes or description for the volume. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + Volume + + The volume identifier to update. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveStorageContent -Node pve1 -Storage local -Volume 'local:iso/ubuntu.iso' -Notes 'Ubuntu 24.04' + + + + + + + Set-PveUser @@ -18208,6 +37586,274 @@ + + + Set-PveVmGuestPassword + Set + PveVmGuestPassword + + Sets a user password inside the guest via the QEMU guest agent. + + + + Changes a user's password inside the guest operating system using the QEMU guest agent. + + + + Set-PveVmGuestPassword + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Crypted + + Indicates the password is already crypted/hashed. + + + SwitchParameter + + + False + + + Password + + The new password. + + SecureString + + SecureString + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Username + + The username whose password to set. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Crypted + + Indicates the password is already crypted/hashed. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Password + + The new password. + + SecureString + + SecureString + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Username + + The username whose password to set. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Set-PveVmGuestPassword -Node pve1 -VmId 100 -Username root -Password (Read-Host -AsSecureString) + + + + + + + Start-PveContainer @@ -18304,6 +37950,18 @@ None + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + None + @@ -18391,6 +38049,18 @@ None + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + None + @@ -18436,6 +38106,203 @@ + + + Start-PveNodeVms + Start + PveNodeVms + + Starts all VMs and containers on a Proxmox VE node. + + + + Triggers the start-all operation on the specified node. + + + + Start-PveNodeVms + + Node + + The PVE node name. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmIds + + Comma-separated list of VM IDs to start. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmIds + + Comma-separated list of VM IDs to start. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Start-PveNodeVms -Node pve1 + + + + + + + Start-PveVm @@ -18532,6 +38399,18 @@ None + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + None + @@ -18619,6 +38498,18 @@ None + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + None + @@ -18760,6 +38651,18 @@ None + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + None + @@ -18847,6 +38750,18 @@ None + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + None + @@ -18892,6 +38807,423 @@ + + + Stop-PveNodeVms + Stop + PveNodeVms + + Stops all VMs and containers on a Proxmox VE node. + + + + Triggers the stop-all operation on the specified node. + + + + Stop-PveNodeVms + + Node + + The PVE node name. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ForceStop + + Force stop VMs without waiting for graceful shutdown. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmIds + + Comma-separated list of VM IDs to stop. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ForceStop + + Force stop VMs without waiting for graceful shutdown. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmIds + + Comma-separated list of VM IDs to stop. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Stop-PveNodeVms -Node pve1 + + + + + + + + + + Stop-PveTask + Stop + PveTask + + Stops a running task on a Proxmox VE node. + + + + Cancels a running task identified by its UPID. + + + + Stop-PveTask + + Node + + The PVE node name. + + String + + String + + + None + + + Upid + + The task UPID. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Upid + + The task UPID. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Stop-PveTask -Node pve1 -Upid 'UPID:pve1:...' + + + + + + + Stop-PveVm @@ -18988,6 +39320,18 @@ None + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + None + @@ -19075,6 +39419,18 @@ None + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + None + @@ -19120,6 +39476,258 @@ + + + Suspend-PveContainer + Suspend + PveContainer + + Suspends an LXC container on a Proxmox VE node. + + + + Sends a suspend command to the specified LXC container. Use -Wait to block until the suspend task completes. + + + + Suspend-PveContainer + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + 60 + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + 60 + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Suspend-PveContainer -Node pve1 -VmId 100 -Wait + + + + + + + Suspend-PveVm @@ -19216,6 +39824,18 @@ None + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + None + @@ -19303,6 +39923,18 @@ None + + Timeout + + Timeout in seconds for -Wait (default 60). + + Int32 + + Int32 + + + None + @@ -19808,4 +40440,249 @@ + + + Write-PveVmGuestFile + Write + PveVmGuestFile + + Writes content to a file on the guest filesystem via the QEMU guest agent. + + + + Writes the specified content to a file inside the guest operating system using the QEMU guest agent. + + + + Write-PveVmGuestFile + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Content + + The content to write to the file. + + String + + String + + + None + + + File + + The file path inside the guest to write. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Content + + The content to write to the file. + + String + + String + + + None + + + File + + The file path inside the guest to write. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + System.Void + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> Write-PveVmGuestFile -Node pve1 -VmId 100 -File /tmp/test.txt -Content 'Hello World' + + + + + + + \ No newline at end of file