mirror of
https://github.com/GoodOlClint/PSProxmoxVE.git
synced 2026-08-21 02:06:36 +00:00
docs: update cmdlet help via platyPS merge, fix generate-help.ps1
- generate-help.ps1: rewritten to use Update-MarkdownHelp (merge) by default, preserving hand-written descriptions and examples. Only New-MarkdownHelp on genuinely new cmdlets. -Force flag for full regen. - docs/cmdlets: parameter metadata updated via platyPS merge, CRLF normalized to LF - Removed stale Send-PveIso.md (cmdlet renamed to Send-PveFile) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -13,9 +13,8 @@ Removes an entry from a firewall IP set.
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Remove-PveFirewallIpSetEntry [-Level] <String> [-Node <String>] [-VmId <Int32>] -Name <String>
|
||||
-Cidr <String> [-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
|
||||
[<CommonParameters>]
|
||||
Remove-PveFirewallIpSetEntry [-Level] <String> [-Node <String>] [-VmId <Int32>] -Name <String> -Cidr <String>
|
||||
[-Session <PveSession>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
@@ -30,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
|
||||
|
||||
Reference in New Issue
Block a user