Add method of the PS_DhcpServerv4Policy class

Adds a new policy either at the Server level or at the Scope level.

Syntax


uint32 Add(
  [in]   string ComputerName,
  [in]   string Name,
  [in]   string Condition,
  [in]   string Description,
  [in]   string ScopeId,
  [in]   uint16 ProcessingOrder,
  [in]   string RelayAgent[],
  [in]   string RemoteId[],
  [in]   string SubscriberId[],
  [in]   boolean PassThru,
  [in]   datetime LeaseDuration,
  [in]   string Fqdn[],
  [in]   boolean Enabled,
  [in]   string VendorClass[],
  [in]   string UserClass[],
  [in]   string MacAddress[],
  [in]   string CircuitId[],
  [in]   string ClientId[],
  [out]  string cmdletOutput
);

Parameters

ComputerName [in]

DNS name or IP address of the target computer running the DHCP server service.

Name [in]

Name of the policy to be added.

Condition [in]

The logical operator between conditions in case multiple conditions are specified. Valid values are AND and OR.

And (AND)
Or (OR)
Description [in]

Description string of the policy being added.

ScopeId [in]

Scope identifier (in IPv4 address format) in which the policy is being added.

ProcessingOrder [in]

The order of this policy with respect to other policies in the scope or server. The server will process the policies in the specified order while evaluating client requests vis-a-vis the configured policies.

RelayAgent [in]

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

RemoteId [in]

The comparator to use and values to compare remote id suboption with. The first element is the comparator (EQ, NE) followed by a single value. No wildcard characters are allowed. Value can again be followed by another comparator (EQ, NE) which is followed by another value. Input format for the value is a hex string with or without hyphen separation.

SubscriberId [in]

The comparator to use and values to compare subscriber id suboption with. The first element is the comparator (EQ, NE), and followed by a single value. No wildcard characters are allowed. Value can again be followed by another comparator (EQ, NE) which is followed by another value. Input format is a hex string with or without hyphen separation.

PassThru [in]

If this parameter is specified, the cmdlet returns the PowerShell object which is modified.

LeaseDuration [in]

Lease duration to be set for clients matching the policy.

Windows Server 2012:  This parameter is supported beginning with Windows Server 2012 R2.

Fqdn [in]

"The comparator to use, and values to compare Fqdn with.

Specify the comparator in the first element and values in the subsequent elements are values. There are four possible values for the comparator; EQ, NE, Isl, and Insl

For comparators Isl and Insl only a blank value is acceptable.

If comparators EQ or NE are used: If the last character in a value-element is an asterisk (*), the subsequent characters are treated as wild-cards for the comparison. If the first character in a value-element is an asterisk (*), the preceding characters are treated as wild cards for comparison.

Value elements can be followed by another comparator, either EQ or NE, which is followed by another set of values. The values following the EQ operator will be treated as multiple assertions which are ORed. The values following the NE operator will be treated as multiple assertions which are ANDed.

Windows Server 2012:  This parameter is supported beginning with Windows Server 2012 R2.

Enabled [in]

Enable/Disable policy. Valid values are True, False.

VendorClass [in]

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, NE), and subsequent elements are values. If the last character in a value is an asterisk (*), the subsequent characters are treated as wild-cards for the comparison. Values can again be followed by another comparator (EQ, NE) which is followed by another set of values. Values to be specified are the vendor class names which are already existing on the server. The format of the value should be a hex string prepended with 0x. The values following the EQ operator are treated as multiple assertions which are joined with a bitwise OR combination. The values following the NE operator are treated as multiple assertions which are joined with a bitwise AND combination.

UserClass [in]

The comparator to use and user class values to compare with the user class field in the client request. The first element to be specified is the comparator (EQ, NE) and the subsequent elements are values. If the last character in the value is an asterisk (*), the subsequent characters are treated as wild-cards for the comparison. Values can again be followed by another comparator (EQ, NE) which is followed by another set of values. Values to be specified are the user class names which are already existing on the server. The format of the value should be a hex string prepended with 0x. The values following the EQ operator are treated as multiple assertions which are joined with a bitwise OR combination. The values following the NE operator are treated as multiple assertions which are joined with a bitwise AND combination.

MacAddress [in]

The comparator to use and values to compare MAC Address in the client request with. The first element is the comparator (EQ, NE), and subsequent elements are values. If the last character in a value is an asterisk (*), the subsequent characters are treated as wild-cards for the comparison. Values can again be followed by another comparator (EQ, NE) which is followed by another set of values. Input format is a hex 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. Output format is hex string with hyphen separation. The values following the EQ operator will be treated as multiple assertions which are joined with a bitwise OR combination. The values following the NE operator will be treated as multiple assertions which are joined with a bitwise AND combination.

CircuitId [in]

The comparator to use and values to compare circuit id suboption with. The first element is the comparator (EQ, NE) followed by a single value. No wildcard characters are allowed. Value can again be followed by another comparator (EQ, NE) which is followed by another value. Input format for the value is a hex string with or without hyphen separation.

ClientId [in]

The comparator to use and values to compare client identifier with. The first element is the comparator (EQ, NE), and subsequent elements are values. If the last character in a value is an asterisk (*), the subsequent characters are treated as wild-cards for the comparison. Values can again be followed by another comparator (EQ, NE) which is followed by another set of values. Input format is a hex string with or without hyphen separation. Output format is hex string with hyphen separation. The values following the EQ operator will be treated as multiple assertions which are joined with a bitwise OR combination. The values following the NE operator will be treated as multiple assertions which are joined with a bitwise AND combination. Example { EQ, 00-11-22-33-44-55, AA-BB-CC-DD-EE* }

cmdletOutput [out]

An embedded instance of the DhcpServerv4Policy class.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012

Namespace

\root\Microsoft\Windows\DHCP

MOF

DhcpServerPsProvider.mof

See also

PS_DhcpServerv4Policy

 

 

Show:
© 2014 Microsoft