Get-NetworkControllerTopologyDiscoveryStatistics
Get-NetworkControllerTopologyDiscoveryStatistics
Gets the status of topology discovery.
Syntax
Parameter Set: Default
Get-NetworkControllerTopologyDiscoveryStatistics [-CertificateThumbprint <String> ] [-ConnectionUri <String> ] [-Credential <PSCredential> ] [ <CommonParameters>]
Detailed Description
The Get-NetworkControllerTopologyDiscoveryStatistics cmdlet gets the status of topology discovery from the network controller. This cmdlet determines whether network discovery is running, stopped, or stopping. The cmdlet displays the most recent time at which network discovery ran and how long it took to finish.
Parameters
-CertificateThumbprint<String>
Specifies the certificate thumbprint of a digital public key X.509 certificate of a user account that has permission to perform this action. In order for Network Controller to authorize the account, specify this thumbprint by using the ClientCertificateThumbprint parameter of the Install-NetworkController or Set-NetworkController cmdlet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ConnectionUri<String>
Specifies the Uniform Resource Identifier (URI) of the network controller that all Representational State Transfer (REST) clients use to connect to that controller.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies a user credential that has permission to perform this action. The default value is the current user.
This user must be a member of in the security group specified by the ClientSecurityGroup parameter of the Install-NetworkController cmdlet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
This cmdlet returns an object that contains the following information:
-- Status of network discovery. The acceptable values for this property are:
---- Running
---- Stopped
---- Stopping-- Last run timestamp of the cmdlet
-- Last run time (seconds)
Examples
Example 1: Check the status of network discovery
The first command gets the statistics for topology discovery for the specified URI. The command stores the statistics in the $Statistics variable.
The second command displays the Properties property of $Statistics. In this example, network discovery is stopped. Discovery last ran at the displayed time and took 121 seconds.
PS C:\> $Statistics = Get-NetworkControllerTopologyDiscoveryStatistics -ConnectionUri https://networkcontroller
PS C:\> $Statistics.Properties