< Back

Set-NSroute

Sat Jan 11, 2020 1:36 am

NAME Set-NSroute



SYNOPSIS

The set-nsroute allows you to change settings about a route.





SYNTAX

Set-NSroute [[-session] <nitro_service>] [[-routeToSet] <route[]>] [<CommonParameters>]



Set-NSroute [[-session] <nitro_service>] [[-filter] <string>] [[-gateway] <string>] [<CommonParameters>]





DESCRIPTION

Use set-nsroute to submit changes to existing routes. The command either gets a filter to match a single route, or

gets a route object with modification.





PARAMETERS

-session <nitro_service>

This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and

pipelined into this command.



Required? false

Position? 0

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-routeToSet <route[]>

Specify the route to set. Route must be specied as an object (or array of objects).



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-filter <string>

Specify a filter that will return only one result.



Required? false

Position? 2

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-gateway <string>

Specify the new gateway for this route.



Required? false

Position? 3

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

com.citrix.netscaler.nitro.service.nitro_service

This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and

pipelined into this command.



com.citrix.netscaler.nitro.resource.config.network.route[]

Specify the route to set. Route must be specied as an object (or array of objects).



System.String

Specify a filter that will return only one result.



System.String

Specify the new gateway for this route.





OUTPUTS



---------- EXAMPLE 1 ----------



set-nsroute -route $route



submits changes made to the $route object. Use get-nsroute to get the $route object.

---------- EXAMPLE 2 ----------



set-nsroute -filter "network:10.0.1.0",netmask:255.255.255.0" -gateway "10.2.3.4"



Change the gateway for network 10.0.1.0/255.255.255.0



RELATED LINKS