router ospf area¶
OSPF area parameters
area Specification¶
Parameter Value 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 Partition Visibility shared Schema area schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/router/ospf/{process-id}/area | ||
Create List | POST | /axapi/v3/router/ospf/{process-id}/area | ||
Get Object | GET | /axapi/v3/router/ospf/{process-id}/area/{area-ipv4}+{area-num} | ||
Get List | GET | /axapi/v3/router/ospf/{process-id}/area | ||
Modify Object | POST | /axapi/v3/router/ospf/{process-id}/area/{area-ipv4}+{area-num} | ||
Replace Object | PUT | /axapi/v3/router/ospf/{process-id}/area/{area-ipv4}+{area-num} | ||
Replace List | PUT | /axapi/v3/router/ospf/{process-id}/area | ||
Delete Object | DELETE | /axapi/v3/router/ospf/{process-id}/area/{area-ipv4}+{area-num} |
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
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 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
Type: Listnssa-cfg
Description: nssa-cfg is a JSON Block. Please see below for nssa-cfg
Type: Object
range-list
Type: Listshortcut
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
Maximum Length: 64 characters
Maximum Length: 1 characters
virtual-link-list
Type: List
nssa-cfg¶
Specification Value 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 Value 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
Maximum Length: 128 characters
Maximum Length: 1 characters
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
Maximum Length: 128 characters
Maximum Length: 1 characters
virtual-link-list¶
Specification Value Type list Block object keys authentication-key
Description Set authentication key (Authentication key (8 chars))
Type: string
Format: string-rlx
Maximum Length: 8 characters
Maximum Length: 1 characters
bfd
Description Bidirectional Forwarding Detection (BFD)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dead-interval
Description Dead router detection time (Seconds)
Type: number
Range: 1-65535
hello-interval
Description Hello packet interval (Seconds)
Type: number
Range: 1-65535
md5
Description Use MD5 algorithm (Authentication key (16 chars))
Type: string
Format: string-rlx
Maximum Length: 16 characters
Maximum Length: 1 characters
message-digest-key
Description Set message digest key (Key ID)
Type: number
Range: 1-255
retransmit-interval
Description LSA retransmit interval (Seconds)
Type: number
Range: 1-3600
transmit-delay
Description LSA transmission delay (Seconds)
Type: number
Range: 1-3600
Default: 1
virtual-link-auth-type
Description ‘message-digest’: Use message-digest authentication; ‘null’: Use null authentication;
Type: string
Supported Values: message-digest, null
virtual-link-authentication
Description Enable authentication
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
virtual-link-ip-addr
Description ID (IP addr) associated with virtual link neighbor
Type: string
Format: ipv4-address
stub-cfg¶
Specification Value 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 Value 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 Value 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