OSPFArea

OSPF relies on the concept of logical areas. The use of areas enables the hiding of topology information between areas whilst still providing reachability. Each router in the area shares the same routing tables, which simplifies the network topology and helps to optimize the route calculation algorithm.

Overview

aggregateAreaRange list
aggregateAreaRangeNSSA list
areaID integer required   filterable   orderable  
areaType enum (NORMAL | NSSA | STUB) filterable   orderable  
defaultMetric integer filterable   orderable  
defaultOriginateOption enum (NONE | TYPE3 | TYPE7)
description string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
redistributeExternalEnabled boolean
summariesEnabled boolean
suppressAreaRange list
suppressAreaRangeNSSA list

API Resource

/ospfareas/id
delete get put

Parents

/ospfinstances/id/ospfareas
get post

Children

/ospfareas/id/metadatas
get post
/ospfareas/id/globalmetadatas
get post put
/ospfareas/id/ospfinterfaces
get post

Members

This object has no members.

Attributes documentation

aggregateAreaRange list
Discussion

Routes (type 3 LSAs) that belong to networks listed here will be aggregated.

Charateristics

SDK attribute: aggregateAreaRange

aggregateAreaRangeNSSA list
Discussion

Routes (type 7 LSAs) that belong to networks listed here will be aggregated.

Charateristics

SDK attribute: aggregateAreaRangeNSSA

areaID integer required   filterable   orderable  
Discussion

OSPF Area ID

Charateristics

Max value: 4294967295
SDK attribute: areaID

areaType enum filterable   orderable  
Discussion

Set the OSPF area type. The default value is 'NORMAL', which represents either a backbone area or a standard area. If the areaID is 0, this attribute must be set to 'NORMAL'.

Charateristics

Allowed values: NORMAL, NSSA, STUB
Default value: NORMAL
SDK attribute: areaType

defaultMetric integer filterable   orderable  
Discussion

Explicit route cost metric for the default route generated. For STUB areas, it defaults to 1. It is null for the other types of areas.

Charateristics

Min value: 1
Max value: 16777215
SDK attribute: defaultMetric

defaultOriginateOption enum
Discussion

Specifies whether an NSSA area generates a default route, and if it does, whether it is advertised as type 3 LSA or type 7 LSA. If the attribute is set to 'NONE', no default is generated.

Charateristics

Allowed values: NONE, TYPE3, TYPE7
SDK attribute: defaultOriginateOption

description string
Discussion

Description of OSPFArea

Charateristics

Format: free
SDK attribute: description

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

redistributeExternalEnabled boolean
Discussion

This flag will determine whether external routes will be redistributed into the area or not. This is enabled only for NSSA areas.

Charateristics

SDK attribute: redistributeExternalEnabled

summariesEnabled boolean
Discussion

This flag determines whether Summaries (Type 3 LSAs) will be redistributed into the area or not. Applicable only to NSSA and Stub area types. Disabling this will make the area a Totally Stub or Totally NSSA area.

Charateristics

SDK attribute: summariesEnabled

suppressAreaRange list
Discussion

Routes (type 3 LSAs) that belong to networks listed here will be suppressed.

Charateristics

SDK attribute: suppressAreaRange

suppressAreaRangeNSSA list
Discussion

Routes (type 7 LSAs) that belong to networks listed here will be suppressed.

Charateristics

SDK attribute: suppressAreaRangeNSSA