router ospf

Open Shortest Path First (OSPF)

ospf Specification

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

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/router/ospf/

ospf Attributes

Create List

POST

/axapi/v3/router/ospf/

ospf Attributes

Get Object

GET

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

ospf Attributes

Get List

GET

/axapi/v3/router/ospf/

ospf-list

Modify Object

POST

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

ospf Attributes

Replace Object

PUT

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

ospf Attributes

Replace List

PUT

/axapi/v3/router/ospf/

ospf-list

Delete Object

DELETE

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

ospf Attributes

ospf-list

ospf-list is JSON List of ospf Attributes

ospf-list : [

ospf Attributes

area-list

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

Type: List

Reference Object: /axapi/v3/router/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 default-information

Type: Object

Reference Object: /axapi/v3/router/ospf/{process-id}/default-information

default-metric

Description: Set metric of redistributed routes (Default metric)

Type: number

Range: 1-16777214

Default: 20

distance

Description: distance is a JSON Block . Please see below for distance

Type: Object

distribute-internal-list

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

Type: List

distribute-lists

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

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

host-list

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

Type: List

log-adjacency-changes-cfg

Description: log-adjacency-changes-cfg is a JSON Block . Please see below for log-adjacency-changes-cfg

Type: Object

max-concurrent-dd

Description: Maximum number allowed to process DD concurrently (Number of DD process)

Type: number

Range: 1-65535

Default: 5

maximum-area

Description: Maximum number of OSPF area (OSPF area limit)

Type: number

Range: 1-4294967294

neighbor-list

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

Type: List

network-list

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

Type: List

ospf-1

Description: ospf-1 is a JSON Block . Please see below for ospf-1

Type: Object

overflow

Description: overflow is a JSON Block . Please see below for overflow

Type: Object

passive-interface

Description: passive-interface is a JSON Block . Please see below for passive-interface

Type: Object

process-id

Description: OSPF process ID

Type: number

Range: 0-65535

Default: 0

Required: Yes

redistribute

Description: redistribute is a JSON Block . Please see below for redistribute

Type: Object

Reference Object: /axapi/v3/router/ospf/{process-id}/redistribute

rfc1583-compatible

Description: Compatible with RFC 1583

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

router-id

Description: router-id is a JSON Block . Please see below for router-id

Type: Object

summary-address-list

Description: summary-address-list is a JSON List . Please see below for summary-address-list

Type: List

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

di-area-ipv4

Description: OSPF area ID as a IP address format

Type: string

Format: ipv4-address

di-area-num

Description: OSPF area ID as a decimal value

Type: number

Range: 0-4294967295

di-cost

Description: Cost of route

Type: number

Range: 1-65535

Default: 1

di-type

Description: ‘lw4o6’: LW4O6 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, floating-ip, ip-nat, ip-nat-list, vip, vip-only-flagged

distribute-lists

Specification
Type list
Block object keys

direction

Description: ‘in’: Filter incoming routing updates; ‘out’: Filter outgoing routing updates;

Type: string

Supported Values: in, out

option

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

Type: string

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

ospf-id

Description: OSPF process ID

Type: number

Range: 1-65535

protocol

Description: ‘bgp’: Border Gateway Protocol (BGP); ‘connected’: Connected; ‘floating-ip’: Floating IP; ‘lw4o6’: LW4O6 Prefix; ‘ip-nat’: IP NAT; ‘ip-nat-list’: IP NAT list; ‘isis’: ISO IS-IS; ‘ospf’: Open Shortest Path First (OSPF); ‘rip’: Routing Information Protocol (RIP); ‘static’: Static routes;

Type: string

Supported Values: bgp, connected, floating-ip, lw4o6, ip-nat, ip-nat-list, isis, ospf, rip, static

value

Description: Access-list name

Type: string

router-id

Specification
Type object

value

Description: OSPF router-id in IPv4 address format

Type: string

Format: ipv4-address

neighbor-list

Specification
Type list
Block object keys

address

Description: Neighbor address

Type: string

Format: ipv4-address

cost

Description: OSPF cost for point-to-multipoint neighbor (Metric)

Type: number

Range: 1-65535

poll-interval

Description: OSPF dead-router polling interval (Seconds)

Type: number

Range: 1-65535

priority

Description: OSPF priority of non-broadcast neighbor

Type: number

Range: 0-255

ospf-1

Specification
Type object

abr-type

Description: abr-type is a JSON Block . Please see below for l372_abr-type

Type: Object

ospf-1.abr-type

Specification
Type object

option

Description: ‘cisco’: Alternative ABR, Cisco implementation (RFC3509); ‘ibm’: Alternative ABR, IBM implementation (RFC3509); ‘shortcut’: Shortcut ABR; ‘standard’: Standard behavior (RFC2328);

Type: string

Supported Values: cisco, ibm, shortcut, standard

Default: cisco

host-list

Specification
Type list
Block object keys

area-cfg

Description: area-cfg is a JSON Block . Please see below for l372_area-cfg

Type: Object

host-address

Description: Host address

Type: string

Format: ipv4-address

host-list.area-cfg

Specification
Type object

area-ipv4

Description: OSPF area ID in IP address format

Type: string

Format: ipv4-address

area-num

Description: OSPF area ID as a decimal value

Type: number

Range: 0-4294967295

cost

Description: Cost of host

Type: number

Range: 0-65535

Default: 0

log-adjacency-changes-cfg

Specification
Type object

state

Description: ‘detail’: Log changes in adjacency state; ‘disable’: Disable logging;

Type: string

Supported Values: detail, disable

area-list

Specification
Type list
Block object keys

area-ipv4

Description: OSPF area ID in IP address format

Type: string

Format: ipv4-address

area-num

Description: OSPF area ID as a decimal value

Type: number

Range: 0-4294967295

auth-cfg

Description: auth-cfg is a JSON Block . Please see below for l372_auth-cfg

Type: Object

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

filter-lists

Description: filter-lists is a JSON List . Please see below for l372_filter-lists

Type: List

nssa-cfg

Description: nssa-cfg is a JSON Block . Please see below for l372_nssa-cfg

Type: Object

range-list

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

Type: List

shortcut

Description: ‘default’: Set default shortcutting behavior; ‘disable’: Disable shortcutting through the area; ‘enable’: Enable shortcutting through the area;

Type: string

Supported Values: default, disable, enable

Default: default

stub-cfg

Description: stub-cfg is a JSON Block . Please see below for l372_stub-cfg

Type: Object

uuid

Description: uuid of the object

Type: string

virtual-link-list

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

Type: List

area-list.nssa-cfg

Specification
Type object

default-information-originate

Description: Originate Type 7 default into NSSA area

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

metric

Description: OSPF default metric (OSPF metric)

Type: number

Range: 0-16777214

Default: 1

metric-type

Description: OSPF metric type (OSPF metric type for default routes)

Type: number

Range: 1-2

Default: 2

no-redistribution

Description: No redistribution into this NSSA area

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

no-summary

Description: Do not send summary LSA into NSSA

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

nssa

Description: Specify a NSSA area

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

translator-role

Description: ‘always’: Translate always; ‘candidate’: Candidate for translator (default); ‘never’: Do not translate;

Type: string

Supported Values: always, candidate, never

Default: candidate

area-list.filter-lists

Specification
Type list
Block object keys

acl-direction

Description: ‘in’: Filter networks sent to this area; ‘out’: Filter networks sent from this area;

Type: string

Supported Values: in, out

acl-name

Description: Filter networks by access-list (Name of an access-list)

Type: string

filter-list

Description: Filter networks between OSPF areas

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

plist-direction

Description: ‘in’: Filter networks sent to this area; ‘out’: Filter networks sent from this area;

Type: string

Supported Values: in, out

plist-name

Description: Filter networks by prefix-list (Name of an IP prefix-list)

Type: string

area-list.stub-cfg

Specification
Type object

no-summary

Description: Do not inject inter-area routes into area

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

stub

Description: Configure OSPF area as stub

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

area-list.auth-cfg

Specification
Type object

authentication

Description: Enable authentication

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

message-digest

Description: Use message-digest authentication

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

area-list.range-list

Specification
Type list
Block object keys

area-range-prefix

Description: Area range for IPv4 prefix

Type: string

Format: ipv4-cidr

option

Description: ‘advertise’: Advertise this range (default); ‘not-advertise’: DoNotAdvertise this range;

Type: string

Supported Values: advertise, not-advertise

Default: advertise

summary-address-list

Specification
Type list
Block object keys

not-advertise

Description: Suppress routes that match the prefix

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

summary-address

Description: Configure IP address summaries (Summary prefix)

Type: string

Format: ipv4-cidr

tag

Description: Set tag (32-bit tag value)

Type: number

Range: 0-4294967295

passive-interface

Specification
Type object

eth-cfg

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

Type: List

lif-cfg

Description: lif-cfg is a JSON List . Please see below for l372_lif-cfg

Type: List

loopback-cfg

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

Type: List

trunk-cfg

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

Type: List

ve-cfg

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

Type: List

passive-interface.eth-cfg

Specification
Type list
Block object keys

eth-address

Description: Address of Interface

Type: string

Format: ipv4-address

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

passive-interface.ve-cfg

Specification
Type list
Block object keys

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Format: interface

ve-address

Description: Address of Interface

Type: string

Format: ipv4-address

passive-interface.trunk-cfg

Specification
Type list
Block object keys

trunk

Description: Trunk interface (Trunk interface number)

Type: number

Format: interface

trunk-address

Description: Address of Interface

Type: string

Format: ipv4-address

passive-interface.loopback-cfg

Specification
Type list
Block object keys

loopback

Description: Loopback interface (Port number)

Type: number

Format: interface

loopback-address

Description: Address of Interface

Type: string

Format: ipv4-address

passive-interface.lif-cfg

Specification
Type list
Block object keys

lif

Description: Logical interface (Lif interface number)

Type: number

Format: interface

lif-address

Description: Address of Interface

Type: string

Format: ipv4-address

default-information

Specification
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

uuid

Description: uuid of the object

Type: string

overflow

Specification
Type object

database

Description: database is a JSON Block . Please see below for l372_database

Type: Object

overflow.database

Specification
Type object

count

Description: Maximum number of LSAs

Type: number

Range: 0-4294967294

Default: 4294967294

db-external

Description: Maximum number of LSAs

Type: number

Range: 0-2147483647

Default: 2147483647

limit

Description: ‘hard’: Hard limit: Instance will be shutdown if exceeded; ‘soft’: Soft limit: Warning will be given if exceeded;

Type: string

Supported Values: hard, soft

Default: hard

recovery-time

Description: Time to recover (0 not recover)

Type: number

Range: 0-65535

Default: 0

distance

Specification
Type object

distance-ospf

Description: distance-ospf is a JSON Block . Please see below for l372_distance-ospf

Type: Object

distance-value

Description: OSPF Administrative distance

Type: number

Range: 1-255

Default: 110

distance.distance-ospf

Specification
Type object

distance-external

Description: External routes (Distance for external routes)

Type: number

Range: 1-255

distance-inter-area

Description: Inter-area routes (Distance for inter-area routes)

Type: number

Range: 1-255

distance-intra-area

Description: Intra-area routes (Distance for intra-area routes)

Type: number

Range: 1-255

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 l372_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 l372_ospf-list

Type: List

redist-list

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

Type: List

route-map-ip-nat

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

Type: string

tag-ip-nat

Description: Set tag for routes redistributed into OSPF (32-bit tag value)

Type: number

Range: 0-2147483647

uuid

Description: uuid of the object

Type: string

vip-floating-list

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

Type: List

vip-list

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

tag

Description: Set tag for routes redistributed into OSPF (32-bit tag value)

Type: number

Range: 0-4294967295

type

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

Range: 1-65535

Required: Yes

route-map-ospf

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

Type: string

tag-ospf

Description: Set tag for routes redistributed into OSPF (32-bit tag value)

Type: number

Range: 0-4294967295

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: ipv4-address

ip-nat-prefix

Description: Address

Type: string

Format: ipv4-cidr

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

tag-vip

Description: Set tag for routes redistributed into OSPF (32-bit tag value)

Type: number

Range: 0-2147483647

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: ipv4-address

vip-floating-IP-forward

Description: Floating-IP as forward address

Type: string

Format: ipv4-address

network-list

Specification
Type list
Block object keys

network-area

Description: network-area is a JSON Block . Please see below for l372_network-area

Type: Object

network-ipv4

Description: Network number

Type: string

Format: ipv4-address

network-ipv4-cidr

Description: OSPF network prefix

Type: string

Format: ipv4-cidr

network-ipv4-mask

Description: OSPF wild card bits

Type: string

Format: ipv4-rev-netmask

network-list.network-area

Specification
Type object

instance-value

Description: Instance ID

Type: number

Range: 0-255

Default: 0

network-area-ipv4

Description: OSPF area ID in IP address format

Type: string

Format: ipv4-address

network-area-num

Description: OSPF area ID as a decimal value

Type: number

Range: 0-4294967295

timers

Specification
Type object

spf

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

Type: Object

timers.spf

Specification
Type object

exp

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