Invoke-NetworkControllerTopologyDiscovery

Invoke-NetworkControllerTopologyDiscovery

Starts network discovery.

Syntax

Parameter Set: Default
Invoke-NetworkControllerTopologyDiscovery [-Properties] <NetworkDiscoveryActionProperties> [[-ResourceMetadata] <ResourceMetadata> ] [[-ResourceId] <String> ] [[-VersionId] <String> ] [[-Force]] -ConnectionUri <String> [-CertificateThumbprint <String> ] [-Credential <PSCredential> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Invoke-NetworkControllerTopologyDiscovery cmdlet starts network discovery through the network controller. In order to start discovery, first configure the discovery parameters by using the Set-NetworkControllerTopologyConfiguration cmdlet. That cmdlet can configure discovery to run at fixed intervals or to stop running.

To see the discovered topology, use the Get-NetworkControllerDiscoveredTopology cmdlet. You can compare the discovered topology with the desired state topology to find anomalies and correct them manually.

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?

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 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

-Force

Forces the command to run without asking for user confirmation.


Aliases

none

Required?

false

Position?

8

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Properties<NetworkDiscoveryActionProperties>

Specifies the properties of topology discovery that this cmdlet adds or modifies. You can modify the following property:

-- Action. Whether to Start or Stop discovery.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-ResourceId<String>

Specifies a resource ID.


Aliases

none

Required?

false

Position?

6

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ResourceMetadata<ResourceMetadata>

Specifies metadata information for the client, such as tenant ID, group ID, and resource name.


Aliases

none

Required?

false

Position?

5

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VersionId<String>

Specifies the entity tag (ETag) parameter of the resource. An ETag is an HTTP response header returned by an HTTP-compliant web server. An ETag is used to determine change in the content of a resource at a given URL. The value of the header is an opaque string that represents the state of the resource at the time the response was generated.


Aliases

none

Required?

false

Position?

7

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

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.

Examples

Example 1: Start network discovery

The first command creates a NetworkDiscoveryActionProperties object by using the New-Object cmdlet. The command stores that object in the $Discovery variable.

The second command assigns a value of Start to the Action property of $Discovery.

The final command starts discovery by specifying $Discovery as the value of the Properties parameter.


PS C:\> $Discovery = New-Object Microsoft.Windows.NetworkController.NetworkDiscoveryActionProperties
PS C:\> $Discovery.Action = "Start"
PS C:\> Invoke-NetworkControllerTopologyDiscovery -ConnectionUri "https://networkcontroller" -Properties $Discovery 

Related topics

Community Additions

Show: