Data ONTAP® PowerShell Toolkit

Switch to clustered Data ONTAP documentation.

Cmdlet: Add-NaNetRoute


NAME
Add-NaNetRoute

SYNOPSIS
Create a new kernel route.

SYNTAX
Add-NaNetRoute [-Destination] <String> [-Gateway] <String> [-Metric] <UInt16
> [-Host] [-Ipspace <String>] [-Creator <String>] [-ActiveOnly] [-Controller
<NaController>] [<CommonParameters>]

Add-NaNetRoute [-Destination] <String> [-Gateway] <String> [-Metric] <UInt16
> -IPv6 [-Host] [-PrefixLength <UInt16>] [-Ipspace <String>] [-Creator <Stri
ng>] [-ActiveOnly] [-Controller <NaController>] [<CommonParameters>]

Add-NaNetRoute [-Host] [-Ipspace <String>] [-Creator <String>] -Route <Route
Info> [-ActiveOnly] [-Controller <NaController>] [<CommonParameters>]


DESCRIPTION
Create a new kernel route. Modifies active and persistent config.


PARAMETERS
-Destination <String>
Destination of route. Possible values: An IP address, hostname, or "def
ault".

Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Gateway <String>
Next hop (router) IP address.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Metric <UInt16>
The number of hops to the destination. If the route is to a destination
via a gateway, the metric parameter should be greater than 0. If metri
c is set to 0, the gateway given is the address of this host on the comm
on network, indicating the interface to be used for transmission. Range
: 0-10.

Required? true
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Host
Specify to create a route to a specific host instead of a network (subne
t) route.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Ipspace <String>
The ipspace of the route. If not specified, the value used is "default-
ipspace".

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Creator <String>
The vfiler that will own this route. If not specified, the default is v
filer0 (i.e. the physical controller).

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-ActiveOnly
If specified, only the active config is modified.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Controller <NaController>
The Data ONTAP controller object, embodied by an NaController object. T
his parameter is returned by the Connect-NaController cmdlet. If not sp
ecified, the value in the global variable CurrentNaController is used.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-IPv6
Specify to create an IPv6 route.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-PrefixLength <UInt16>
Prefix length (netmask) for destination. Specify only for IPv6 routes.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Route <RouteInfo>
A route object as returned by Get-NaNetRoute.

Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
DataONTAP.Types.Net.RouteInfo


NOTES


Category: net
API: net-route-add

-------------- Example 1 --------------

C:\PS>Add-NaNetRoute default 40.40.40.1 1 -Ipspace testspace -Creator vfiler
4


Create a new default route for vfiler 'vfiler4'.


Destination : 10.61.165.80
RouteType : host
Prefixlen : 32
NextHop : 40.40.40.1
Metric : 1
AddrFamily : af-inet
Creator : vfiler:vfiler4
IpspaceName : testspace


-------------- Example 2 --------------

C:\PS>Add-NaNetRoute 10.61.165.0 10.61.165.1 1


Add a subnet route in the default ipspace.


Destination : 10.61.165
RouteType : net
Prefixlen : 24
NextHop : 10.61.165.1
Metric : 1
AddrFamily : af-inet
Creator : vfiler:vfiler0
IpspaceName : default-ipspace


-------------- Example 3 --------------

C:\PS>Add-NaNetRoute -IPv6 default 3ffe:1900:4545:3:200:f8ff:fe21:67ce 1 -Pr
efixLength 64


Add a default IPv6 route.


Destination : default
RouteType : net
Prefixlen :
NextHop : 3ffe:1900:4545:3:200:f8ff:fe21:67ce
Metric : 1
AddrFamily : af-inet6
Creator : vfiler:vfiler0
IpspaceName : default-ipspace


-------------- Example 4 --------------

C:\PS>Add-NaNetRoute -Host 10.10.10.25 10.61.167.1 1


Add a route to a specific host.


Destination : 10.10.10.25
RouteType : host
Prefixlen : 32
NextHop : 10.61.167.1
Metric : 1
AddrFamily : af-inet
Creator : vfiler:vfiler0
IpspaceName : default-ipspace



RELATED LINKS
Get-NaNetRoute
Remove-NaNetRoute







 Data ONTAP® PowerShell Toolkit