Remove-NetworkControllerDiscoveredTopologyLink

Remove-NetworkControllerDiscoveredTopologyLink

Removes a topology link from the discovered topology.

Syntax

Parameter Set: Default
Remove-NetworkControllerDiscoveredTopologyLink [-ResourceId] <String> [[-VersionId] <String> ] [[-Force]] -ConnectionUri <String> [-CertificateThumbprint <String> ] [-Credential <PSCredential> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Remove-NetworkControllerDiscoveredTopologyLink cmdlet removes a topology link from the discovered topology. You can remove only topology links that you added manually to the topology.

A discovered topology consists of topology nodes, termination points on topology nodes, and links between termination points. A topology node is a device on the network, such as a network switch, a router, or a server. A termination point is an interface on a topology node, such as a server physical interface or a switch port. Each link joins two termination points. Links between termination points depict the topology of the network.

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.

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

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

-Force

Forces the command to run without asking for user confirmation.

-ResourceId<String>

Specifies the resource ID of the link that this cmdlet removes.

-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 representing the state of the resource at the time the response was generated.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

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

<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: Remove a link

This command removes a topology link that has the resource ID Link22 from the discovered topology. For this command to succeed, you must have previously added Link22 manually.

PS C:\> Remove-NetworkControllerDiscoveredTopologyLink -ConnectionUri "https://networkcontroller" -ResourceId "Link22" 

Related topics

Get-NetworkControllerDiscoveredTopology

Get-NetworkControllerDiscoveredTopologyLink

Install-NetworkController

New-NetworkControllerDiscoveredTopologyLink

Remove-NetworkControllerDesiredStateTopologyLink

Set-NetworkController