Add-DhcpServerv4Policy

Add-DhcpServerv4Policy

Adds a new policy either at the server level or at the scope level.

Syntax

Parameter Set: Add0
Add-DhcpServerv4Policy [-Name] <String> [-Condition] <String> [-AsJob] [-CimSession <CimSession[]> ] [-CircuitId <String[]> ] [-ClientId <String[]> ] [-ComputerName <String> ] [-Description <String> ] [-Enabled <Boolean> ] [-MacAddress <String[]> ] [-PassThru] [-ProcessingOrder <UInt16> ] [-RelayAgent <String[]> ] [-RemoteId <String[]> ] [-ScopeId <IPAddress> ] [-SubscriberId <String[]> ] [-ThrottleLimit <Int32> ] [-UserClass <String[]> ] [-VendorClass <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Add-DhcpServerv4Policy cmdlet adds a new policy either at the server level or at the scope level. The policy name must be unique at the level, either server or specific scope, where the policy is added and should have at least one condition as specified by the VendorClass, UserClass, MACAddress, ClientId, RelayAgent, CircuitId, RemoteId, or SubscriberId parameter.

Parameters

-AsJob

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	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-CircuitId<String[]>

Specifies the comparator to use and the values with which to compare the circuit id sub-option. The first element is the comparator, either EQ or NE, followed by a single value. No wildcard characters are allowed.
The value can again be followed by another comparator, either EQ or NE, which is followed by another value for comparison.
The input format for the value is a hexadecimal string with or without hyphen separation.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-ClientId<String[]>

Specifies the comparator to use and the values with which to compare client identifier. The first element is the comparator, either EQ or NE, and subsequent elements are values. A trailing wildcard character can be present to indicate partial match.
The values can again be followed by another comparator, either EQ or NE, which is followed by another set of values for comparison.
The input format is a hexadecimal string with or without hyphen separation. For example: EQ, 00-11-22-33-44-55, AA-BB-CC-DD-EE*.
The output format is a hexadecimal string with hyphen separation.
The values following the EQ operator will be treated as multiple assertions which are logically combined (OR’d).
The values following the NE operator will be treated as multiple assertions which are logically differenced (AND’d).

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
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	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Condition<String>

Specifies the logical operator between conditions when multiple conditions are specified. The acceptable values for this parameter are: AND or OR.

Aliases	none
Required?	true
Position?	2
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-Description<String>

Specifies the description string of the policy being added.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-Enabled<Boolean>

Specifies the enabled state of a policy. The acceptable values for this parameter are: True or False.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-MacAddress<String[]>

Specifies the comparator to use and the values with which to compare the MAC Address in the client request. The first element is the comparator, EQ or NE, and the subsequent elements are values. If the last character in a value is an asterisk (*), then the subsequent characters are treated as wildcard characters for the comparison.
The values can again be followed by another comparator, EQ or NE, which is followed by another set of values.
The input format is a hexadecimal string with or without hyphen separation. A trailing wildcard character can be present to indicate partial match. For example: 00-1F-3B-7C-B7-89, 00-1F-3B-7C-B7-*, 001F3B7CB789.
The output format is a hexadecimal string with hyphen separation.
The values following the EQ operator will be treated as multiple assertions which are logically combined (OR’d).
The values following the NE operator will be treated as multiple assertions which are logically differenced (AND’d).

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-Name<String>

Specifies the name of the policy to be added.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-PassThru

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

-ProcessingOrder<UInt16>

Specifies the order of this policy with respect to other policies in the scope or server. The DHCP server service will process the policies in the specified order while evaluating client requests.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-RelayAgent<String[]>

Specifies the comparator to use and values with which to compare the relay agent information. The first element is the comparator, EQ or NE, and subsequent elements are values. No wildcard characters are allowed.
The values can again be followed by another comparator, EQ or NE, which is followed by another set of values.
The input format is a hexadecimal string with or without hyphen separation.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-RemoteId<String[]>

Specifies the comparator to use and values with which to compare the remote ID sub-option. The first element is the comparator, EQ or NE, followed by a single value. No wildcard characters are allowed.
The value can again be followed by another comparator, EQ or NE, which is followed by another value.
The input format for the value is a hexadecimal string with or without hyphen separation.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-ScopeId<IPAddress>

Specifies the scope identifier, in IPv4 address format, in which the policy is being added.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-SubscriberId<String[]>

Specifies the comparator to use and the values with which to compare the subscriber ID sub-option. The first element is the comparator, EQ or NE, and followed by a single value. No wildcard characters are allowed.
The value can again be followed by another comparator, EQ or NE, which is followed by another value.
The input format is a hexadecimal string with or without hyphen separation.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
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

-UserClass<String[]>

Specifies the comparator to use and the user class values to compare with the user class field in the client request. The first element to be specified is the comparator, EQ or NE, and the subsequent elements are values. A trailing wildcard character can be present to indicate partial match.
The values can again be followed by another comparator, EQ or NE, which is followed by another set of values.
The values to be specified are the user class names which already exist on the server.
The values following the EQ operator are treated as multiple assertions which are logically combined (OR’d).
The values following the NE operator are treated as multiple assertions which are logically differenced (AND’d).

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-VendorClass<String[]>

Specifies the comparator to use and vendor class values to compare with the vendor class field in the client request. The first element is the comparator, EQ or NE, and the subsequent elements are values. If the last character in a value is an asterisk (*), then the subsequent characters are treated as wildcard characters for the comparison.
The values can again be followed by another comparator, EQ or NE, which is followed by another set of values.
The values to be specified are the vendor class names which already exist on the server.
The values following the EQ operator are treated as multiple assertions which are logically combined (OR’d).
The values following the NE operator are treated as multiple assertions which are logically differenced (AND’d).

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

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

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

• Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Outputs

The output type is the type of the objects that the cmdlet emits.

• Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Examples

EXAMPLE 1

This example creates a server level policy for virtual machine (VM) clients. The MAC addresses of Hyper-V VMs (00-15-5D) and VMWare VMs (00-05-69) are used as a condition in the policy.

PS C:\> Add-DhcpServerv4Policy -Name HyperVPolicy -Condition OR -MacAddress EQ,00155D*,000569*

EXAMPLE 2

This example creates a server level policy for non-Hyper-V clients. The MAC address of Hyper-V VMs (00-15-5D) and VMware VMs (000569) is used as a negation condition in the policy.

PS C:\> Add-DhcpServerv4Policy -Name PhysicalComputersPolicy -Condition OR -MacAddress NE,00155D*,000569*

EXAMPLE 3

This example creates a scope level policy for virtual machine (VM) clients inside the scope 10.10.10.0. The MAC addresses of Hyper-V VMs (00-15-5D) and VMware VMs (00-05-69) are used as a condition in the policy.

PS C:\> Add-DhcpServerv4Policy -Name VMPolicy -ScopeId 10.10.10.0 -Condition OR -MacAddress EQ,00155D*,000569*

EXAMPLE 4

This example creates a printer policy inside the scope 10.10.10.0 based on the vendor class of printers. The vendor classes need to be defined before being used in the policy.

PS C:\> Add-DhcpServerv4Policy -Name PrinterPolicy -ScopeId 10.10.10.0 -Condition OR -VendorClass EQ,"HP Printer","Xerox Printer"

EXAMPLE 5

This example creates a lab computers policy inside the scope 10.10.10.0 based on the user class. The user class needs to be defined before being used in the policy.

PS C:\> Add-DhcpServerv4Policy -Name LabComputerPolicy -ScopeId 10.10.10.0 -Condition OR -UserClass EQ,LabComputers

EXAMPLE 6

This example creates a policy based on the relay agent information (option 82) inside the scope 10.10.10.0. The DHCP relay agent needs to be configured with the relay agent information option (option 82).

PS C:\> Add-DhcpServerv4Policy -Name RelayAgentBasedPolicy -ScopeId 10.10.10.0 -Condition OR -RelayAgent EQ,01030a0b0c02050000000123

EXAMPLE 7

This example creates a policy by combining conditions, using OR, based on MAC address prefix of HTC phone devices and vendor class of Android, inside the scope 10.10.10.0. The vendor class needs to be defined before being used in the policy.

PS C:\> Add-DhcpServerv4Policy -Name DevicesPolicy -ScopeId 10.10.10.0 -Condition OR -MacAddress EQ,F8DB7F* -VendorClass EQ,Android

EXAMPLE 8

This example creates a server level policy for virtual machine (VM) clients and assigns a processing order and creates the policy in a disabled state. The MAC addresses of Hyper-V VMs (00-15-5D) and VMWare VMs (00-05-69) are used as a condition in the policy.

PS C:\> Add-DhcpServerv4Policy -Name HyperVPolicy -Condition OR -MacAddress EQ,00155D*,000569* -ProcessingOrder 2 -Enabled False

Related topics

Add-DhcpServerv4PolicyIPRange

Get-DhcpServerv4Policy

Get-DhcpServerv4PolicyIPRange

Remove-DhcpServerv4Policy

Remove-DhcpServerv4PolicyIPRange

Set-DhcpServerv4Policy