Skip to content

Update get-networkcontrollerroute.md #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 30, 2017
Merged

Update get-networkcontrollerroute.md #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions docset/windows/network-controller/get-networkcontrollerroute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

```
Expand All @@ -29,13 +29,19 @@ Get-NetworkControllerRoute [-RouteTableId] <String[]> [[-ResourceId] <String[]>]
```

## 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)
Expand 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)
Expand 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)
Expand All @@ -88,6 +98,8 @@ Accept wildcard characters: False
```

### -ResourceId
Sepcifies the unique identifier for the Route.

```yaml
Type: String[]
Parameter Sets: (All)
Expand All @@ -101,6 +113,8 @@ Accept wildcard characters: False
```

### -RouteTableId
Sepcifies the route table where the route belongs.

```yaml
Type: String[]
Parameter Sets: (All)
Expand 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

Expand Down