From 57ada64db8e0b967ddd67d9ca028ba19fd1b7c45 Mon Sep 17 00:00:00 2001 From: Anirban Paul Date: Wed, 29 Mar 2017 11:00:03 -0700 Subject: [PATCH] Update get-networkcontrollerroute.md Added descriptions and example --- .../get-networkcontrollerroute.md | 22 +++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/docset/windows/network-controller/get-networkcontrollerroute.md b/docset/windows/network-controller/get-networkcontrollerroute.md index 88550572a4..83c85e68f2 100644 --- a/docset/windows/network-controller/get-networkcontrollerroute.md +++ b/docset/windows/network-controller/get-networkcontrollerroute.md @@ -20,7 +20,7 @@ ms.assetid: B12297B2-FBA9-4251-8534-0DCE3AFF5CBB # Get-NetworkControllerRoute ## SYNOPSIS - +This cmdlet retrieves a route from a particular route table in the Network Controller ## SYNTAX ``` @@ -29,13 +29,19 @@ Get-NetworkControllerRoute [-RouteTableId] [[-ResourceId] ] ``` ## 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 - +This example retrieves all routes from the route table named Table1, in the Network Controller. +``` +Get-NetworkControllerRoute -ConnectionUri https://networkcontroller -RouteTableId "Table1" +``` ## 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. + ```yaml Type: String Parameter Sets: (All) @@ -49,6 +55,8 @@ Accept wildcard characters: False ``` ### -ConnectionUri +Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller. + ```yaml Type: Uri Parameter Sets: (All) @@ -62,6 +70,8 @@ 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. + ```yaml Type: PSCredential Parameter Sets: (All) @@ -88,6 +98,8 @@ Accept wildcard characters: False ``` ### -ResourceId +Sepcifies the unique identifier for the Route. + ```yaml Type: String[] Parameter Sets: (All) @@ -101,6 +113,8 @@ Accept wildcard characters: False ``` ### -RouteTableId +Sepcifies the route table where the route belongs. + ```yaml Type: String[] Parameter Sets: (All) @@ -119,6 +133,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ## 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 ## NOTES