Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-DhcpServerv4Filter

Add-DhcpServerv4Filter

ps_dhcpserverv4filter_v1.0.0.cdxml

Synopsis

Adds a MAC address filter to the Dynamic Host Configuration Protocol (DHCP) server service.

Syntax

Add-DhcpServerv4Filter [-List] [-MacAddress] [-AsJob] [-CimSession] [-ComputerName] [-Description] [-Force] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Add-DhcpServerv4Filter cmdlet adds the specified MAC address filter to the Dynamic Host Configuration Protocol (DHCP) server service. The MAC address can be added to the allow list or the deny list.

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CimSession <CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ComputerName <String>

Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service.

Aliases

Cn

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Description <String>

Specifies the description string for the MAC address filter being added.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Force <SwitchParameter>

Specifies that, if one or more of the MAC addresses are already present in the allow or deny list, then the matching MAC addresses are deleted and the new entries created.

This parameter is useful in the case where the MAC address specified is already present in one list, such as the allow list, and the same MAC address now needs to be added to the other list, such as the deny list.

If this parameter is not specified, then the cmdlet will fail if the specified MAC address is already present in any of the lists.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-List <String>

Specifies the list to which one or more MAC addresses are to be added. The acceptable values for this parameter are:  Allow or Deny.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-MacAddress <String[]>

Specifies one or more MAC addresses which are to be added to the MAC address filter list.

Aliases

ClientId

Required?

true

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ThrottleLimit <Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Filter

Return Type

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Filter[]

Notes

None

Examples

EXAMPLE 1

This example adds the specified client identified by the MAC address to the allowed list of MAC address filters.

PS C:\> Add-DhcpServerv4Filter -List Allow -MacAddress F0-DE-F1-7A-00-5E -Description "Ivan's Laptop"

Example 2

This example adds the specified clients identified by their MAC address to the allowed list of MAC address filters.

PS C:\>Add-DhcpServerv4Filter -List Allow -MacAddress F0-DE-F1-7A-00-5E, F0-DE-F1-7A-00-5C

Example 3

This example adds all of the MAC address filters in the file named MacAddressFilters.csv to the allow MAC address list of the DHCP server service running on the computer named dhcpserver.contoso.com. The Import-Csv cmdlet returns the objects with Mac address filter fields that are piped to this cmdlet, which in turn adds the MAC address filters to the server. The file named MacAddressFilters.csv should be in the following comma-separated values (CSV) format: MacAddress,Description 1a-1b-1c-1d-1e-1f,Computer1 2a-2b-2c-2d-2e-2f,Computer2 3a-3b-3c-3d-3e-3f,Computer3

PS C:\>Import-Csv –Path MacAddressFilters.csv | Add-DhcpServerv4Filter -ComputerName dhcpserver.contoso.com -List Allow

Online Version
Import-Csv
Get-DhcpServerv4Filter
Get-DhcpServerv4FilterList
Get-DhcpServerV4Lease
Remove-DhcpServerv4Filter
Set-DhcpServerv4FilterList