Get-NetworkControllerTopologyConfiguration

Get-NetworkControllerTopologyConfiguration

Gets the configuration for network discovery.

Syntax

Parameter Set: Default
Get-NetworkControllerTopologyConfiguration -ConnectionUri <String> [-CertificateThumbprint <String> ] [-Credential <PSCredential> ] [ <CommonParameters>]




Detailed Description

The Get-NetworkControllerTopologyConfiguration cmdlet gets the configuration for network topology discovery. The discovery configuration must be set before the topology discovery can be invoked using the Invoke-NetworkControllerTopologyDiscovery cmdlet.

Parameters

-CertificateThumbprint<String>

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 parameter is used only if you run this cmdlet on a computer that is not part of the network controller cluster.


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, used by all Representational State Transfer (REST) clients to connect to Network Controller.


Aliases

none

Required?

true

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 present in the security group provided in the ClientSecurityGroup parameter in 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.

  • Specifies the properties of the object. For the DiscoveryConfiguration object, the properties are the following:

    1. DiscoverHosts - Whether hosts should be discovered
    2. DiscoveryIntervalInMinutes - Frequency at which discovery should be run
    3. DiscoveryScopes - the subnets scopes for which discovery will be done
    4. Credentials - Credentials that will be used to access the discovered devices to get their configuration. This is a reference to the Credentials object
    5. DiscoverySeedDevices - The seed device IP from which the discovery will start
    6. HopLimit - The number of hops from the seed devices that the network discovery should be restricted to
    7. ActiveDirectoryDomains - List of Active Directory domains that should be looked up when searching for host records


Examples

Example 1: Get the topology discovery configuration

The first command gets the topology discovery configuration and stores the result in the variable named $Config. The second command displays the properties stored in the $Config variable and shows that hosts will be discovered, the discovery interval is 1 day, and the hop limit is 3.


PS C:\> $Config = Get-NetworkControllerTopologyConfiguration -ConnectionUri https://networkcontroller
PS C:\> $Config.Properties

Related topics

Community Additions

Show: