PS_DhcpServerv4Policy, ROOT\Microsoft\Windows\DHCP\MS_409

Class | Methods (4) | Properties | Qualifiers (3) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

Dhcp Server v4Policy

PS_DhcpServerv4Policy methods

PS_DhcpServerv4Policy has 4 methods (4 Local)

NameOriginReturn
AddPS_DhcpServerv4Policyuint32 {'out':True}
GetPS_DhcpServerv4Policyuint32 {'out':True}
RemovePS_DhcpServerv4Policyuint32 {'out':True}
SetPS_DhcpServerv4Policyuint32 {'out':True}

Detailed description of PS_DhcpServerv4Policy methods

Local methods (4) of PS_DhcpServerv4Policy class

Add method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerNamestring0-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
Namestring1-{'Description':'Name of the policy to be added','In':True}
Conditionstring2-{'Description':'The logical operator between conditions in case multiple conditions are specified. Valid values are AND, OR.','In':True,'Values':['And', 'Or']}
Descriptionstring3-{'Description':'Description string of the policy being added','In':True}
ScopeIdstring4-{'Description':'Scope identifier (in IPv4 address format) in which the policy is being added','In':True}
ProcessingOrderuint165-{'Description':'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.','In':True}
RelayAgentstring6-{'Description':'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 wild cards 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. ','In':True}
RemoteIdstring7-{'Description':'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 wild cards 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. ','In':True}
SubscriberIdstring8-{'Description':'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 wild cards 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. ','In':True}
PassThruboolean9-{'Description':'If this parameter is specified, the cmdlet returns the PowerShell object which is added.','In':True}
LeaseDurationdatetime10-{'Description':'Lease duration to be set for clients matching the policy','In':True}
Fqdnstring11-{'Description':'The comparator to use, and values to compare Fqdn with. The first element is the comparator {EQ, NE, Isl, Insl}, and subsequent elements are values. For comparators Isl and Insl only a blank value is admissible. 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. Values can again be followed by another Comparator (EQ/NE) which is followed by another set of values. Input format is a string. 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. ','In':True}
Enabledboolean12-{'Description':'Enable/Disable policy. Valid values are True, False.','In':True}
VendorClassstring13-{'Description':'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 ORed. The values following the NE operator are treated as multiple assertions which are ANDed.','In':True}
UserClassstring14-{'Description':'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 ORed. The values following the NE operator are treated as multiple assertions which are ANDed.','In':True}
MacAddressstring15-{'Description':'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 hexstring with or without hyphen separation. A trailing wild card 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 ORed. The values following the NE operator will be treated as multiple assertions which are ANDed.','In':True}
CircuitIdstring16-{'Description':'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 wild cards 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. ','In':True}
ClientIdstring17-{'Description':'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 ORed. The values following the NE operator will be treated as multiple assertions which are ANDed. Example { EQ, 00-11-22-33-44-55, AA-BB-CC-DD-EE*}','In':True}
cmdletOutputobject:DhcpServerv4Policy18-{'Description':' Type Name Description DHCPServerv4Policy { string Name Unique name for the Policy at the specified level string Description Description of the policy IPAddress ScopeId If specified, indicates the Scope for which the Policy exists. If 0, indicates a Policy at the Server level. bool Enabled Policy state; valid values are {true, False} string Condition Indicates whether Policy rules are logically combined with an ?AND? or an ?OR? ushort ProcessingOrder Processing order for the Policy string[] VendorClass The comparator to use, and values to compare VendorClass with. string[] MACAddress The comparator to use, and values to compare HWAddress with. String[] Fqdn The comparator to use, and values to compare FQDN with. string[] RelayAgent The comparator to use, and values to compare RelayAgent information with. string[] CircuitId The comparator to use, and values to compare CircuitId with. string[] RemoteId The comparator to use, and values to compare RemoteId with. string[] SubscriberId The comparator to use, and values to compare SubscriberId with. DateTime LeaseDuration Lease duration to be assigned for policy clients. } ','Out':True}
Description'Adds a new policy either at the Server level or at the Scope level. '
Add method is in 21 classes of ROOT\Microsoft\Windows\DHCP\ms_409 and in 17 namespaces
Get method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerNamestring0-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
Namestring1-{'Description':'Name(s) of the policy(ies) to be returned','In':True}
ScopeIdstring2-{'Description':'Scope identifier (in IPv4 address format) from which the policies are to be retrieved. If scope id is not specified, server level policies are retrieved.','In':True}
cmdletOutputobject:DhcpServerv4Policy3-{'Description':' Type Name Description DHCPServerv4Policy { string Name Unique name for the Policy at the specified level string Description Description of the policy IPAddress ScopeId If specified, indicates the Scope for which the Policy exists. If 0, indicates a Policy at the Server level. bool Enabled Policy state; valid values are {true, False} string Condition Indicates whether Policy rules are logically combined with an ?AND? or an ?OR? ushort ProcessingOrder Processing order for the Policy string[] VendorClass The comparator to use, and values to compare VendorClass with. string[] MACAddress The comparator to use, and values to compare HWAddress with. String[] Fqdn The comparator to use, and values to compare FQDN with. string[] RelayAgent The comparator to use, and values to compare RelayAgent information with. string[] CircuitId The comparator to use, and values to compare CircuitId with. string[] RemoteId The comparator to use, and values to compare RemoteId with. string[] SubscriberId The comparator to use, and values to compare SubscriberId with. DateTime LeaseDuration Lease duration to be assigned for policy clients. } ','Out':True}
Description'Gets one or more policies at the server level or the scope level. '
Get method is in 38 classes of ROOT\Microsoft\Windows\DHCP\ms_409 and in 19 namespaces
Remove method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerNamestring0-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
PassThruboolean1-{'Description':'If this parameter is specified, the cmdlet return the PowerShell objects which are deleted.','In':True}
Namestring2-{'Description':'Name(s) of the policies to be deleted.','In':True}
ScopeIdstring3-{'Description':'Scope Identifier (in IPv4 address format) from which the policies are to be deleted.','In':True}
cmdletOutputobject:DhcpServerv4Policy4-{'Description':' Type Name Description DHCPServerv4Policy { string Name Unique name for the Policy at the specified level string Description Description of the policy IPAddress ScopeId If specified, indicates the Scope for which the Policy exists. If 0, indicates a Policy at the Server level. bool Enabled Policy state; valid values are {true, False} string Condition Indicates whether Policy rules are logically combined with an ?AND? or an ?OR? ushort ProcessingOrder Processing order for the Policy string[] VendorClass The comparator to use, and values to compare VendorClass with. string[] MACAddress The comparator to use, and values to compare HWAddress with. String[] Fqdn The comparator to use, and values to compare FQDN with. string[] RelayAgent The comparator to use, and values to compare RelayAgent information with. string[] CircuitId The comparator to use, and values to compare CircuitId with. string[] RemoteId The comparator to use, and values to compare RemoteId with. string[] SubscriberId The comparator to use, and values to compare SubscriberId with. DateTime LeaseDuration Lease duration to be assigned for policy clients. } ','Out':True}
Description'Deletes the specified IPv4 policy(ies) either at the server level or the specified scope level.'
Remove method is in 21 classes of ROOT\Microsoft\Windows\DHCP\ms_409 and in 18 namespaces
Set method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerNamestring0-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
Descriptionstring1-{'Description':'Description string to be set on the policy','In':True}
Namestring2-{'Description':'Name of the policy to be modified','In':True}
ScopeIdstring3-{'Description':'Scope identifier (in IPv4 address format) of the scope which contains the policy. If not specified, server level policy is modified.','In':True}
Enabledboolean4-{'Description':'Enable/Disable policy. Valid values are True, False.','In':True}
MacAddressstring5-{'Description':'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 hexstring with or without hyphen separation. A trailing wild card 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 ORed. The values following the NE operator will be treated as multiple assertions which are ANDed.','In':True}
Fqdnstring6-{'Description':'The comparator to use, and values to compare Fqdn with. The first element is the comparator {EQ, NE, Isl, Insl}, and subsequent elements are values. For comparators Isl and Insl only a blank value is admissible. 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. Values can again be followed by another Comparator (EQ/NE) which is followed by another set of values. Input format is a string. 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. ','In':True}
UserClassstring7-{'Description':'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 ORed. The values following the NE operator are treated as multiple assertions which are ANDed.','In':True}
SubscriberIdstring8-{'Description':'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 wild cards 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. ','In':True}
NewNamestring9-{'Description':'New name to be set for the policy','In':True}
ClientIdstring10-{'Description':'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 ORed. The values following the NE operator will be treated as multiple assertions which are ANDed. Example { EQ, 00-11-22-33-44-55, AA-BB-CC-DD-EE*}','In':True}
PassThruboolean11-{'Description':'If this parameter is specified, the cmdlet returns the PowerShell object which is modified.','In':True}
LeaseDurationdatetime12-{'Description':'Lease duration for policy clients','In':True}
ProcessingOrderuint1613-{'Description':'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.','In':True}
RelayAgentstring14-{'Description':'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 wild cards 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.','In':True}
RemoteIdstring15-{'Description':'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 wild cards 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.','In':True}
CircuitIdstring16-{'Description':'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 wild cards 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.','In':True}
Conditionstring17-{'Description':'The logical operator between conditions in case multiple conditions are specified. Valid values are AND, OR.','In':True,'Values':['And', 'Or']}
VendorClassstring18-{'Description':'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 ORed. The values following the NE operator are treated as multiple assertions which are ANDed.','In':True}
cmdletOutputobject:DhcpServerv4Policy19-{'Description':' Type Name Description DHCPServerv4Policy { string Name Unique name for the Policy at the specified level string Description Description of the policy IPAddress ScopeId If specified, indicates the Scope for which the Policy exists. If 0, indicates a Policy at the Server level. bool Enabled Policy state; valid values are {true, False} string Condition Indicates whether Policy rules are logically combined with an ?AND? or an ?OR? ushort ProcessingOrder Processing order for the Policy string[] VendorClass The comparator to use, and values to compare VendorClass with. string[] MACAddress The comparator to use, and values to compare HWAddress with. String[] Fqdn The comparator to use, and values to compare FQDN with. string[] RelayAgent The comparator to use, and values to compare RelayAgent information with. string[] CircuitId The comparator to use, and values to compare CircuitId with. string[] RemoteId The comparator to use, and values to compare RemoteId with. string[] SubscriberId The comparator to use, and values to compare SubscriberId with. DateTime LeaseDuration Lease duration to be assigned for policy clients. } ','Out':True}
Description'Sets the properties of an existing policy either at the server level or at the specified scope level. '
Set method is in 20 classes of ROOT\Microsoft\Windows\DHCP\ms_409 and in 20 namespaces

PS_DhcpServerv4Policy Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AMENDMENTTrue
Description'Dhcp Server v4Policy'
LOCALE'MS_409'

PS_DhcpServerv4Policy System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\Microsoft\Windows\DHCP\ms_409:PS_DhcpServerv4Policy'___SYSTEM8
__NAMESPACE'ROOT\Microsoft\Windows\DHCP\ms_409'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION[]___SYSTEM8
__PROPERTY_COUNT0___SYSTEM3
__RELPATH'PS_DhcpServerv4Policy'___SYSTEM8
__DYNASTY'PS_DhcpServerv4Policy'___SYSTEM8
__SUPERCLASSnull___SYSTEM8
__CLASS'PS_DhcpServerv4Policy'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to PS_DhcpServerv4Policy

Number of classes:3
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
DhcpServerv4Policy0160----
DhcpServerv4PolicyIPRange040----
PS_DhcpServerv4PolicyIPRange003----
comments powered by Disqus
online utility - toplist
WUtils.com