Get-NetworkControllerStatistics
This cmdlet displays health and usage statistics of resources in Network Controller
Syntax
Default (Default)
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Uri |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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