Get-NetworkControllerRoute

This cmdlet retrieves a route from a particular route table in the Network Controller

Syntax

Get-NetworkControllerRoute
   [-RouteTableId] <String[]>
   [[-ResourceId] <String[]>]
   -ConnectionUri <Uri>
   [-CertificateThumbprint <String>]
   [-Credential <PSCredential>]
   [-PassInnerException]
   [<CommonParameters>]

Description

This cmdlet retrieves a route from a particular route table in the Network Controller. If you want to route traffic to virtual appliances in your environment, you can specify routes and associate them to a virtual subnet. Subnets rely on system routes until a route table is associated to the subnet. After an association exists, priority is given to user defined routes.

Examples

Example 1

This example retrieves all routes from the route table named Table1, in the Network Controller.

Get-NetworkControllerRoute -ConnectionUri https://networkcontroller -RouteTableId "Table1"

Required Parameters

-ConnectionUri

Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.

Type:Uri
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RouteTableId

Sepcifies the route table where the route belongs.

Type:String[]
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-CertificateThumbprint

Specifies the digital public key X.509 certificate of a user account that has permission to perform this action.This is the certificate thumbprint of the certificate.This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Specifies a user credential that has permission to perform this action.The default value is the current user.This user must be present in the security group provided in the ClientSecurityGroup parameter in the Install-NetworkController cmdlet.

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassInnerException
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceId

Sepcifies the unique identifier for the Route.

Type:String[]
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Following route properties can be retrieved:

  1. Address prefix of the route
  2. Next hop type of the route
  3. Next hop IP address of the route