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 None Schema route schema
Operations 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: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 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
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 local-ip
Description Local IP address
Type: string
Format: ipv4-address
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