Get-nsroute

NAME Get-nsroute



SYNOPSIS

The get-nsroute returns all routes as route objects.





SYNTAX

Get-nsroute [[-session] <nitro_service>] [[-filter] <string>] [<CommonParameters>]





DESCRIPTION

The get-nsroute returns one or more routes. Without filter all routes are returned. You can filter by using the

fitler parameter.





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 (ByValue, ByPropertyName)

Accept wildcard characters? false



-filter <string>



Required? false

Position? 1

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.



System.String





OUTPUTS

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





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



get-nsroute



returns all routes

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



get-nsroute -filter "gateway:10.0.1.1"



returns all routes with gateway set to "10.0.1.1"

---------- EXAMPLE 3 ----------



get-nsroute -filter "network:10.0.1.0,gateway:10.0.1.1"



returns all routes for network "10.0.1.0" with gateway set to "10.0.1.1"



RELATED LINKS