Invoke-NSAddRoutemap
SYNOPSIS
Creates a NetScaler routeMap resource.
SYNTAX
Invoke-NSAddRoutemap [-Action] <String> [[-LocalPreference] <String>] [[-Matchaspath] <String>]
[[-MatchcommUnitY] <String>] [[-Matchipaddress] <String>] [[-Matchipnexthop] <String>]
[[-Matchmetric] <String>] [[-MatchrouteType] <String>] [-Name] <String> [[-Routerdynamicrouting] <String>]
[[-Rules] <String>] [-Sequence] <String> [[-Setaspath] <String>] [[-SetcommUnitY] <String>]
[[-Setipnexthop] <String>] [[-Setmetric] <String>] [[-SetmetricType] <String>] [[-Weight] <String>]
[[-Session] <PSObject>] [-IgnoreNotFound] [-ReturnNullOnNotFound] [-ThrowOnWarning] [-PassThru] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Configuration for routeMap resource.
EXAMPLES
EXAMPLE 1
EXAMPLE 2
PARAMETERS
-Action
Specifies if the route-map denies or permits the operations. Possible values: permit, deny
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LocalPreference
Set the BGP local preference path attribute. Minimum value: 0 Maximum value: 4294967295
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Matchaspath
Match the BGP AS-path list.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MatchcommUnitY
Match BGP community list.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Matchipaddress
Match IP address of route. IP access-list number in the range or acces-list name.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Matchipnexthop
Match next-hop address of route. IP access-list number in the range or acces-list name.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Matchmetric
Match values from routing table. Match metric of route. Minimum value: 0 Maximum value: 4294967295
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MatchrouteType
Match OSPF external routes of type 1 or type 2 metrics. Possible values: type-1, type-2
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
Route map tag.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Routerdynamicrouting
The routerDynamicRouting value for the routeMap resource.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Rules
The rules value for the routeMap resource.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Sequence
Sequence to insert to/delete from existing route-map entry. Minimum value: 1 Maximum value: 65535
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Setaspath
Set the prepend string for a BGP AS-path attribute
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SetcommUnitY
Set the BGP community attribute.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Setipnexthop
Set next hop address of a route.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Setmetric
Set metric value for destination routing protocol. Minimum value: 0 Maximum value: 4294967295
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SetmetricType
Set type of metric for destination routing protocol. OSPF external type 1 metric or OSPF external type 2 metric. Possible values: type-1, type-2
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Weight
Set BGP weight for routing table. Minimum value: 0 Maximum value: 4294967295
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Session
The NetScaler session. If omitted, the current default session is used.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: 19
Default value: (Get-NSSession)
Accept pipeline input: False
Accept wildcard characters: False
-IgnoreNotFound
Returns null instead of throwing for known NITRO not-found responses.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ReturnNullOnNotFound
Returns null instead of throwing for known NITRO not-found responses.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ThrowOnWarning
Treats NITRO warning responses as terminating errors.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-PassThru
Returns the updated resource after the operation completes.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
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
System.Management.Automation.PSCustomObject
NOTES
Generated from NetScaler NITRO API metadata. Generated: 2026-06-01 21:28 Supported metadata versions: 13.1, 14.1.