Get-NetworkControllerStatistics

Reference

Module:: NetworkController

This cmdlet displays health and usage statistics of resources in Network Controller

Syntax

Get-NetworkControllerStatistics
   [-ConnectionUri <Uri>]
   [-CertificateThumbprint <String>]
   [-Credential <PSCredential>]
   [-PassInnerException]
   [<CommonParameters>]

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

Example 1

This example displays the health statistics of resources in Network Controller

$stats=Get-NetworkControllerStatistics -ConnectionUri https://networkcontroller
$stats.Properties.HealthStatistics

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.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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.

Type:	Uri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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.

Type:	PSCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassInnerException

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.

The thumbprint must be provided only if the network controller client authentication is X509 certificates. Get-NetworkController retrieves that client authentication and authorization information.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

None

Outputs

Object

Following properties are displayed by the cmdlet:

Resource health (for virtual networks, Gateways and Load balancers)

Count of total resources
Count of healthy resources
Count of unhealthy resources
Count of resources in warning state
Count of resources with unknown health state

Usage statistics

Public IP utilization - Total resource count and count of resources in use
Backend IP utilization - Total resource count and count of resources in use
MAC pool utilization - Total resource count and count of resources in use

Partager via