router ospf area

OSPF area parameters

area Specification

Type Collection
Object Key(s) area-ipv4, area-num
Collection Name area-list
Collection URI /axapi/v3/router/ospf/{process-id}/area/
Element Name area
Element URI /axapi/v3/router/ospf/{process-id}/area/{area-ipv4}+{area-num}
Element Attributes area_attributes
Schema area schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

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

area Attributes

Create List

POST

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

area Attributes

Get Object

GET

/axapi/v3/router/ospf/{process-id}/area/{area-ipv4}+{area-num}

area Attributes

Get List

GET

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

area-list

Modify Object

POST

/axapi/v3/router/ospf/{process-id}/area/{area-ipv4}+{area-num}

area Attributes

Replace Object

PUT

/axapi/v3/router/ospf/{process-id}/area/{area-ipv4}+{area-num}

area Attributes

Replace List

PUT

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

area-list

Delete Object

DELETE

/axapi/v3/router/ospf/{process-id}/area/{area-ipv4}+{area-num}

area Attributes

area-list

area-list is JSON List of area Attributes

area-list : [

area Attributes

area-ipv4

Description: OSPF area ID in IP address format

Type: string

Format: ipv4-address

Required: Yes

area-num

Description: OSPF area ID as a decimal value

Type: number

Range: 0-4294967295

Required: Yes

auth-cfg

Description: auth-cfg is a JSON Block . Please see below for 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 filter-lists

Type: List

nssa-cfg

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

Type: Object

range-list

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

Type: 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

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

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

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

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