PSOPNSenseAPI/docs/cmdlets/Remove-OPNSensePortForwardingRule.md

Remove-OPNSensePortForwardingRule

SYNOPSIS

Removes a port forwarding rule from an OPNSense firewall.

SYNTAX

Remove-OPNSensePortForwardingRule -UUID <String> [-WhatIf] [-Confirm]

DESCRIPTION

The Remove-OPNSensePortForwardingRule cmdlet removes a port forwarding rule from an OPNSense firewall.

EXAMPLES

Example 1: Remove a port forwarding rule

Remove-OPNSensePortForwardingRule -UUID "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

This example removes the port forwarding rule with the specified UUID.

Example 2: Remove a port forwarding rule with confirmation

Remove-OPNSensePortForwardingRule -UUID "a1b2c3d4-e5f6-7890-abcd-ef1234567890" -Confirm

This example prompts for confirmation before removing the port forwarding rule.

PARAMETERS

-UUID

The UUID of the port forwarding rule to remove.

Type: String
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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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.

INPUTS

System.String

You can pipe a string containing the UUID of a port forwarding rule to this cmdlet.

OUTPUTS

System.Object

Returns an object representing the result of the operation.

NOTES

This cmdlet requires a connection to an OPNSense firewall. Use Connect-OPNSense to establish a connection. After removing a port forwarding rule, you may need to apply the changes for them to take effect. You may also want to remove any corresponding firewall rules that are no longer needed.

RELATED LINKS

Get-OPNSensePortForwardingRule New-OPNSensePortForwardingRule Set-OPNSensePortForwardingRule