New-NetworkControllerDesiredStateTopologyLink

New-NetworkControllerDesiredStateTopologyLink

Adds a link to the desired state topology.

Syntax

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




Detailed Description

The New-NetworkControllerDesiredStateTopologyLink cmdlet adds a link to the desired state topology.

You provide the desired state topology to the Network Controller. It represents the expected topology of the network.

A desired state 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.


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

Specifies the properties of the link that this cmdlet adds. 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 that represents 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.

Related topics

Community Additions

Show: