Skip to content

Update get-networkcontrollerstatistics.md #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 30, 2017
Merged

Update get-networkcontrollerstatistics.md #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion docset/windows/network-controller/get-networkcontrollerstatistics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -29,13 +30,25 @@ Get-NetworkControllerStatistics [-ConnectionUri <Uri>] [-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)
Expand 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)
Expand 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)
Expand Down Expand Up @@ -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

Expand Down