diff --git a/docset/windows/network-controller/get-networkcontrollerstatistics.md b/docset/windows/network-controller/get-networkcontrollerstatistics.md index 36244db187..f4d57965d8 100644 --- a/docset/windows/network-controller/get-networkcontrollerstatistics.md +++ b/docset/windows/network-controller/get-networkcontrollerstatistics.md @@ -20,6 +20,7 @@ ms.assetid: 4D06BF6F-B920-496E-BA38-D14EB91CB372 # Get-NetworkControllerStatistics ## SYNOPSIS +This cmdlet displays health and usage statistics of resources in Network Controller ## SYNTAX @@ -29,13 +30,25 @@ Get-NetworkControllerStatistics [-ConnectionUri ] [-CertificateThumbprint < ``` ## DESCRIPTION +This cmdlet displays health and usage statistics of resources in Network Controller. You can view the count of total resources, healthy resources, unhealthy resources and resources with unknown health for virtual network, gateway and load balancer resources. You can also see the utilization of public IPs, backend IPs and MAC address pools. ## EXAMPLES - +This example displays the health statistics of resources in Network Controller +``` +$stats=Get-NetworkControllerStatistics -ConnectionUri https://networkcontroller +$stats.Properties.HealthStatistics +``` +This example displays the usage statistics of resources in Network Controller +``` +$stats=Get-NetworkControllerStatistics -ConnectionUri https://networkcontroller +$stats.Properties.UsageStatistics +``` ## PARAMETERS ### -CertificateThumbprint +Specifies the digital public key X.509 certificate of a user account that has permission to perform this action.This is the certificate thumbprint of the certificate.This thumbprint must also be provided in the *ClientCertificateThumbprint* parameter in the **Install-NetworkController** or **Set-NetworkController** cmdlet so that Network Controller can authorize this user. + ```yaml Type: String Parameter Sets: (All) @@ -49,6 +62,8 @@ Accept wildcard characters: False ``` ### -ConnectionUri +Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller. + ```yaml Type: Uri Parameter Sets: (All) @@ -62,6 +77,8 @@ Accept wildcard characters: False ``` ### -Credential +Specifies a user credential that has permission to perform this action.The default value is the current user.This user must be present in the security group provided in the *ClientSecurityGroup* parameter in the **Install-NetworkController** cmdlet. + ```yaml Type: PSCredential Parameter Sets: (All) @@ -93,6 +110,19 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ## OUTPUTS +Following properties are displayed by the cmdlet: + +Resource health (for virtual networks, Gateways and Load balancers)    +1. Count of total resources    +2. Count of healthy resources    +3. Count of unhealthy resources    +4. Count of resources in warning state    +5. Count of resources with unknown health state + +Usage statistics    +1. Public IP utilization - Total resource count and count of resources in use    +2. Backend IP utilization - Total resource count and count of resources in use    +3. MAC pool utilization - Total resource count and count of resources in use ## NOTES