Get-OPNSenseDHCPServer

SYNOPSIS

Gets DHCP server settings from an OPNSense firewall.

SYNTAX

Get-OPNSenseDHCPServer [[-Interface] <String>]

DESCRIPTION

The Get-OPNSenseDHCPServer cmdlet retrieves DHCP server settings from an OPNSense firewall. You can retrieve settings for all interfaces or a specific interface.

EXAMPLES

Example 1: Get DHCP server settings for all interfaces

Get-OPNSenseDHCPServer

This example retrieves DHCP server settings for all interfaces from the OPNSense firewall.

Example 2: Get DHCP server settings for a specific interface

Get-OPNSenseDHCPServer -Interface "lan"

This example retrieves DHCP server settings for the LAN interface from the OPNSense firewall.

PARAMETERS

-Interface

The interface for which to retrieve DHCP server settings.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
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

None

OUTPUTS

System.Object

Returns objects representing the DHCP server settings.

NOTES

This cmdlet requires a connection to an OPNSense firewall. Use Connect-OPNSense to establish a connection.

Set-OPNSenseDHCPServer Get-OPNSenseDHCPLease Remove-OPNSenseDHCPLease Get-OPNSenseDHCPStaticMapping New-OPNSenseDHCPStaticMapping Set-OPNSenseDHCPStaticMapping Remove-OPNSenseDHCPStaticMapping

2.0 KiB Raw Blame History