Get-DhcpServerv4ScopeStatistics
Get-DhcpServerv4ScopeStatistics
Gets the IPv4 scope statistics corresponding to the IPv4 scope identifiers (IDs) specified for a Dynamic Host Configuration Protocol (DHCP) server service.
Syntax
Parameter Set: Get0
Get-DhcpServerv4ScopeStatistics [[-ScopeId] <IPAddress[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-Failover] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Get-DhcpServerv4ScopeStatistics cmdlet gets the scope statistics corresponding to the IPv4 scope identifiers (IDs) specified for a Dynamic Host Configuration Protocol (DHCP) server service. If the ScopeId parameter is not specified, then this cmdlet gets the statistics for all of the IPv4 scopes.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerName<String>
Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Failover
Specifies that, if the scope is configured for failover, the failover related scope statistics are returned as part of the scope statistics.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ScopeId<IPAddress[]>
Specifies the scope IDs, in IPv4 address format, for which the statistics are returned.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope[]
The
Microsoft.Management.Infrastructure.CimInstanceobject is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4ScopeStatistics[]
The
Microsoft.Management.Infrastructure.CimInstanceobject is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
Examples
EXAMPLE 1
This example gets the scope statistics for all the scopes present on the specified DHCP server service.
PS C:\> Get-DhcpServerv4ScopeStatistics -ComputerName dhcpSever.contoso.com
EXAMPLE 2
This example gets the scope statistics for the specified scope on the specified DHCP server service.
PS C:\> Get-DhcpServerv4ScopeStatistics -ComputerName dhcpSever.contoso.com -ScopeId 10.10.10.0
EXAMPLE 3
This example gets the scope statistics including those related to failover, if the scope is part of a failover relationship, for the specified scope on the specified DHCP server service.
PS C:\> Get-DhcpServerv4ScopeStatistics -ComputerName dhcpSever.contoso.com -ScopeId 10.10.10.0 -Failover
EXAMPLE 4
This example gets the scope statistics including those related to failover, if the scope is part of a failover relationship, for all of the scopes present on the specified DHCP server service.
PS C:\> Get-DhcpServerv4ScopeStatistics -ComputerName dhcpSever.contoso.com -Failover
EXAMPLE 5
This example gets the scope statistics for the scopes present on the specified DHCP server service, which have more than 80% of their IP address range exhausted.
PS C:\> Get-DhcpServerv4ScopeStatistics -ComputerName dhcpSever.contoso.com | Where-Object –FilterScript { $_.PercentageInUse -Gt 80 }