PSOPNSenseAPI/docs/cmdlets/Restart-OPNSenseInterface.md

Restart-OPNSenseInterface

SYNOPSIS

Restarts a network interface on an OPNSense firewall.

SYNTAX

Restart-OPNSenseInterface -Name <String> [-WhatIf] [-Confirm]

DESCRIPTION

The Restart-OPNSenseInterface cmdlet restarts a network interface on an OPNSense firewall.

EXAMPLES

Example 1: Restart an interface

Restart-OPNSenseInterface -Name "lan"

This example restarts the LAN interface.

PARAMETERS

-Name

The name of the interface to restart.

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 name of an interface 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. Restarting an interface may temporarily disrupt network connectivity.

RELATED LINKS

Get-OPNSenseInterface Set-OPNSenseInterface Get-OPNSenseInterfaceStatistics