PS_DhcpServerv4Lease, ROOT\Microsoft\Windows\DHCP\MS_409

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

Description

DhcpServer v4Lease

PS_DhcpServerv4Lease methods

PS_DhcpServerv4Lease has 9 methods (9 Local)

NameOriginReturn
AddPS_DhcpServerv4Leaseuint32 {'out':True}
GetByBadLeasesPS_DhcpServerv4Leaseuint32 {'out':True}
GetByClientIdPS_DhcpServerv4Leaseuint32 {'out':True}
GetByIPAddressPS_DhcpServerv4Leaseuint32 {'out':True}
GetByScopeIdPS_DhcpServerv4Leaseuint32 {'out':True}
RemoveByBadLeasesPS_DhcpServerv4Leaseuint32 {'out':True}
RemoveByClientIdPS_DhcpServerv4Leaseuint32 {'out':True}
RemoveByIPAddressPS_DhcpServerv4Leaseuint32 {'out':True}
RemoveByScopeIdPS_DhcpServerv4Leaseuint32 {'out':True}

Detailed description of PS_DhcpServerv4Lease methods

Local methods (9) of PS_DhcpServerv4Lease class

Add method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
IPAddressstring0-{'Description':'IP Address for which the IP address lease record is to be added on the DHCP server','In':True}
ScopeIdstring1-{'Description':'Subnet mask to be set on the IP address lease record being added','In':True}
ClientIdstring2-{'Description':'Client identifier to be set on the IP address lease','In':True}
AddressStatestring3-{'Description':'State of the IP Address lease. Valid values are Active, Declined, Expired, Inactive. Default value is Active.','In':True,'Values':['Active', 'Declined', 'Expired', 'ActiveReservation', 'InactiveReservation']}
HostNamestring4-{'Description':'DNS hostname of the client for which the IP address lease is to be added','In':True}
Descriptionstring5-{'Description':'Description string to be set on the IP address lease','In':True}
ComputerNamestring6-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
PassThruboolean7-{'Description':'If this parameter is specified, the cmdlet returns the PowerShell object which is added.','In':True}
DnsRRstring8-{'Description':'Indicates the type of DNS record to be registered by the DHCP server for the lease.','In':True,'Values':['A', 'PTR', 'AandPTR', 'NoRegistration']}
DnsRegistrationstring9-{'Description':'Indicates status of the DNS registration of the lease.','In':True,'Values':['Complete', 'Pending', 'NotApplicable']}
ClientTypestring10-{'Description':'Type of the client. Valid values are UNSPECIFIED, DHCP, BOOTP, BOTH, RESERVATION, NONE.','In':True,'Values':['UnSpecified', 'Dhcp', 'BootP', 'None']}
LeaseExpiryTimedatetime11-{'Description':'Expiry time of the IP address lease','In':True}
NapCapableboolean12-{'Description':'Indicate if the client is NAP capable or not. Valid values are True, False.','In':True}
NapStatusstring13-{'Description':'NAP status of the client. Valid values are NOQUARANTINE , RESTRICTEDACCESS, DROPPACKET, PROBATION, EXEMPT, DEFAULTQUARSETTING, NOQUARINFO Default value is NOQUARANTINE. If NapStatus is specified as PROBATION and probation period is not specified, cmdlet will return an error. If NapStatus is not specified or is specified something other than Probation and probation period is not specified, the probation period to set to 0. If NapStatus is not specified and probation period is specified, the NapStatus is set to PROBATION. If NapStatus is not specified or specified other than Probation AND ProbationEnds is specified, cmdlet will return an error. ','In':True,'Values':['FullAccess', 'RestrictedAccess', 'DropPacket', 'InProbation', 'Exempt', 'DefaultQuarantineSetting', 'NoQuarantineInfo']}
ProbationEndsdatetime14-{'Description':'End-time of probation to be set on the IP address lease record. Default value is 0.','In':True}
PolicyNamestring15-{'Description':'Name of the policy to be set on the IP address lease record being added. Note: DHCP server does not perform any check on whether the policy specified exists on the server.','In':True}
cmdletOutputobject:DhcpServerv4Lease16-{'Description':' Type Name Description DhcpServerv4Lease { string AddressState Address state (Active, Declined, Expired, Inactive) IPAddress IPAddress Client IP address IPAddress ScopeId Scope identifier string Description Client comment string ClientId Client unique identifier for Address Lease. Input format is a hex string with or without hyphen separation. Output format is hex string with hyphen separation. string HostName Client name string ClientType Client type {UNSPECIFIED, DHCP, BOOTP, BOTH, RESERVATION, NONE} DateTime LeaseExpiryTime Lease expiry time. Output format will be as per the time zone of the user and the culture setting. bool NapCapable Indicates if DHCPv4 client is NAP capable or not string NapStatus NAP status is one of { NOQUARANTINE , RESTRICTEDACCESS, DROPPACKET, PROBATION, EXEMPT, DEFAULTQUARSETTING, NOQUARINFO } DateTime ProbationEnds End-time of probation if the DHCPv4 client is in probation. Outputformat will be as per the time zone of the user and the culture setting. IPAddress SubnetMask Subnet mask for Address Lease }','Out':True}
Description'Adds a new IPv4 address lease in the DHCP server'
Add method is in 21 classes of ROOT\Microsoft\Windows\DHCP\ms_409 and in 17 namespaces
GetByBadLeases method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerNamestring0-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
BadLeasesboolean1-{'Description':'If specified, only bad leases are returned. If an IP address lease is declined by the client because of a conflict, the lease record is marked as bad (declined) by the DHCP server. An IP address lease in this state is not offered to any client until expiry of a timer (10 minutes).','In':True}
ScopeIdstring2-{'Description':'Scope identifier (in IPv4 address format) from which the IPv4 address leases are to be retrieved','In':True}
cmdletOutputobject:DhcpServerv4Lease3-{'Description':' Type Name Description DhcpServerv4Lease { string AddressState Address state (Active, Declined, Expired, Inactive) IPAddress IPAddress Client IP address IPAddress ScopeId Scope identifier string Description Client comment string ClientId Client unique identifier for Address Lease. Input format is a hex string with or without hyphen separation. Output format is hex string with hyphen separation. string HostName Client name string ClientType Client type {UNSPECIFIED, DHCP, BOOTP, BOTH, RESERVATION, NONE} DateTime LeaseExpiryTime Lease expiry time. Output format will be as per the time zone of the user and the culture setting. bool NapCapable Indicates if DHCPv4 client is NAP capable or not string NapStatus NAP status is one of { NOQUARANTINE , RESTRICTEDACCESS, DROPPACKET, PROBATION, EXEMPT, DEFAULTQUARSETTING, NOQUARINFO } DateTime ProbationEnds End-time of probation if the DHCPv4 client is in probation. Outputformat will be as per the time zone of the user and the culture setting. IPAddress SubnetMask Subnet mask for Address Lease }','Out':True}
Description'Gets one or more lease records from the DHCP server'
GetByBadLeases method is in 1 class (PS_DhcpServerv4Lease) of ROOT\Microsoft\Windows\DHCP\ms_409 and in 2 namespaces
GetByClientId method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerNamestring0-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
ClientIdstring1-{'Description':'Client identifier for which the IP address lease record is to be retrieved.','In':True}
ScopeIdstring2-{'Description':'Scope identifier (in IPv4 address format) from which the IPv4 address leases are to be retrieved','In':True}
cmdletOutputobject:DhcpServerv4Lease3-{'Description':' Type Name Description DhcpServerv4Lease { string AddressState Address state (Active, Declined, Expired, Inactive) IPAddress IPAddress Client IP address IPAddress ScopeId Scope identifier string Description Client comment string ClientId Client unique identifier for Address Lease. Input format is a hex string with or without hyphen separation. Output format is hex string with hyphen separation. string HostName Client name string ClientType Client type {UNSPECIFIED, DHCP, BOOTP, BOTH, RESERVATION, NONE} DateTime LeaseExpiryTime Lease expiry time. Output format will be as per the time zone of the user and the culture setting. bool NapCapable Indicates if DHCPv4 client is NAP capable or not string NapStatus NAP status is one of { NOQUARANTINE , RESTRICTEDACCESS, DROPPACKET, PROBATION, EXEMPT, DEFAULTQUARSETTING, NOQUARINFO } DateTime ProbationEnds End-time of probation if the DHCPv4 client is in probation. Outputformat will be as per the time zone of the user and the culture setting. IPAddress SubnetMask Subnet mask for Address Lease }','Out':True}
Description'Gets one or more lease records from the DHCP server'
GetByClientId method is in 2 classes of ROOT\Microsoft\Windows\DHCP\ms_409 and in 2 namespaces
GetByIPAddress method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerNamestring0-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
IPAddressstring1-{'Description':'IP address for which the lease record is to be retrieved.','In':True}
cmdletOutputobject:DhcpServerv4Lease2-{'Description':' Type Name Description DhcpServerv4Lease { string AddressState Address state (Active, Declined, Expired, Inactive) IPAddress IPAddress Client IP address IPAddress ScopeId Scope identifier string Description Client comment string ClientId Client unique identifier for Address Lease. Input format is a hex string with or without hyphen separation. Output format is hex string with hyphen separation. string HostName Client name string ClientType Client type {UNSPECIFIED, DHCP, BOOTP, BOTH, RESERVATION, NONE} DateTime LeaseExpiryTime Lease expiry time. Output format will be as per the time zone of the user and the culture setting. bool NapCapable Indicates if DHCPv4 client is NAP capable or not string NapStatus NAP status is one of { NOQUARANTINE , RESTRICTEDACCESS, DROPPACKET, PROBATION, EXEMPT, DEFAULTQUARSETTING, NOQUARINFO } DateTime ProbationEnds End-time of probation if the DHCPv4 client is in probation. Outputformat will be as per the time zone of the user and the culture setting. IPAddress SubnetMask Subnet mask for Address Lease }','Out':True}
Description'Gets one or more lease records from the DHCP server'
GetByIPAddress method is in 4 classes of ROOT\Microsoft\Windows\DHCP\ms_409 and in 2 namespaces
GetByScopeId method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerNamestring0-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
AllLeasesboolean1-{'Description':'If specified, all the IP address leases regardless of address state are returned. If not specified, only active leases are returned','In':True}
ScopeIdstring2-{'Description':'Scope identifier (in IPv4 address format) from which the IPv4 address leases are to be retrieved','In':True}
cmdletOutputobject:DhcpServerv4Lease3-{'Description':' Type Name Description DhcpServerv4Lease { string AddressState Address state (Active, Declined, Expired, Inactive) IPAddress IPAddress Client IP address IPAddress ScopeId Scope identifier string Description Client comment string ClientId Client unique identifier for Address Lease. Input format is a hex string with or without hyphen separation. Output format is hex string with hyphen separation. string HostName Client name string ClientType Client type {UNSPECIFIED, DHCP, BOOTP, BOTH, RESERVATION, NONE} DateTime LeaseExpiryTime Lease expiry time. Output format will be as per the time zone of the user and the culture setting. bool NapCapable Indicates if DHCPv4 client is NAP capable or not string NapStatus NAP status is one of { NOQUARANTINE , RESTRICTEDACCESS, DROPPACKET, PROBATION, EXEMPT, DEFAULTQUARSETTING, NOQUARINFO } DateTime ProbationEnds End-time of probation if the DHCPv4 client is in probation. Outputformat will be as per the time zone of the user and the culture setting. IPAddress SubnetMask Subnet mask for Address Lease }','Out':True}
Description'Gets one or more lease records from the DHCP server'
GetByScopeId method is in 3 classes of ROOT\Microsoft\Windows\DHCP\ms_409 and in 2 namespaces
RemoveByBadLeases method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
PassThruboolean0-{'Description':'If this parameter is specified, the cmdlet return the PowerShell objects which are deleted.','In':True}
ComputerNamestring1-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
BadLeasesboolean2-{'Description':'If specified, all bad IP address leases are deleted. An IP address lease which is declined by a client because of an IP address conflict are marked as Bad by the server.','In':True}
ScopeIdstring3-{'Description':'Scope identifier (in IPv4 address format) from which the IP address leases are to be deleted.','In':True}
cmdletOutputobject:DhcpServerv4Lease4-{'Description':' Type Name Description DhcpServerv4Lease { string AddressState Address state (Active, Declined, Expired, Inactive) IPAddress IPAddress Client IP address IPAddress ScopeId Scope identifier string Description Client comment string ClientId Client unique identifier for Address Lease. Input format is a hex string with or without hyphen separation. Output format is hex string with hyphen separation. string HostName Client name string ClientType Client type {UNSPECIFIED, DHCP, BOOTP, BOTH, RESERVATION, NONE} DateTime LeaseExpiryTime Lease expiry time. Output format will be as per the time zone of the user and the culture setting. bool NapCapable Indicates if DHCPv4 client is NAP capable or not string NapStatus NAP status is one of { NOQUARANTINE , RESTRICTEDACCESS, DROPPACKET, PROBATION, EXEMPT, DEFAULTQUARSETTING, NOQUARINFO } DateTime ProbationEnds End-time of probation if the DHCPv4 client is in probation. Outputformat will be as per the time zone of the user and the culture setting. IPAddress SubnetMask Subnet mask for Address Lease }','Out':True}
Description'Deletes the specified IPv4 address lease record from the DHCP server'
RemoveByBadLeases method is in 1 class (PS_DhcpServerv4Lease) of ROOT\Microsoft\Windows\DHCP\ms_409 and in 2 namespaces
RemoveByClientId method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
PassThruboolean0-{'Description':'If this parameter is specified, the cmdlet return the PowerShell objects which are deleted.','In':True}
ComputerNamestring1-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
ClientIdstring2-{'Description':'Client identifier whose IP address lease is to be deleted. Windows clients use the MAC address as the client identifier.','In':True}
ScopeIdstring3-{'Description':'Scope identifier (in IPv4 address format) from which the IP address leases are to be deleted.','In':True}
cmdletOutputobject:DhcpServerv4Lease4-{'Description':' Type Name Description DhcpServerv4Lease { string AddressState Address state (Active, Declined, Expired, Inactive) IPAddress IPAddress Client IP address IPAddress ScopeId Scope identifier string Description Client comment string ClientId Client unique identifier for Address Lease. Input format is a hex string with or without hyphen separation. Output format is hex string with hyphen separation. string HostName Client name string ClientType Client type {UNSPECIFIED, DHCP, BOOTP, BOTH, RESERVATION, NONE} DateTime LeaseExpiryTime Lease expiry time. Output format will be as per the time zone of the user and the culture setting. bool NapCapable Indicates if DHCPv4 client is NAP capable or not string NapStatus NAP status is one of { NOQUARANTINE , RESTRICTEDACCESS, DROPPACKET, PROBATION, EXEMPT, DEFAULTQUARSETTING, NOQUARINFO } DateTime ProbationEnds End-time of probation if the DHCPv4 client is in probation. Outputformat will be as per the time zone of the user and the culture setting. IPAddress SubnetMask Subnet mask for Address Lease }','Out':True}
Description'Deletes the specified IPv4 address lease record from the DHCP server'
RemoveByClientId method is in 2 classes of ROOT\Microsoft\Windows\DHCP\ms_409 and in 2 namespaces
RemoveByIPAddress method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
PassThruboolean0-{'Description':'If this parameter is specified, the cmdlet return the PowerShell objects which are deleted.','In':True}
ComputerNamestring1-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
IPAddressstring2-{'Description':'IP address(es) whose lease records are to be deleted','In':True}
cmdletOutputobject:DhcpServerv4Lease3-{'Description':' Type Name Description DhcpServerv4Lease { string AddressState Address state (Active, Declined, Expired, Inactive) IPAddress IPAddress Client IP address IPAddress ScopeId Scope identifier string Description Client comment string ClientId Client unique identifier for Address Lease. Input format is a hex string with or without hyphen separation. Output format is hex string with hyphen separation. string HostName Client name string ClientType Client type {UNSPECIFIED, DHCP, BOOTP, BOTH, RESERVATION, NONE} DateTime LeaseExpiryTime Lease expiry time. Output format will be as per the time zone of the user and the culture setting. bool NapCapable Indicates if DHCPv4 client is NAP capable or not string NapStatus NAP status is one of { NOQUARANTINE , RESTRICTEDACCESS, DROPPACKET, PROBATION, EXEMPT, DEFAULTQUARSETTING, NOQUARINFO } DateTime ProbationEnds End-time of probation if the DHCPv4 client is in probation. Outputformat will be as per the time zone of the user and the culture setting. IPAddress SubnetMask Subnet mask for Address Lease }','Out':True}
Description'Deletes the specified IPv4 address lease record from the DHCP server'
RemoveByIPAddress method is in 4 classes of ROOT\Microsoft\Windows\DHCP\ms_409 and in 2 namespaces
RemoveByScopeId method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
PassThruboolean0-{'Description':'If this parameter is specified, the cmdlet return the PowerShell objects which are deleted.','In':True}
ComputerNamestring1-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
ScopeIdstring2-{'Description':'Scope identifier (in IPv4 address format) from which the IP address leases are to be deleted.','In':True}
cmdletOutputobject:DhcpServerv4Lease3-{'Description':' Type Name Description DhcpServerv4Lease { string AddressState Address state (Active, Declined, Expired, Inactive) IPAddress IPAddress Client IP address IPAddress ScopeId Scope identifier string Description Client comment string ClientId Client unique identifier for Address Lease. Input format is a hex string with or without hyphen separation. Output format is hex string with hyphen separation. string HostName Client name string ClientType Client type {UNSPECIFIED, DHCP, BOOTP, BOTH, RESERVATION, NONE} DateTime LeaseExpiryTime Lease expiry time. Output format will be as per the time zone of the user and the culture setting. bool NapCapable Indicates if DHCPv4 client is NAP capable or not string NapStatus NAP status is one of { NOQUARANTINE , RESTRICTEDACCESS, DROPPACKET, PROBATION, EXEMPT, DEFAULTQUARSETTING, NOQUARINFO } DateTime ProbationEnds End-time of probation if the DHCPv4 client is in probation. Outputformat will be as per the time zone of the user and the culture setting. IPAddress SubnetMask Subnet mask for Address Lease }','Out':True}
Description'Deletes the specified IPv4 address lease record from the DHCP server'
RemoveByScopeId method is in 2 classes of ROOT\Microsoft\Windows\DHCP\ms_409 and in 2 namespaces

PS_DhcpServerv4Lease Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AMENDMENTTrue
Description'DhcpServer v4Lease'
LOCALE'MS_409'

PS_DhcpServerv4Lease System properties

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

Similar Classes to PS_DhcpServerv4Lease

Number of classes:1
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
DhcpServerv4Lease0140----
comments powered by Disqus
online utility - toplist
WUtils.com