Invoke-NSAddBgprouter
SYNOPSIS
Creates a NetScaler bgpRouter resource.
SYNTAX
Invoke-NSAddBgprouter [[-Activate] <String>] [[-Address] <String>] [[-Addressfamily] <String>]
[[-AdvertisementInterval] <String>] [[-Afparams] <String>] [[-AsoriginationInterval] <String>]
[[-ConnEcttimer] <String>] [[-Direction] <String>] [[-Holdtimerconfig] <String>]
[[-Keepalivetimerconfig] <String>] [-LocalAs] <String> [[-Md5password] <String>] [[-MultiHopbfd] <String>]
[[-Name] <String>] [[-Neighbor] <String>] [[-Protocol] <String>] [[-Redistribute] <String>]
[[-Remoteas] <String>] [[-Routemap] <String>] [[-Routerdynamicrouting] <String>] [[-Routerid] <String>]
[[-Singlehopbfd] <String>] [[-TCPMss] <String>] [[-Updatesource] <String>] [[-Session] <PSObject>]
[-IgnoreNotFound] [-ReturnNullOnNotFound] [-ThrowOnWarning] [-PassThru] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Configuration for bgpRouter resource.
EXAMPLES
EXAMPLE 1
EXAMPLE 2
PARAMETERS
-Activate
Enable the Address Family for the neighbor.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Address
The ipv4 or ipv6 address of the neighboring router.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Addressfamily
Address family of the routes. Possible values: ipv4, ipv6
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AdvertisementInterval
Minimum interval between sending BGP routing updates. Minimum value: 0 Maximum value: 65535
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Afparams
The afParams value for the bgpRouter resource.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AsoriginationInterval
Minimum interval between sending AS-origination routing updates. Minimum value: 1 Maximum value: 65535
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ConnEcttimer
Time interval (in seconds) for the ConnectRetry timer. Minimum value: 1 Maximum value: 65535
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Direction
Apply the route-map to incoming routes or outgoing routes. Possible values: in, out
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Holdtimerconfig
Configured hold time for the neighbor. Minimum value: 0 Maximum value: 65535
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Keepalivetimerconfig
Configured keepalive time for the neighbor. Minimum value: 0 Maximum value: 65535
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-LocalAs
Autonomous system number. Minimum value: 1 Maximum value: 4294967295
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Md5password
MD5 password for the neighbor.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MultiHopbfd
Enable BFD for multihop session
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name
Name of the route-map.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Neighbor
The neighbor value for the bgpRouter resource.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Protocol
The protocol from which routes need to be redistributed. Possible values: kernel, connected, static, rip, ospf, isis, intranet
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Redistribute
The redistribute value for the bgpRouter resource.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Remoteas
AS number of the neighbor. Minimum value: 1 Maximum value: 4294967295
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Routemap
Route map reference
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 19
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Routerdynamicrouting
The routerDynamicRouting value for the bgpRouter resource.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 20
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Routerid
The router identifier for the bgp routing instance.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 21
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Singlehopbfd
Enable BFD on this neighbor
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 22
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TCPMss
TCP maximum segment size Minimum value: 1 Maximum value: 65535
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 23
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Updatesource
Source of routing updates.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 24
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: 25
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.