New-NetworkControllerDiscoveredTopologyLink

New-NetworkControllerDiscoveredTopologyLink

Adds or changes a topology link in the discovered topology.

Syntax

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




Detailed Description

The New-NetworkControllerDiscoveredTopologyLink cmdlet adds or changes a topology link in the discovered topology. To discover the topology of a network, run the Invoke-NetworkControllerTopologyDiscovery cmdlet.

For information about discovered network topology, see the Get-NetworkControllerDiscoveredTopology cmdlet.

If the discovered topology does not identify certain links, you can add them by using this cmdlet. If you develop a script or tool that compares the discovered topology to the expected topology, the comparison logic can show elements that are present in the network, but that are not discoverable by the discovery logic. Adding topology links lets your script to ignore these differences in the future when it displays the differences between the discovered and the actual topology.

This cmdlet can modify a link to hide it by specifying the IsHidden property. If the discovery logic displays a link that is not present in the actual topology, you can hide it so that a script or tool that compares the discovered and the actual topologies does not display that anomaly.

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?

9

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Properties<DiscoveredTopologyLinkProperties>

Specifies the properties of the link that this cmdlet adds or modifies. For discovered links, you can modify the following property:

-- IsHidden. Whether to hide the link. the output of the Get-NetworkControllerDiscoveredTopology cmdlet does not show hidden links.

For a link that you add manually, you can specify the following properties:

-- AggregateId. A system generated identifier that groups the links that are part of a single logical link, such as multiple physical links that form an aggregated link for uplink, which would share same AggregateId.
-- Label. A description of the link.
-- Type. The type of the link. Acceptable values for this property are Regular, Virtual, AggregateLink, and VLANTrunk.
-- TerminationPoint1. The interface for one end of the link.
-- TerminationPoint2. The interface for the other end of the link.


Aliases

none

Required?

true

Position?

4

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-ResourceId<String>

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


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

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?

7

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


Aliases

none

Required?

false

Position?

8

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: Hide a topology link

The first command gets an existing topology link by using the Get-NetworkControllerDiscoveredTopologyLink cmdlet, and then stores it in the $Link variable.

The second command assigns a value of true to the IsHidden property of $Link.

The final command updates the properties of the link to match the current value of $Link.


PS C:\> $Link = Get-NetworkControllerDiscoveredTopologyLink -ConnectionUri "https://networkcontroller" -ResourceId Link07
PS C:\> $Link.IsHidden = "true"
PS C:\> New-NetworkControllerDiscoveredTopologyLink -ConnectionUri "https://networkcontroller" -ResourceId "Link07" -Properties $Link

Related topics

Community Additions

Show: