Invoke ADCGetRoute - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCGetRoute

SYNOPSIS

Get Network configuration object(s).

SYNTAX

GetAll (Default)

Invoke-ADCGetRoute [-Filter <Hashtable>] [-GetAll] [-ViewSummary] [<CommonParameters>]

GetByArgument

Invoke-ADCGetRoute [-Network <String>] [-Netmask <String>] [-Gateway <String>] [-Vlan <Double>] [-Td <Double>]
 [-Routetype <String>] [-Detail <Boolean>] [-Filter <Hashtable>] [<CommonParameters>]

Count

Invoke-ADCGetRoute [-Count] [-Filter <Hashtable>] [<CommonParameters>]

DESCRIPTION

Configuration for route resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCGetRoute

Get data.

EXAMPLE 2

Invoke-ADCGetRoute -GetAll

Get all route data.

EXAMPLE 3

Invoke-ADCGetRoute -Count

Get the number of route objects.

EXAMPLE 4

Invoke-ADCGetRoute -name <string>

Get route object by specifying for example the name.

EXAMPLE 5

Invoke-ADCGetRoute -Filter @{ 'name'='<value>' }

Get route data with a filter.

PARAMETERS

-Network

IPv4 network address for which to add a route entry in the routing table of the Citrix ADC.

Type: String
Parameter Sets: GetByArgument
Aliases:

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

-Netmask

The subnet mask associated with the network address.

Type: String
Parameter Sets: GetByArgument
Aliases:

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

-Gateway

IP address of the gateway for this route. Can be either the IP address of the gateway, or can be null to specify a null interface route.

Type: String
Parameter Sets: GetByArgument
Aliases:

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

-Vlan

VLAN as the gateway for this route.

Type: Double
Parameter Sets: GetByArgument
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Td

Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0.

Type: Double
Parameter Sets: GetByArgument
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Routetype

Protocol used by routes that you want to remove from the routing table of the Citrix ADC. Possible values = CONNECTED, STATIC, DYNAMIC, OSPF, ISIS, RIP, BGP

Type: String
Parameter Sets: GetByArgument
Aliases:

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

-Detail

Display a detailed view.

Type: Boolean
Parameter Sets: GetByArgument
Aliases:

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

-Count

If specified, the count of the route object(s) will be returned.

Type: SwitchParameter
Parameter Sets: Count
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Specify a filter. -Filter @{ 'name'='<value>' }

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: @{ }
Accept pipeline input: False
Accept wildcard characters: False

-GetAll

Retrieve all route object(s).

Type: SwitchParameter
Parameter Sets: GetAll
Aliases:

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

-ViewSummary

When specified, only a summary of information is returned.

Type: SwitchParameter
Parameter Sets: GetAll
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

File Name : Invoke-ADCGetRoute Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/network/route/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.

RELATED LINKS

https://blog.j81.nl

⚠️ **GitHub.com Fallback** ⚠️