ip route¶
Establish static routes
route Specification¶
Parameter Value Type Intermediate Resource Element Name route Element URI /axapi/v3/ip/route Element Attributes route_attributes Partition Visibility shared Schema route schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/ip/route | route_attributes |
route attributes¶
rib-list
Type: List
Reference Object: /axapi/v3/ip/route/rib/{ip-dest-addr}+{ip-mask}
source
Description: source is a JSON Block. Please see below for source
Type: Object
Reference Object: /axapi/v3/ip/route/source
static
Description: static is a JSON Block. Please see below for static
Type: Object
Reference Object: /axapi/v3/ip/route/static
rib-list¶
Specification Value Type list Block object keys ip-dest-addr
Description Destination prefix
Type: string
Format: ipv4-address
ip-mask
Description Destination prefix mask
Type: string
Format: ipv4-netmask-brief
ip-nexthop-ipv4
Type: Listip-nexthop-lif
Type: Listip-nexthop-partition
Type: Listip-nexthop-tunnel
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
rib-list_ip-nexthop-lif¶
Specification Value Type list Block object keys description-nexthop-lif
Description Description for static route
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
lif
Description LIF Interface (Logical tunnel interface name)
Type: string
Maximum Length: 15 characters
Maximum Length: 1 characters
rib-list_ip-nexthop-ipv4¶
Specification Value Type list Block object keys description-nexthop-ip
Description Description for static route
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
distance-nexthop-ip
Description Distance value for this route
Type: number
Range: 1-255
Default: 1
ip-next-hop
Description Forwarding router’s address
Type: string
Format: ipv4-address
rib-list_ip-nexthop-tunnel¶
Specification Value Type list Block object keys description-nexthop-tunnel
Description Description for static route
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
distance-nexthop-tunnel
Description Distance value for this route
Type: number
Range: 1-255
Default: 1
ip-next-hop-tunnel
Description Forwarding router’s address
Type: string
Format: ipv4-address
tunnel
Description Tunnel interface (Tunnel interface number)
Type: number
Range: 1-128
rib-list_ip-nexthop-partition¶
Specification Value Type list Block object keys description-nexthop-partition
Description Description for static route
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
description-partition-vrid
Description Description for static route
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
partition-name
Description Name of network partition
Type: string
Maximum Length: 14 characters
Maximum Length: 1 characters
vrid-num-in-partition
Description Specify ha VRRP-A vrid
Type: number
Range: 0-31
source¶
Specification Value Type object ve-list
Type: List
Reference Object: /axapi/v3/ip/route/source/ve/{ve-num}+{nexthop-ip}
source_ve-list¶
Specification Value Type list Block object keys nexthop-ip
Description Nexthop IP address
Type: string
Format: ipv4-address
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-num
Description
Type: number
Range: 1-4094
static¶
Specification Value Type object bfd-list
Type: List
Reference Object: /axapi/v3/ip/route/static/bfd/{local-ip}+{nexthop-ip}
static_bfd-list¶
Specification Value Type list Block object keys action
Description ‘down’: BFD down; (BFD state)
Type: string
Supported Values: down
local-ip
Description Local IP address
Type: string
Format: ipv4-address
nexthop-ip
Description Nexthop IP address
Type: string
Format: ipv4-address
template
Description Configure tracking template (bind tracking template name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
threshold
Description action triggering threshold
Type: number
Range: 1-255
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters