New-NetworkControllerFabricRoute

  • Reference
Module:
NetworkController

Adds a route to a network subnet in the Network Controller

Syntax

New-NetworkControllerFabricRoute
   [-LogicalNetworkId] <String>
   [-SubnetId] <String>
   [-ResourceId] <String>
   [-Properties] <FabricRouteProperties>
   [[-ResourceMetadata] <ResourceMetadata>]
   [[-Etag] <String>]
   [-Force]
   -ConnectionUri <Uri>
   [-CertificateThumbprint <String>]
   [-Credential <PSCredential>]
   [-PassInnerException]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-NetworkControllerFabricRoute cmdlet adds a route to a network subnet in the Network Controller. To add a route, provide the route destination and the next hop address.

Examples

Example 1: Add a route

PS C:\> $Route = New-Object Microsoft.Windows.NetworkController.FabricRouteProperties
PS C:\> $Route.Destination = "10.0.0.1/24"
PS C:\> $Route.nextHop = "10.0.0.1"
PS C:\> New-NetworkControllerFabricRoute -ConnectionUri "https://networkcontroller" -LogicalNetworkId "Network13" -SubnetId "Subnet01" -ResourceId "Route21" -Properties $Route

The first command creates a FabricRouteProperties object by using the New-Object cmdlet. The command stores the object in the $Route variable.

The next two commands assign values to the Destination and nextHop properties of $Route.

The final command adds a route to the logical network that has the ID Network13 in the subnet that has the ID Subnet01. The route has the properties specified in $Route.

Parameters

-CertificateThumbprint

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.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionUri

Specifies the Uniform Resource Identifier (URI) of the Network Controller. All Representational State Transfer (REST) clients use this URI to connect to Network Controller.

Type:Uri
Position:Named
Default value:None
Required:True
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 specified in the ClientSecurityGroup parameter in Install-NetworkController.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Etag

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. The value of the header is an opaque string that represents the state of the resource when the response was generated.

Type:String
Position:7
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:8
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LogicalNetworkId

Specifies the ID of the logical network to which this cmdlet adds a route.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PassInnerException

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.

The thumbprint must be provided only if the network controller client authentication is X509 certificates. Get-NetworkController retrieves that client authentication and authorization information.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Properties

Specifies the properties of the route that this cmdlet adds. You must specify destination subnet and next hop address properties.

Type:FabricRouteProperties
Position:4
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

Specifies the resource ID of the route that this cmdlet adds.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceMetadata

Specifies metadata information for the client, such as the tenant ID, group ID, and resource name.

Type:ResourceMetadata
Position:5
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubnetId

Specifies the ID of the subnet to which this cmdlet adds a route.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Microsoft.Windows.NetworkController.FabricRouteProperties

Outputs

Object