Set-DhcpServerv4Policy

Set-DhcpServerv4Policy is accessible with the help of DHCPServer module. To configure DHCPServer, go through this link.

Synopsis

Sets the properties of an existing policy either at the server level or at the specified scope level.

Description

The Set-DhcpServerv4Policy cmdlet sets the properties of an existing policy either at the server level or at the specified scope level. If the CircuitId, ClientId, Fqdn, MACAddress, RelayAgent, RemoteId, SubscriberId, UserClass, or VendorClass parameter is specified, then the conditions of the policy are being changed and this cmdlet will behave as follows:
If the VendorClass parameter is specified and the policy being modified already has conditions for the VendorClass parameter value, then the existing VendorClass parameter value is removed and the new VendorClass parameter value will be added.

However, if the policy being modified has conditions for the MacAddress parameter value, then the MacAddress parameter value is not altered and is logically combined (ORꞌd) or differenced (ANDꞌd) with the VendorClass-based conditions.
The same applies to any of the CircuitId, ClientId, Fqdn, MACAddress, RelayAgent, RemoteId, SubscriberId, UserClass, or VendorClass parameters used in the conditions.

Parameters

-AsJob

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.

-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.

-CircuitId

Specifies the comparator to use and the values with which to compare the circuit identifier (ID) sub-option. The first element is the comparator, EQ or NE, followed by a single value. If the last character in a value is an asterisk, the subsequent characters are treated as wildcard characters for the comparison. If the first character in a value-element is an asterisk, the preceding characters are treated as wildcard characters for comparison.

The value can 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.

-ClientId

Specifies the comparator to use and the values with which to compare the client identifier. The first element is the comparator, EQ or NE, followed by a set of values. If the last character in a value is an asterisk, the subsequent characters are treated as wildcard characters for the comparison. If the first character in a value-element is an asterisk, the preceding characters are treated as wildcard characters for comparison.

The values can 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. The output format is a hexadecimal string with hyphen separation.

The values following the EQ operator is treated as multiple assertions which are logically combined (ORꞌd).

The values following the NE operator is treated as multiple assertions which are logically differenced (ANDꞌd).

-ComputerName

Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service.

-Condition

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

-Confirm

Prompts you for confirmation before running the cmdlet.

-Description

Specifies the description to set on the policy.

-Enabled

Specifies the enabled state for the policy.

-Fqdn

Specifies the comparator to use and the values with which to compare the fully qualified domain name (FQDN) in the client request. The first element is the comparator, EQ, NE, Isl, or Insl and the subsequent elements are values. For the comparators Island Insl, use a blank value. If the last character in a value is an asterisk, the subsequent characters are treated as wildcard characters for the comparison. If the first character in a value-element is an asterisk, the preceding characters are treated as wildcard characters for 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 string. A trailing wildcard character can be present to indicate partial match.

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).

-LeaseDuration

Specifies the duration of the lease for clients that match the policy.

-MacAddress

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, followed by a set of values. If the last character in a value is an asterisk, the subsequent characters are treated as wildcard characters for the comparison. If the first character in a value-element is an asterisk, the preceding characters are treated as wildcard characters for comparison.

The values can 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 used to indicate partial match. The output format is a hexadecimal string with hyphen separation.

The values following the EQ operator is treated as multiple assertions which are logically combined (ORꞌd).

The values following the NE operator is treated as multiple assertions which are logically differenced (ANDꞌd).

-Name

Specifies the name of the policy being modified.

-NewName

Specifies the new name to set for the policy.

-PassThru

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

-ProcessingOrder

Specifies the order for this policy with regard to other policies in the scope or DHCP server service. The DHCP server service processes the policies in the specified order while evaluating client requests using the configured policies.

-RelayAgent

Specifies the comparator to use and the values with which to compare the relay agent information. The first element is the comparator, EQ or NE, followed by a set of values. If the last character in a value is an asterisk, the subsequent characters are treated as wildcard characters for the comparison. If the first character in a value-element is an asterisk, the preceding characters are treated as wildcard characters for comparison.

The values can 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.

-RemoteId

Specifies the comparator to use and the values with which to compare the remote ID suboption. The first element is the comparator, EQ or NE, followed by a single value. If the last character in a value is an asterisk, the subsequent characters are treated as wildcard characters for the comparison. If the first character in a value-element is an asterisk, the preceding characters are treated as wildcard characters for comparison.

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.

-ScopeId

Specifies the scope ID, in IPv4 address format, of the scope which contains the policy. If this parameter is not specified, the server level policy is modified.

-SubscriberId

Specifies the comparator to use and the values with which to compare the subscriber ID suboption. The first element is the comparator, EQ or NE, and followed by a single value. If the last character in a value is an asterisk, the subsequent characters are treated as wildcard characters for the comparison. If the first character in a value-element is an asterisk, the preceding characters are treated as wildcard characters for comparison.

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.

-ThrottleLimit

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.

-UserClass

Specifies the comparator to use and the user class values with which to compare the user class field in the client request. The first element to be specified is the comparator, EQ or NE, and followed by a set values. If the last character in a value is an asterisk, the subsequent characters are treated as wildcard characters for the comparison. If the first character in a value-element is an asterisk, the preceding characters are treated as wildcard characters for comparison.

The values can be followed by another comparator, EQ or NE, which is followed by another set of values.

The values to be specified must be the user class names that already exist on the DHCP server service.

The format of the value should be a hexadecimal string starting with 0x.

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).

-VendorClass

Specifies the comparator to use and the vendor class values with which to compare the vendor class field in the client request. The first element is the comparator, EQ or NE, followed by a set of values. If the last character in a value is an asterisk, the subsequent characters are treated as wildcard characters for the comparison. If the first character in a value-element is an asterisk, the preceding characters are treated as wildcard characters for comparison.

The values can be followed by another comparator. EQ or NE, which is followed by another set of values.

The values to be specified must be the vendor class names that already exist on the DHCP server service.

The format of the value should be a hexadecimal string starting with 0x.

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).

-WhatIf

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

Syntax

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

—————EXAMPLE 1—————
PS C:>Set-DhcpServerv4Policy -ComputerName dhcpsrv.TOSSolution.com -Name DevicesPolicy -NewName TabletPolicy -Description “policy for tablet devices” -ProcessingOrder 4 -Enabled False
This example renames the server level policy named DevicesPolicy to TabletPolicy, sets a description string, disables the policy, and sets the processing order to 4.

—————EXAMPLE 2—————
PS C:\>Set-DhcpServerv4Policy -Name PhysicalMachinesPolicy -Condition OR -MacAddress NE,00115D*,000769*
This example modifies the conditions of the server level policy for non-Hyper-V clients. If the policy had an existing MAC address based condition, then the same condition is replaced with the condition specified in this cmdlet. However, if the policy had conditions based on other fields, such as the VendorClass, UserClass, ClientId, or RelayAgent parameters, then those will be retained and logically combined (ORꞌd) with the newly added MAC address based condition.

—————EXAMPLE 3—————
PS C:\>Set-DhcpServerv4Policy -Name TabletPolicy -ComputerName dhcpsrv.TOSSolution.com -LeaseDuration 20
This example sets the lease duration for the server level policy named TabletPolicy to 20 days for the specified computer.

You can check the Version, CommandType and Source of this cmdlet by giving below command.

Get-Command Set-DhcpServerv4Policy

You can also read about

To know more PowerShell cmdlets(Commands) on DHCPServer click here

Click on this Link for an Single place where you get all the PowerShell cmdlet sorted based on the modules.

You can also refer other blogs on PowerShell at link

You can also refer other blogs on Microsoft at link

And also if you required any technology you want to learn, let us know below we will publish them in our site http://tossolution.com/

Like our page in Facebook and follow us for New technical information.

References are taken from Microsoft