router ipv6¶
IPv6 information
ipv6 Specification¶
Parameter Value Type Intermediate Resource Element Name ipv6 Element URI /axapi/v3/router/ipv6 Element Attributes ipv6_attributes Partition Visibility shared Schema ipv6 schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/router/ipv6 | ipv6_attributes |
ipv6 attributes¶
ospf-list
Type: List
Reference Object: /axapi/v3/router/ipv6/ospf/{process-id}
rip
Description: rip is a JSON Block. Please see below for rip
Type: Object
Reference Object: /axapi/v3/router/ipv6/rip
ospf-list¶
Specification Value Type list Block object keys abr-type-option
Description ‘cisco’: Alternative ABR, Cisco implementation (RFC3509); ‘ibm’: Alternative ABR, IBM implementation (RFC3509); ‘standard’: Standard behavior (RFC2328);
Type: string
Supported Values: cisco, ibm, standard
Default: cisco
area-list
Type: List
Reference Object: /axapi/v3/router/ipv6/ospf/{process-id}/area/{area-ipv4}+{area-num}
auto-cost-reference-bandwidth
Description Use reference bandwidth method to assign OSPF cost (The reference bandwidth in terms of Mbits per second)
Type: number
Range: 1-4294967
Default: 10000
bfd-all-interfaces
Description Enable BFD on all interfaces
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
default-information
Description: default-information is a JSON Block. Please see below for ospf-list_default-information
Type: Object
Reference Object: /axapi/v3/router/ipv6/ospf/{process-id}/default-information
default-metric
Description Set metric of redistributed routes (Default metric)
Type: number
Range: 1-16777214
Default: 20
distribute-internal-list
Type: Listdistribute-list
Description: distribute-list is a JSON Block. Please see below for ospf-list_distribute-list
Type: Object
ha-standby-extra-cost
Type: Listlog-adjacency-changes
Description ‘detail’: Log changes in adjacency state; ‘disable’: Disable logging;
Type: string
Supported Values: detail, disable
max-concurrent-dd
Description Maximum number allowed to process DD concurrently (Number of DD process)
Type: number
Range: 1-65535
Default: 5
passive-interface
Description: passive-interface is a JSON Block. Please see below for ospf-list_passive-interface
Type: Object
process-id
Description OSPFv3 process tag
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Default: 0
redistribute
Description: redistribute is a JSON Block. Please see below for ospf-list_redistribute
Type: Object
Reference Object: /axapi/v3/router/ipv6/ospf/{process-id}/redistribute
router-id
Description router-id for the OSPF process (OSPFv3 router-id in IPv4 address format)
Type: string
Format: ipv4-address
timers
Description: timers is a JSON Block. Please see below for ospf-list_timers
Type: Object
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ospf-list_distribute-internal-list¶
Specification Value Type list Block object keys area-ipv4
Description OSPF area ID in IP address format
Type: string
Format: ipv4-address
Default: 255.255.255.255
area-num
Description OSPF area ID as a decimal value
Type: number
Range: 0-4294967295
cost
Description Cost
Type: number
Range: 1-65535
Default: 1
type
Description ‘lw4o6’: LW4O6 Prefix; ‘nat64’: NAT64 Prefix; ‘static-nat’: Static NAT; ‘floating-ip’: Floating IP; ‘ip-nat’: IP NAT; ‘ip-nat-list’: IP NAT list; ‘vip’: Only not flagged Virtual IP (VIP); ‘vip-only-flagged’: Selected Virtual IP (VIP);
Type: string
Supported Values: lw4o6, nat64, static-nat, floating-ip, ip-nat, ip-nat-list, vip, vip-only-flagged
ospf-list_redistribute¶
Specification Value Type object ip-nat
Description IP-NAT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ip-nat-floating-list
Type: Listmetric-ip-nat
Description OSPFV3 default metric (OSPFV3 metric)
Type: number
Range: 0-16777214
metric-type-ip-nat
Description ‘1’: Set OSPFV3 External Type 1 metrics; ‘2’: Set OSPFV3 External Type 2 metrics;
Type: string
Supported Values: 1, 2
Default: 2
ospf-list
Type: Listredist-list
Type: Listroute-map-ip-nat
Description Route map reference (Pointer to route-map entries)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vip-floating-list
Type: Listvip-list
Type: List
ospf-list_redistribute_redist-list¶
Specification Value Type list Block object keys metric
Description OSPFV3 default metric (OSPFV3 metric)
Type: number
Range: 0-16777214
metric-type
Description ‘1’: Set OSPFV3 External Type 1 metrics; ‘2’: Set OSPFV3 External Type 2 metrics;
Type: string
Supported Values: 1, 2
Default: 2
route-map
Description Route map reference (Pointer to route-map entries)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
type
Description ‘bgp’: Border Gateway Protocol (BGP); ‘connected’: Connected; ‘floating-ip’: Floating IP; ‘ip-nat-list’: IP NAT list; ‘nat-map’: NAT MAP Prefix; ‘static-nat’: Static NAT; ‘nat64’: NAT64 Prefix; ‘lw4o6’: LW4O6 Prefix; ‘isis’: ISO IS-IS; ‘rip’: Routing Information Protocol (RIP); ‘static’: Static routes;
Type: string
Supported Values: bgp, connected, floating-ip, ip-nat-list, nat-map, static-nat, nat64, lw4o6, isis, rip, static
ospf-list_redistribute_ospf-list¶
Specification Value Type list Block object keys metric-ospf
Description OSPFV3 default metric (OSPFV3 metric)
Type: number
Range: 0-16777214
metric-type-ospf
Description ‘1’: Set OSPFV3 External Type 1 metrics; ‘2’: Set OSPFV3 External Type 2 metrics;
Type: string
Supported Values: 1, 2
Default: 2
ospf
Description Open Shortest Path First (OSPF)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
process-id
Description OSPFV3 process tag
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
route-map-ospf
Description Route map reference (Pointer to route-map entries)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
ospf-list_redistribute_ip-nat-floating-list¶
Specification Value Type list Block object keys ip-nat-floating-IP-forward
Description Floating-IP as forward address
Type: string
Format: ipv6-address
ip-nat-prefix
Description Address
Type: string
Format: ipv6-address-plen
ospf-list_redistribute_vip-list¶
Specification Value Type list Block object keys metric-type-vip
Description ‘1’: Set OSPFV3 External Type 1 metrics; ‘2’: Set OSPFV3 External Type 2 metrics;
Type: string
Supported Values: 1, 2
Default: 2
metric-vip
Description OSPFV3 default metric (OSPFV3 metric)
Type: number
Range: 0-16777214
route-map-vip
Description Route map reference (Pointer to route-map entries)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
type-vip
Description ‘only-flagged’: Selected Virtual IP (VIP); ‘only-not-flagged’: Only not flagged;
Type: string
Supported Values: only-flagged, only-not-flagged
ospf-list_redistribute_vip-floating-list¶
Specification Value Type list Block object keys vip-address
Description Address
Type: string
Format: ipv6-address
vip-floating-IP-forward
Description Floating-IP as forward address
Type: string
Format: ipv6-address
ospf-list_distribute-list¶
Specification Value Type object prefix-list
Description: prefix-list is a JSON Block. Please see below for ospf-list_distribute-list_prefix-list
Type: Object
ospf-list_distribute-list_prefix-list¶
Specification Value Type object direction
Description ‘in’: Filter incoming routing updates;
Type: string
Supported Values: in
value
Description Prefix-list name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
ospf-list_area-list¶
Specification Value Type list Block object keys area-ipv4
Description OSPFv3 area ID in IP address format
Type: string
Format: ipv4-address
area-num
Description OSPFv3 area ID as a decimal value
Type: number
Range: 0-4294967295
default-cost
Description Set the summary-default cost of a NSSA or stub area (Stub’s advertised default summary cost)
Type: number
Range: 0-16777215
Default: 1
no-summary
Description Do not inject inter-area routes into area
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
range-list
Type: Liststub
Description Configure OSPFv3 area as stub
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
virtual-link-list
Type: List
ospf-list_area-list_virtual-link-list¶
Specification Value Type list Block object keys bfd
Description Bidirectional Forwarding Detection (BFD)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dead-interval
Description Dead router detection time (Seconds)
Type: number
Range: 1-65535
hello-interval
Description Hello packet interval (Seconds)
Type: number
Range: 1-65535
instance-id
Description OSPFv3 instance ID
Type: number
Range: 0-255
Default: 0
retransmit-interval
Description LSA retransmit interval (Seconds)
Type: number
Range: 1-3600
transmit-delay
Description LSA transmission delay (Seconds)
Type: number
Range: 1-3600
Default: 1
value
Description ID (IP addr) associated with virtual link neighbor
Type: string
Format: ipv4-address
ospf-list_area-list_range-list¶
Specification Value Type list Block object keys option
Description ‘advertise’: Advertise this range (default); ‘not-advertise’: DoNotAdvertise this range;
Type: string
Supported Values: advertise, not-advertise
value
Description Area range for IPv6 prefix
Type: string
Format: ipv6-address-plen
ospf-list_default-information¶
Specification Value Type object always
Description Always advertise default route
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
metric
Description OSPF default metric (OSPF metric)
Type: number
Range: 0-16777214
metric-type
Description OSPF metric type for default routes
Type: number
Range: 1-2
Default: 2
originate
Description Distribute a default route
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
route-map
Description Route map reference (Pointer to route-map entries)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ospf-list_passive-interface¶
Specification Value Type object eth-cfg
Type: Listloopback-cfg
Type: Listtrunk-cfg
Type: Listtunnel-cfg
Type: Listve-cfg
Type: List
ospf-list_passive-interface_tunnel-cfg¶
Specification Value Type list Block object keys tunnel
Description Tunnel interface (Tunnel interface number)
Type: number
Format: interface
ospf-list_passive-interface_ve-cfg¶
Specification Value Type list Block object keys ve
Description Virtual ethernet interface (Virtual ethernet interface number)
Type: number
Format: interface
ospf-list_passive-interface_trunk-cfg¶
Specification Value Type list Block object keys trunk
Description Trunk interface (Trunk interface number)
Type: number
Format: interface
ospf-list_passive-interface_loopback-cfg¶
Specification Value Type list Block object keys loopback
Description Loopback interface (Port number)
Type: number
Format: interface
ospf-list_passive-interface_eth-cfg¶
Specification Value Type list Block object keys ethernet
Description Ethernet interface (Port number)
Type: number
Format: interface
ospf-list_timers¶
Specification Value Type object spf
Description: spf is a JSON Block. Please see below for ospf-list_timers_spf
Type: Object
ospf-list_timers_spf¶
Specification Value Type object exp
Description: exp is a JSON Block. Please see below for ospf-list_timers_spf_exp
Type: Object
ospf-list_timers_spf_exp¶
Specification Value Type object max-delay
Description Maximum delay between receiving a change to SPF calculation in milliseconds
Type: number
Range: 0-2147483647
Default: 50000
min-delay
Description Minimum delay between receiving a change to SPF calculation in milliseconds
Type: number
Range: 0-2147483647
Default: 500
ospf-list_ha-standby-extra-cost¶
Specification Value Type list Block object keys extra-cost
Description The extra cost value
Type: number
Range: 1-65535
group
Description Group (Group ID)
Type: number
Range: 0-31
rip¶
Specification Value Type object aggregate-address-cfg
Type: Listcisco-metric-behavior
Description ‘enable’: Enables updating metric consistent with Cisco; ‘disable’: Disables updating metric consistent with Cisco; (Enable/Disable updating metric consistent with Cisco)
Type: string
Supported Values: enable, disable
Default: disable
default-information
Description ‘originate’: originate; (Distribute default route)
Type: string
Supported Values: originate
default-metric
Description Set a metric of redistribute routes (Default metric)
Type: number
Range: 1-16
Default: 1
distribute-list
Description: distribute-list is a JSON Block. Please see below for rip_distribute-list
Type: Object
Reference Object: /axapi/v3/router/ipv6/rip/distribute-list
offset-list
Description: offset-list is a JSON Block. Please see below for rip_offset-list
Type: Object
Reference Object: /axapi/v3/router/ipv6/rip/offset-list
passive-interface-list
Type: Listrecv-buffer-size
Description Set the RIPNG UDP receive buffer size (the RIPNG UDP receive buffer size value)
Type: number
Range: 8192-2147483647
redistribute
Description: redistribute is a JSON Block. Please see below for rip_redistribute
Type: Object
Reference Object: /axapi/v3/router/ipv6/rip/redistribute
ripng-neighbor
Description: ripng-neighbor is a JSON Block. Please see below for rip_ripng-neighbor
Type: Object
route-cfg
Type: Listroute-map
Description: route-map is a JSON Block. Please see below for rip_route-map
Type: Object
Reference Object: /axapi/v3/router/ipv6/rip/route-map
timers
Description: timers is a JSON Block. Please see below for rip_timers
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
rip_offset-list¶
Specification Value Type object acl-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
rip_offset-list_acl-cfg¶
Specification Value Type list Block object keys acl
Description Access-list name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
ethernet
Description Ethernet interface (Port number)
Type: number
Format: interface
loopback
Description Loopback interface (Port number)
Type: number
Format: interface
metric
Description Metric value
Type: number
Range: 0-16
offset-list-direction
Description ‘in’: Filter incoming updates; ‘out’: Filter outgoing updates;
Type: string
Supported Values: in, out
trunk
Description Trunk interface (Trunk interface number)
Type: number
Format: interface
tunnel
Description Tunnel interface (Tunnel interface number)
Type: number
Format: interface
ve
Description Virtual ethernet interface (Virtual ethernet interface number)
Type: number
Format: interface
rip_route-map¶
Specification Value Type object map-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
rip_route-map_map-cfg¶
Specification Value Type list Block object keys ethernet
Description Ethernet interface (Port number)
Type: number
Format: interface
loopback
Description Loopback interface (Port number)
Type: number
Format: interface
map
Description Route map name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
route-map-direction
Description ‘in’: Route map set for input filtering; ‘out’: Route map set for output filtering;
Type: string
Supported Values: in, out
trunk
Description Trunk interface (Trunk interface number)
Type: number
Format: interface
tunnel
Description Tunnel interface (Tunnel interface number)
Type: number
Format: interface
ve
Description Virtual ethernet interface (Virtual ethernet interface number)
Type: number
Format: interface
rip_passive-interface-list¶
Specification Value Type list Block object keys ethernet
Description Ethernet interface (Port number)
Type: number
Format: interface
loopback
Description Loopback interface (Port number)
Type: number
Format: interface
trunk
Description Trunk interface (Trunk interface number)
Type: number
Format: interface
tunnel
Description Tunnel interface (Tunnel interface number)
Type: number
Format: interface
ve
Description Virtual ethernet interface (Virtual ethernet interface number)
Type: number
Format: interface
rip_redistribute¶
Specification Value Type object redist-list
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vip-list
Type: List
rip_redistribute_vip-list¶
Specification Value Type list Block object keys vip-metric
Description Metric for redistributed routes (metric value)
Type: number
Range: 0-16
vip-route-map
Description Route map reference (Pointer to route-map entries)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
vip-type
Description ‘only-flagged’: Selected Virtual IP (VIP); ‘only-not-flagged’: Only not flagged;
Type: string
Supported Values: only-flagged, only-not-flagged
rip_redistribute_redist-list¶
Specification Value Type list Block object keys metric
Description Metric for redistributed routes (metric value)
Type: number
Range: 0-16
route-map
Description Route map reference (Pointer to route-map entries)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
type
Description ‘bgp’: Border Gateway Protocol (BGP); ‘connected’: Connected; ‘floating-ip’: Floating IP; ‘ip-nat-list’: IP NAT list; ‘ip-nat’: IP NAT; ‘isis’: ISO IS-IS; ‘lw4o6’: LW4O6 Prefix; ‘nat-map’: NAT MAP Prefix; ‘nat64’: NAT64 Prefix; ‘static-nat’: Static NAT; ‘ospf’: Open Shortest Path First (OSPF); ‘static’: Static routes;
Type: string
Supported Values: bgp, connected, floating-ip, ip-nat-list, ip-nat, isis, lw4o6, nat-map, nat64, static-nat, ospf, static
rip_route-cfg¶
Specification Value Type list Block object keys route
Description Static route advertisement (debugging purpose) (IP prefix)
Type: string
Format: ipv6-address-plen
rip_timers¶
Specification Value Type object timers-cfg
Description: timers-cfg is a JSON Block. Please see below for rip_timers_timers-cfg
Type: Object
rip_timers_timers-cfg¶
Specification Value Type object basic
Description Basic routing protocol update timers (Routing table update timer value in second. Default is 30)
Type: number
Range: 5-2147483647
val-2
Description Routing information timeout timer. Default is 180
Type: number
Range: 5-2147483647
val-3
Description Garbage collection timer. Default is 120
Type: number
Range: 5-2147483647
rip_aggregate-address-cfg¶
Specification Value Type list Block object keys aggregate-address
Description Set aggregate RIP route announcement (Aggregate network)
Type: string
Format: ipv6-address-plen
rip_ripng-neighbor¶
Specification Value Type object ripng-neighbor-cfg
Type: List
rip_ripng-neighbor_ripng-neighbor-cfg¶
Specification Value Type list Block object keys ethernet
Description Ethernet interface (Port number)
Type: number
Format: interface
loopback
Description Loopback interface (Port number)
Type: number
Format: interface
neighbor-link-local-addr
Description IPv6 link-local address
Type: string
Format: ipv6-address
trunk
Description Trunk interface (Trunk interface number)
Type: number
Format: interface
tunnel
Description Tunnel interface (Tunnel interface number)
Type: number
Format: interface
ve
Description Virtual ethernet interface (Virtual ethernet interface number)
Type: number
Format: interface
rip_distribute-list¶
Specification Value Type object acl-cfg
Type: Listprefix
Description: prefix is a JSON Block. Please see below for rip_distribute-list_prefix
Type: Object
Reference Object: /axapi/v3/router/ipv6/rip/distribute-list/prefix
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
rip_distribute-list_acl-cfg¶
Specification Value Type list Block object keys acl
Description Access-list name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
acl-direction
Description ‘in’: Filter incoming routing updates; ‘out’: Filter outgoing routing updates;
Type: string
Supported Values: in, out
ethernet
Description Ethernet interface (Port number)
Type: number
Format: interface
loopback
Description Loopback interface (Port number)
Type: number
Format: interface
trunk
Description Trunk interface (Trunk interface number)
Type: number
Format: interface
tunnel
Description Tunnel interface (Tunnel interface number)
Type: number
Format: interface
ve
Description Virtual ethernet interface (Virtual ethernet interface number)
Type: number
Format: interface
rip_distribute-list_prefix¶
Specification Value Type object prefix-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
rip_distribute-list_prefix_prefix-cfg¶
Specification Value Type list Block object keys ethernet
Description Ethernet interface (Port number)
Type: number
Format: interface
loopback
Description Loopback interface (Port number)
Type: number
Format: interface
prefix-list
Description Filter prefixes in routing updates (Name of a prefix list)
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
prefix-list-direction
Description ‘in’: Filter incoming routing updates; ‘out’: Filter outgoing routing updates;
Type: string
Supported Values: in, out
trunk
Description Trunk interface (Trunk interface number)
Type: number
Format: interface
tunnel
Description Tunnel interface (Tunnel interface number)
Type: number
Format: interface
ve
Description Virtual ethernet interface (Virtual ethernet interface number)
Type: number
Format: interface