{ "id":"/axapi/v3/router/ospf/{process-id}/area/{area-ipv4}+{area-num}", "type":"object", "node-type":"list", "title":"area", "partition-visibility":"shared", "description":"OSPF area parameters", "properties":{ "area-ipv4":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"OSPF area ID in IP address format", "optional":false }, "area-num":{ "type":"number", "format":"number", "minimum":0, "maximum":4294967295, "partition-visibility":"shared", "description":"OSPF area ID as a decimal value", "optional":false }, "auth-cfg":{ "type":"object", "properties":{ "authentication":{ "type":"number", "format":"flag", "plat-neg-list":["fips"], "default":0, "partition-visibility":"shared", "description":"Enable authentication" }, "message-digest":{ "type":"number", "format":"flag", "plat-neg-list":["fips"], "default":0, "partition-visibility":"shared", "description":"Use message-digest authentication" } } }, "filter-lists":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "filter-list":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Filter networks between OSPF areas" }, "acl-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Filter networks by access-list (Name of an access-list)" }, "acl-direction":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'in': Filter networks sent to this area; 'out': Filter networks sent from this area; ", "enum":[ "in", "out" ] }, "plist-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Filter networks by prefix-list (Name of an IP prefix-list)" }, "plist-direction":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'in': Filter networks sent to this area; 'out': Filter networks sent from this area; ", "enum":[ "in", "out" ] } } } ] }, "nssa-cfg":{ "type":"object", "properties":{ "nssa":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify a NSSA area" }, "no-redistribution":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"No redistribution into this NSSA area" }, "no-summary":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do not send summary LSA into NSSA" }, "translator-role":{ "type":"string", "format":"enum", "default":"candidate", "partition-visibility":"shared", "description":"'always': Translate always; 'candidate': Candidate for translator (default); 'never': Do not translate; ", "enum":[ "always", "candidate", "never" ] }, "default-information-originate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Originate Type 7 default into NSSA area" }, "metric":{ "type":"number", "format":"number", "minimum":0, "maximum":16777214, "default":1, "partition-visibility":"shared", "description":"OSPF default metric (OSPF metric)" }, "metric-type":{ "type":"number", "format":"number", "minimum":1, "maximum":2, "default":2, "partition-visibility":"shared", "description":"OSPF metric type (OSPF metric type for default routes)" } } }, "default-cost":{ "type":"number", "format":"number", "minimum":0, "maximum":16777215, "default":1, "partition-visibility":"shared", "description":"Set the summary-default cost of a NSSA or stub area (Stub's advertised default summary cost)", "optional":true }, "range-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "area-range-prefix":{ "type":"string", "format":"ipv4-cidr", "partition-visibility":"shared", "description":"Area range for IPv4 prefix" }, "option":{ "type":"string", "format":"enum", "default":"advertise", "partition-visibility":"shared", "description":"'advertise': Advertise this range (default); 'not-advertise': DoNotAdvertise this range; ", "enum":[ "advertise", "not-advertise" ] } } } ] }, "shortcut":{ "type":"string", "format":"enum", "default":"default", "partition-visibility":"shared", "description":"'default': Set default shortcutting behavior; 'disable': Disable shortcutting through the area; 'enable': Enable shortcutting through the area; ", "enum":[ "default", "disable", "enable" ], "optional":true }, "stub-cfg":{ "type":"object", "properties":{ "stub":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure OSPF area as stub" }, "no-summary":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Do not inject inter-area routes into area" } } }, "virtual-link-list":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "virtual-link-ip-addr":{ "type":"string", "format":"ipv4-address", "partition-visibility":"shared", "description":"ID (IP addr) associated with virtual link neighbor" }, "bfd":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Bidirectional Forwarding Detection (BFD)" }, "hello-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Hello packet interval (Seconds)" }, "dead-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "partition-visibility":"shared", "description":"Dead router detection time (Seconds)" }, "retransmit-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":3600, "partition-visibility":"shared", "description":"LSA retransmit interval (Seconds)" }, "transmit-delay":{ "type":"number", "format":"number", "minimum":1, "maximum":3600, "default":1, "partition-visibility":"shared", "description":"LSA transmission delay (Seconds)" }, "virtual-link-authentication":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable authentication" }, "virtual-link-auth-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'message-digest': Use message-digest authentication; 'null': Use null authentication; ", "enum":[ "message-digest", "null" ] }, "authentication-key":{ "type":"string", "format":"string-rlx", "plat-neg-list":["fips"], "minLength":1, "maxLength":8, "partition-visibility":"shared", "description":"Set authentication key (Authentication key (8 chars))" }, "message-digest-key":{ "type":"number", "format":"number", "plat-neg-list":["fips"], "minimum":1, "maximum":255, "partition-visibility":"shared", "description":"Set message digest key (Key ID)" }, "md5":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":16, "partition-visibility":"shared", "description":"Use MD5 algorithm (Authentication key (16 chars))" } } } ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "object-keys":[ "area-ipv4", "area-num" ], "required":[ "area-ipv4", "area-num" ] }