New-NetworkControllerDiscoveredTopologyTerminationPoint

New-NetworkControllerDiscoveredTopologyTerminationPoint

Adds a termination point to the discovered topology.

Syntax

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




Detailed Description

The New-NetworkControllerDiscoveredTopologyTerminationPoint cmdlet adds a termination point to the discovered topology.

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

If the discovered topology does not identify certain termination points on nodes, 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 termination points that are present in the network, but that are not discoverable by the discovery logic. Adding those termination points to the discovered topology lets your script ignore these elements when it displays the differences between the discovered and the actual topology.

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

Specifies the properties of the termination point that this cmdlet adds. You can specify the following properties:

-- AdminStatus. Acceptable values for this property are:

---- 1: up
---- 2: down
---- 3: testing

-- InterfaceIndex.
-- InterfaceName.
-- InterfaceSpeed. Indicates the bitrate, in megabits per second, at which the interface operates.
-- IpConfiguration. The IP configuration, which includes IP address, network prefix, default gateway, VLAN, and whether the IP is statically assigned or by using a DHCP server.
-- IsBMC. Indicates that this is a baseboard management controller (BMC) interface.
-- Mac. The MAC address of the interface.
-- NicTeamName. The name of the team, if the interface is part of a team.
-- OperationalStatus. Acceptable values for this property are:

---- 1: up
---- 2: down
---- 3: testing
---- 4: unknown
---- 5: dormant
---- 6: not present
---- 7: lower layer down

-- PortChannelId. If the termination point represents a port channel on the network switch, this field contains the port channel ID.
-- Type. Acceptable values for this property are:

----6: ethernetCsmacd
---- 24: softwareLoopback
---- 33: rs232
---- 56: fibreChannel
---- 62: fastEther
---- 69: fastEtherFX
---- 75: isdns
---- 76: isdnu
---- 117: gigabitEthernet
---- 160: usb
---- 219: opticalChannelGroup
---- 230: adsl2

-- VlanIds. The array of VLAN IDs that are configured on the termination point.


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 termination point that this cmdlet adds.


Aliases

none

Required?

true

Position?

2

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?

5

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TopologyNodeId<String>

Specifies the topology node where this cmdlet adds a termination point.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

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.

Examples

Example 1: Add termination point to discovered topology

The first command creates a DiscoveredTerminationPointProperties object, and then stores it in the $Interface variable.

The next three commands modify properties of $Interface.

The final command adds a termination point to the topology node that has the specified ID in the discovered topology. The command specifies $Interface as the properties for the termination point. The new termination point has the resource ID Int1.


PS C:\> $Interface = New-Object -TypeName "Microsoft.Windows.NetworkController.DiscoveredTerminationPointProperties"
PS C:\> $Interface.AdminStatus = "1"
PS C:\> $Interface.InterfaceName = "Ethernet1"
PS C:\> $Interface.InterfaceSpeed = "100"
PS C:\> New-NetworkControllerDiscoveredTopologyTerminationPoint -ConnectionUri "https://networkcontroller" -TopologyNodeId "fc284b32-38ba-47d2-a67a-6443d3938bb1" -ResourceId "Int1" -Properties $Interface

Related topics

Community Additions

Show: