router ipv6 ospf

Open Shortest Path First (OSPFv3)

ospf Specification

Type Collection
Object Key(s) process-id
Collection Name ospf-list
Collection URI /axapi/v3/router/ipv6/ospf/
Element Name ospf
Element URI /axapi/v3/router/ipv6/ospf/{process-id}
Element Attributes ospf_attributes
Schema ospf schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/router/ipv6/ospf/

ospf Attributes

Create List

POST

/axapi/v3/router/ipv6/ospf/

ospf Attributes

Get Object

GET

/axapi/v3/router/ipv6/ospf/{process-id}

ospf Attributes

Get List

GET

/axapi/v3/router/ipv6/ospf/

ospf-list

Modify Object

POST

/axapi/v3/router/ipv6/ospf/{process-id}

ospf Attributes

Replace Object

PUT

/axapi/v3/router/ipv6/ospf/{process-id}

ospf Attributes

Replace List

PUT

/axapi/v3/router/ipv6/ospf/

ospf-list

Delete Object

DELETE

/axapi/v3/router/ipv6/ospf/{process-id}

ospf Attributes

ospf-list

ospf-list is JSON List of ospf Attributes

ospf-list : [

ospf Attributes

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

Description: area-list is a JSON List . Please see below for 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-metric

Description: Set metric of redistributed routes (Default metric)

Type: number

Range: 1-16777214

Default: 20

distribute-internal-list

Description: distribute-internal-list is a JSON List . Please see below for distribute-internal-list

Type: List

ha-standby-extra-cost

Description: Extra ospf cost when there is any standby HA group (The extra cost value)

Type: number

Range: 1-65535

log-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 passive-interface

Type: Object

process-id

Description: OSPFv3 process tag

Type: string

Default: 0

Required: Yes

redistribute

Description: redistribute is a JSON Block . Please see below for 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 timers

Type: Object

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

distribute-internal-list

Specification
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; ‘floating-ip’: Floating IP; ‘ip-nat’: IP NAT; ‘ip-nat-list’: IP NAT list; ‘vip’: Virtual IP (VIP); ‘vip-only-flagged’: Selected Virtual IP (VIP);

Type: string

Supported Values: lw4o6, nat64, floating-ip, ip-nat, ip-nat-list, vip, vip-only-flagged

redistribute

Specification
Type object

ip-nat

Description: IP-NAT

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip-nat-floating-list

Description: ip-nat-floating-list is a JSON List . Please see below for l354_ip-nat-floating-list

Type: List

metric-ip-nat

Description: OSPF default metric (OSPF metric)

Type: number

Range: 0-16777214

metric-type-ip-nat

Description: ‘1’: Set OSPF External Type 1 metrics; ‘2’: Set OSPF External Type 2 metrics;

Type: string

Supported Values: 1, 2

Default: 2

ospf-list

Description: ospf-list is a JSON List . Please see below for l354_ospf-list

Type: List

redist-list

Description: redist-list is a JSON List . Please see below for l354_redist-list

Type: List

route-map-ip-nat

Description: Route map reference (Pointer to route-map entries)

Type: string

uuid

Description: uuid of the object

Type: string

vip-floating-list

Description: vip-floating-list is a JSON List . Please see below for l354_vip-floating-list

Type: List

vip-list

Description: vip-list is a JSON List . Please see below for l354_vip-list

Type: List

redistribute.redist-list

Specification
Type list
Block object keys

metric

Description: OSPF default metric (OSPF metric)

Type: number

Range: 0-16777214

metric-type

Description: ‘1’: Set OSPF External Type 1 metrics; ‘2’: Set OSPF 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

type

Description: ‘bgp’: Border Gateway Protocol (BGP); ‘connected’: Connected; ‘floating-ip’: Floating IP; ‘ip-nat-list’: IP NAT list; ‘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, nat64, lw4o6, isis, rip, static

redistribute.ospf-list

Specification
Type list
Block object keys

metric-ospf

Description: OSPF default metric (OSPF metric)

Type: number

Range: 0-16777214

metric-type-ospf

Description: ‘1’: Set OSPF External Type 1 metrics; ‘2’: Set OSPF 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: OSPF process ID

Type: string

Required: Yes

route-map-ospf

Description: Route map reference (Pointer to route-map entries)

Type: string

redistribute.ip-nat-floating-list

Specification
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

redistribute.vip-list

Specification
Type list
Block object keys

metric-type-vip

Description: ‘1’: Set OSPF External Type 1 metrics; ‘2’: Set OSPF External Type 2 metrics;

Type: string

Supported Values: 1, 2

Default: 2

metric-vip

Description: OSPF default metric (OSPF metric)

Type: number

Range: 0-16777214

route-map-vip

Description: Route map reference (Pointer to route-map entries)

Type: string

type-vip

Description: ‘only-flagged’: Selected Virtual IP (VIP); ‘only-not-flagged’: Only not flagged;

Type: string

Supported Values: only-flagged, only-not-flagged

redistribute.vip-floating-list

Specification
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

area-list

Specification
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

Description: range-list is a JSON List . Please see below for l354_range-list

Type: List

stub

Description: Configure OSPFv3 area as stub

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description: uuid of the object

Type: string

virtual-link-list

Description: virtual-link-list is a JSON List . Please see below for l354_virtual-link-list

Type: List

area-list.range-list

Specification
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

passive-interface

Specification
Type object

eth-cfg

Description: eth-cfg is a JSON List . Please see below for l354_eth-cfg

Type: List

loopback-cfg

Description: loopback-cfg is a JSON List . Please see below for l354_loopback-cfg

Type: List

trunk-cfg

Description: trunk-cfg is a JSON List . Please see below for l354_trunk-cfg

Type: List

ve-cfg

Description: ve-cfg is a JSON List . Please see below for l354_ve-cfg

Type: List

passive-interface.ve-cfg

Specification
Type list
Block object keys

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

passive-interface.trunk-cfg

Specification
Type list
Block object keys

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

passive-interface.loopback-cfg

Specification
Type list
Block object keys

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

passive-interface.eth-cfg

Specification
Type list
Block object keys

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

timers

Specification
Type object

spf

Description: spf is a JSON Block . Please see below for l354_spf

Type: Object

timers.spf

Specification
Type object

exp

Description: exp is a JSON Block . Please see below for l354_exp

Type: Object

timers.spf.exp

Specification
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