interface lif ip ospf¶

Open Shortest Path First for IPv4 (OSPF)

ospf Specification¶

Parameter Value

Type Intermediate Resource

Element Name ospf

Element URI /axapi/v3/interface/lif/{ifname}/ip/ospf

Element Attributes ospf_attributes

Partition Visibility shared

Schema ospf schema

Operations Allowed:

Operation

Method

URI

Payload

Get Object

GET

/axapi/v3/interface/lif/{ifname}/ip/ospf

ospf_attributes

ospf attributes¶

ospf-global

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

Type: Object

Reference Object: /axapi/v3/interface/lif/{ifname}/ip/ospf/ospf-global

ospf-ip-list

Type: List

Reference Object: /axapi/v3/interface/lif/{ifname}/ip/ospf/ospf-ip/{ip-addr}

ospf-ip-list¶

Specification Value

Type list

Block object keys

authentication

Description Enable authentication

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

authentication-key

Description Authentication password (key) (The OSPF password (key))

Type: string

Format: string-rlx

Maximum Length: 8 characters

Maximum Length: 1 characters

cost

Description Interface cost

Type: number

Range: 1-65535

database-filter

Description ‘all’: Filter all LSA;

Type: string

Supported Values: all

dead-interval

Description Interval after which a neighbor is declared dead (Seconds)

Type: number

Range: 1-65535

Default: 40

hello-interval

Description Time between HELLO packets (Seconds)

Type: number

Range: 1-65535

Default: 10

ip-addr

Description Address of interface

Type: string

Format: ipv4-address

message-digest-cfg

Type: List

mtu-ignore

Description Ignores the MTU in DBD packets

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

out

Description Outgoing LSA

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

priority

Description Router priority

Type: number

Range: 0-255

Default: 1

retransmit-interval

Description Time between retransmitting lost link state advertisements (Seconds)

Type: number

Range: 1-65535

Default: 5

transmit-delay

Description Link state transmit delay (Seconds)

Type: number

Range: 1-65535

Default: 1

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

value

Description ‘message-digest’: Use message-digest authentication; ‘null’: Use no authentication;

Type: string

Supported Values: message-digest, null

ospf-ip-list_message-digest-cfg¶

Specification Value

Type list

Block object keys

encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

md5-value

Description The OSPF password (1-16)

Type: string

Format: password

Maximum Length: 16 characters

Maximum Length: 1 characters

message-digest-key

Description Message digest authentication password (key) (Key id)

Type: number

Range: 1-255

ospf-global¶

Specification Value

Type object

authentication-cfg

Description: authentication-cfg is a JSON Block. Please see below for ospf-global_authentication-cfg

Type: Object

authentication-key

Description Authentication password (key) (The OSPF password (key))

Type: string

Format: string-rlx

Maximum Length: 8 characters

Maximum Length: 1 characters

bfd-cfg

Description: bfd-cfg is a JSON Block. Please see below for ospf-global_bfd-cfg

Type: Object

cost

Description Interface cost

Type: number

Range: 1-65535

database-filter-cfg

Description: database-filter-cfg is a JSON Block. Please see below for ospf-global_database-filter-cfg

Type: Object

dead-interval

Description Interval after which a neighbor is declared dead (Seconds)

Type: number

Range: 1-65535

Default: 40

disable

Description ‘all’: All functionality;

Type: string

Supported Values: all

hello-interval

Description Time between HELLO packets (Seconds)

Type: number

Range: 1-65535

Default: 10

message-digest-cfg

Type: List

mtu

Description OSPF interface MTU (MTU size)

Type: number

Range: 576-65535

mtu-ignore

Description Ignores the MTU in DBD packets

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

network

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

Type: Object

priority

Description Router priority

Type: number

Range: 0-255

Default: 1

retransmit-interval

Description Time between retransmitting lost link state advertisements (Seconds)

Type: number

Range: 1-65535

Default: 5

transmit-delay

Description Link state transmit delay (Seconds)

Type: number

Range: 1-65535

Default: 1

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ospf-global_network¶

Specification Value

Type object

broadcast

Description Specify OSPF broadcast multi-access network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: broadcast,non-broadcast, point-to-point, and point-to-multipoint are mutually exclusive

non-broadcast

Description Specify OSPF NBMA network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: non-broadcast,broadcast, point-to-point, and point-to-multipoint are mutually exclusive

p2mp-nbma

Description Specify non-broadcast point-to-multipoint network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

point-to-multipoint

Description Specify OSPF point-to-multipoint network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: point-to-multipoint,broadcast, non-broadcast, and point-to-point are mutually exclusive

point-to-point

Description Specify OSPF point-to-point network

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: point-to-point,broadcast, non-broadcast, and point-to-multipoint are mutually exclusive

ospf-global_authentication-cfg¶

Specification Value

Type object

authentication

Description Enable authentication

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

value

Description ‘message-digest’: Use message-digest authentication; ‘null’: Use no authentication;

Type: string

Supported Values: message-digest, null

ospf-global_database-filter-cfg¶

Specification Value

Type object

database-filter

Description ‘all’: Filter all LSA;

Type: string

Supported Values: all

out

Description Outgoing LSA

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ospf-global_bfd-cfg¶

Specification Value

Type object

bfd

Description Bidirectional Forwarding Detection (BFD)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

disable

Description Disable BFD

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ospf-global_message-digest-cfg¶

Specification Value

Type list

Block object keys

md5

Description: md5 is a JSON Block. Please see below for ospf-global_message-digest-cfg_md5

Type: Object

message-digest-key

Description Message digest authentication password (key) (Key id)

Type: number

Range: 1-255

ospf-global_message-digest-cfg_md5¶

Specification Value

Type object

encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

md5-value

Description The OSPF password (1-16)

Type: string

Format: password

Maximum Length: 16 characters

Maximum Length: 1 characters