gsadmin/PSProxmoxVE
1
0
Fork 0
mirror of https://github.com/GoodOlClint/PSProxmoxVE.git synced 2026-08-21 02:06:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

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

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Clint Branham
2026-03-23 17:41:04 -05:00
parent d5f4e13637
commit f6a2f843db
90 changed files with 24596 additions and 3615 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/cmdlets/Set-PveFirewallIpSetEntry.md
+61 -63
View File
@@ -13,9 +13,9 @@ Updates an entry in a firewall IP set.
## SYNTAX
```
Set-PveFirewallIpSetEntry [-Level] <String> [-Node <String>] [-VmId <Int32>] -Name <String>
-Cidr <String> [-NoMatch] [-Comment <String>] [-Session <PveSession>]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-PveFirewallIpSetEntry [-Level] <String> [-Node <String>] [-VmId <Int32>] -Name <String> -Cidr <String>
[-NoMatch] [-Comment <String>] [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -30,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