{'Description':'IP Address for which the IP address lease record is to be added on the DHCP server','In':True}
ScopeId
string
1
✓
-
{'Description':'Subnet mask to be set on the IP address lease record being added','In':True}
ClientId
string
2
✓
-
{'Description':'Client identifier to be set on the IP address lease','In':True}
AddressState
string
3
✓
-
{'Description':'State of the IP Address lease. Valid values are Active, Declined, Expired, Inactive. Default value is Active.','In':True,'ValueMap':['Active', 'Declined', 'Expired', 'ActiveReservation', 'InactiveReservation'],'Values':['Active', 'Declined', 'Expired', 'ActiveReservation', 'InactiveReservation']}
HostName
string
4
✓
-
{'Description':'DNS hostname of the client for which the IP address lease is to be added','In':True}
Description
string
5
✓
-
{'Description':'Description string to be set on the IP address lease','In':True}
ComputerName
string
6
✓
-
{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
PassThru
boolean
7
✓
-
{'Description':'If this parameter is specified, the cmdlet returns the PowerShell object which is added.','In':True}
DnsRR
string
8
✓
-
{'Description':'Indicates the type of DNS record to be registered by the DHCP server for the lease.','In':True,'ValueMap':['A', 'PTR', 'AandPTR', 'NoRegistration'],'Values':['A', 'PTR', 'AandPTR', 'NoRegistration']}
DnsRegistration
string
9
✓
-
{'Description':'Indicates status of the DNS registration of the lease.','In':True,'ValueMap':['Complete', 'Pending', 'NotApplicable'],'Values':['Complete', 'Pending', 'NotApplicable']}
ClientType
string
10
✓
-
{'Description':'Type of the client. Valid values are UNSPECIFIED, DHCP, BOOTP, BOTH, RESERVATION, NONE.','In':True,'ValueMap':['UnSpecified', 'Dhcp', 'BootP', 'None'],'Values':['UnSpecified', 'Dhcp', 'BootP', 'None']}
LeaseExpiryTime
datetime
11
✓
-
{'Description':'Expiry time of the IP address lease','In':True}
NapCapable
boolean
12
✓
-
{'Description':'Indicate if the client is NAP capable or not. Valid values are True, False.','In':True}
NapStatus
string
13
✓
-
{'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,'ValueMap':['FullAccess', 'RestrictedAccess', 'DropPacket', 'InProbation', 'Exempt', 'DefaultQuarantineSetting', 'NoQuarantineInfo'],'Values':['FullAccess', 'RestrictedAccess', 'DropPacket', 'InProbation', 'Exempt', 'DefaultQuarantineSetting', 'NoQuarantineInfo']}
ProbationEnds
datetime
14
✓
-
{'Description':'End-time of probation to be set on the IP address lease record.
Default value is 0.','In':True}
PolicyName
string
15
✓
-
{'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}
{'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
}','EmbeddedInstance':'DhcpServerv4Lease','Out':True}
Description
'Adds a new IPv4 address lease in the DHCP server'
{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
BadLeases
boolean
1
✓
-
{'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}
ScopeId
string
2
✓
-
{'Description':'Scope identifier (in IPv4 address format) from which the IPv4 address leases are to be retrieved','In':True}
{'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
}','EmbeddedInstance':'DhcpServerv4Lease','Out':True,'Stream':True}
Description
'Gets one or more lease records from the DHCP server'
implemented
True
static
True
GetByBadLeases method is in 1 class (PS_DhcpServerv4Lease) of ROOT\Microsoft\Windows\DHCP and in 2 namespaces
{'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
}','EmbeddedInstance':'DhcpServerv4Lease','Out':True}
Description
'Gets one or more lease records from the DHCP server'
{'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
}','EmbeddedInstance':'DhcpServerv4Lease','Out':True}
Description
'Gets one or more lease records from the DHCP server'
{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
AllLeases
boolean
1
✓
-
{'Description':'If specified, all the IP address leases regardless of address state are returned.
If not specified, only active leases are returned','In':True}
ScopeId
string
2
✓
-
{'Description':'Scope identifier (in IPv4 address format) from which the IPv4 address leases are to be retrieved','In':True}
{'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
}','EmbeddedInstance':'DhcpServerv4Lease','Out':True,'Stream':True}
Description
'Gets one or more lease records from the DHCP server'
{'Description':'If this parameter is specified, the cmdlet return the PowerShell objects which are deleted.','In':True}
ComputerName
string
1
✓
-
{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
BadLeases
boolean
2
✓
-
{'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}
ScopeId
string
3
✓
-
{'Description':'Scope identifier (in IPv4 address format) from which the IP address leases are to be deleted.','In':True}
{'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
}','EmbeddedInstance':'DhcpServerv4Lease','Out':True,'Stream':True}
Description
'Deletes the specified IPv4 address lease record from the DHCP server'
implemented
True
static
True
RemoveByBadLeases method is in 1 class (PS_DhcpServerv4Lease) of ROOT\Microsoft\Windows\DHCP and in 2 namespaces
{'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
}','EmbeddedInstance':'DhcpServerv4Lease','Out':True}
Description
'Deletes the specified IPv4 address lease record from the DHCP server'
{'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
}','EmbeddedInstance':'DhcpServerv4Lease','Out':True}
Description
'Deletes the specified IPv4 address lease record from the DHCP server'
{'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
}','EmbeddedInstance':'DhcpServerv4Lease','Out':True,'Stream':True}
Description
'Deletes the specified IPv4 address lease record from the DHCP server'