.. _router_ospf: router ospf =========== Open Shortest Path First (OSPF) ospf Specification ------------------ ===================================== ================================================================= **Parameter** **Value** ===================================== ================================================================= **Type** *Collection* **Object Key(s)** *process-id* **Collection Name** :ref:`2537_ospf_list` **Collection URI** /axapi/v3/router/ospf **Element Name** ospf **Element URI** /axapi/v3/router/ospf/{process-id} **Element Attributes** ospf_attributes **Partition Visibility** shared **Schema** :download:`ospf schema ` ===================================== ================================================================= **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Create Object .. raw:: html POST .. raw:: html /axapi/v3/router/ospf .. raw:: html :ref:`2537_ospf_attributes` .. raw:: html
Create List .. raw:: html POST .. raw:: html /axapi/v3/router/ospf .. raw:: html :ref:`2537_ospf_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/router/ospf/{process-id} .. raw:: html :ref:`2537_ospf_attributes` .. raw:: html
Get List .. raw:: html GET .. raw:: html /axapi/v3/router/ospf .. raw:: html :ref:`2537_ospf_list` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/router/ospf/{process-id} .. raw:: html :ref:`2537_ospf_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/router/ospf/{process-id} .. raw:: html :ref:`2537_ospf_attributes` .. raw:: html
Replace List .. raw:: html PUT .. raw:: html /axapi/v3/router/ospf .. raw:: html :ref:`2537_ospf_list` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/router/ospf/{process-id} .. raw:: html :ref:`2537_ospf_attributes` .. raw:: html
.. _2537_ospf_list: ospf-list --------- ospf-list is **JSON List** of :ref:`2537_ospf_attributes` ospf-list : [ { :ref:`2537_ospf_attributes` }, { :ref:`2537_ospf_attributes` }, ... ] .. _2537_ospf_attributes: ospf attributes --------------- **area-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/ospf/{process-id}/area/{area-ipv4}+{area-num} ` **auto-cost-reference-bandwidth** **Description** Use reference bandwidth method to assign OSPF cost (The reference bandwidth in terms of Mbits per second) **Type:** number **Range:** 1-4294967 **Default:** 10000 **bfd-all-interfaces** **Description** Enable BFD on all interfaces **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **default-information** **Description:** default-information is a **JSON Block**. Please see below for :ref:`2537_default-information` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/ospf/{process-id}/default-information ` **default-metric** **Description** Set metric of redistributed routes (Default metric) **Type:** number **Range:** 1-16777214 **Default:** 20 **distance** **Description:** distance is a **JSON Block**. Please see below for :ref:`2537_distance` **Type:** Object **distribute-internal-list** **Type:** List **distribute-lists** **Type:** List **extern-lsa-equivalence-check** **Description** external LSA equivalance check **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ha-standby-extra-cost** **Type:** List **host-list** **Type:** List **log-adjacency-changes-cfg** **Description:** log-adjacency-changes-cfg is a **JSON Block**. Please see below for :ref:`2537_log-adjacency-changes-cfg` **Type:** Object **max-concurrent-dd** **Description** Maximum number allowed to process DD concurrently (Number of DD process) **Type:** number **Range:** 1-65535 **Default:** 5 **maximum-area** **Description** Maximum number of non-backbone areas (OSPF area limit) **Type:** number **Range:** 1-4294967294 **neighbor-list** **Type:** List **network-list** **Type:** List **ospf-1** **Description:** ospf-1 is a **JSON Block**. Please see below for :ref:`2537_ospf-1` **Type:** Object **overflow** **Description:** overflow is a **JSON Block**. Please see below for :ref:`2537_overflow` **Type:** Object **passive-interface** **Description:** passive-interface is a **JSON Block**. Please see below for :ref:`2537_passive-interface` **Type:** Object **process-id** **Description** OSPF process ID **Type:** number **Range:** 0-65535 **Default:** 0 **redistribute** **Description:** redistribute is a **JSON Block**. Please see below for :ref:`2537_redistribute` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/ospf/{process-id}/redistribute ` **rfc1583-compatible** **Description** Compatible with RFC 1583 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **router-id** **Description:** router-id is a **JSON Block**. Please see below for :ref:`2537_router-id` **Type:** Object **summary-address-list** **Type:** List **timers** **Description:** timers is a **JSON Block**. Please see below for :ref:`2537_timers` **Type:** Object **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2537_distribute-internal-list: distribute-internal-list ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **di-area-ipv4** **Description** OSPF area ID as a IP address format **Type:** string **Format:** ipv4-address **di-area-num** **Description** OSPF area ID as a decimal value **Type:** number **Range:** 0-4294967295 **di-cost** **Description** Cost of route **Type:** number **Range:** 1-65535 **Default:** 1 **di-type** **Description** 'lw4o6': LW4O6 Prefix; 'floating-ip': Floating IP; 'ip-nat': IP NAT; 'ip-nat-list': IP NAT list; 'static-nat': Static NAT; 'vip': Only not flagged Virtual IP (VIP); 'vip-only-flagged': Selected Virtual IP (VIP); **Type:** string **Supported Values:** lw4o6, floating-ip, ip-nat, ip-nat-list, static-nat, vip, vip-only-flagged .. _2537_distribute-lists: distribute-lists ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **direction** **Description** 'in': Filter incoming routing updates; 'out': Filter outgoing routing updates; **Type:** string **Supported Values:** in, out **option** **Description** 'only-flagged': Selected Virtual IP (VIP); 'only-not-flagged': Only not flagged; **Type:** string **Supported Values:** only-flagged, only-not-flagged **ospf-id** **Description** OSPF process ID **Type:** number **Range:** 1-65535 **protocol** **Description** 'bgp': Border Gateway Protocol (BGP); 'connected': Connected; 'floating-ip': Floating IP; 'lw4o6': LW4O6 Prefix; 'ip-nat': IP NAT; 'ip-nat-list': IP NAT list; 'static-nat': Static NAT; 'isis': ISO IS-IS; 'ospf': Open Shortest Path First (OSPF); 'rip': Routing Information Protocol (RIP); 'static': Static routes; **Type:** string **Supported Values:** bgp, connected, floating-ip, lw4o6, ip-nat, ip-nat-list, static-nat, isis, ospf, rip, static **value** **Description** Access-list name **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _2537_router-id: router-id ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **value** **Description** OSPF router-id in IPv4 address format **Type:** string **Format:** ipv4-address .. _2537_neighbor-list: neighbor-list ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **address** **Description** Neighbor address **Type:** string **Format:** ipv4-address **cost** **Description** OSPF cost for point-to-multipoint neighbor (Metric) **Type:** number **Range:** 1-65535 **poll-interval** **Description** OSPF dead-router polling interval (Seconds) **Type:** number **Range:** 1-65535 **priority** **Description** OSPF priority of non-broadcast neighbor **Type:** number **Range:** 0-255 .. _2537_ospf-1: ospf-1 ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **abr-type** **Description:** abr-type is a **JSON Block**. Please see below for :ref:`2537_ospf-1_abr-type` **Type:** Object .. _2537_ospf-1_abr-type: ospf-1_abr-type ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **option** **Description** 'cisco': Alternative ABR, Cisco implementation (RFC3509); 'ibm': Alternative ABR, IBM implementation (RFC3509); 'shortcut': Shortcut ABR; 'standard': Standard behavior (RFC2328); **Type:** string **Supported Values:** cisco, ibm, shortcut, standard **Default:** cisco .. _2537_host-list: host-list ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **area-cfg** **Description:** area-cfg is a **JSON Block**. Please see below for :ref:`2537_host-list_area-cfg` **Type:** Object **host-address** **Description** Host address **Type:** string **Format:** ipv4-address .. _2537_host-list_area-cfg: host-list_area-cfg ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **area-ipv4** **Description** OSPF area ID in IP address format **Type:** string **Format:** ipv4-address **Mutual Exclusion:** area-ipv4 and area-num are mutually exclusive **area-num** **Description** OSPF area ID as a decimal value **Type:** number **Range:** 0-4294967295 **Mutual Exclusion:** area-num and area-ipv4 are mutually exclusive **cost** **Description** Cost of host **Type:** number **Range:** 0-65535 **Default:** 0 .. _2537_log-adjacency-changes-cfg: log-adjacency-changes-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **state** **Description** 'detail': Log changes in adjacency state; 'disable': Disable logging; **Type:** string **Supported Values:** detail, disable .. _2537_area-list: area-list ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **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 :ref:`2537_area-list_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:** List **nssa-cfg** **Description:** nssa-cfg is a **JSON Block**. Please see below for :ref:`2537_area-list_nssa-cfg` **Type:** Object **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 :ref:`2537_area-list_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 .. _2537_area-list_nssa-cfg: area-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 .. _2537_area-list_filter-lists: area-list_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 .. _2537_area-list_virtual-link-list: area-list_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 .. _2537_area-list_stub-cfg: area-list_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 .. _2537_area-list_auth-cfg: area-list_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 .. _2537_area-list_range-list: area-list_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 .. _2537_summary-address-list: summary-address-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **not-advertise** **Description** Suppress routes that match the prefix **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **summary-address** **Description** Configure IP address summaries (Summary prefix) **Type:** string **Format:** ipv4-cidr **tag** **Description** Set tag (32-bit tag value) **Type:** number **Range:** 0-4294967295 .. _2537_passive-interface: passive-interface ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **eth-cfg** **Type:** List **lif-cfg** **Type:** List **loopback-cfg** **Type:** List **trunk-cfg** **Type:** List **tunnel-cfg** **Type:** List **ve-cfg** **Type:** List .. _2537_passive-interface_tunnel-cfg: passive-interface_tunnel-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **tunnel-address** **Description** Address of Interface **Type:** string **Format:** ipv4-address .. _2537_passive-interface_loopback-cfg: passive-interface_loopback-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **loopback-address** **Description** Address of Interface **Type:** string **Format:** ipv4-address .. _2537_passive-interface_ve-cfg: passive-interface_ve-cfg ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface **ve-address** **Description** Address of Interface **Type:** string **Format:** ipv4-address .. _2537_passive-interface_lif-cfg: passive-interface_lif-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **lif** **Description** Logical interface (Lif interface name) **Type:** string **Maximum Length:** 15 characters **Maximum Length:** 1 characters **lif-address** **Description** Address of Interface **Type:** string **Format:** ipv4-address .. _2537_passive-interface_trunk-cfg: passive-interface_trunk-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **trunk-address** **Description** Address of Interface **Type:** string **Format:** ipv4-address .. _2537_passive-interface_eth-cfg: passive-interface_eth-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **eth-address** **Description** Address of Interface **Type:** string **Format:** ipv4-address **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface .. _2537_default-information: default-information ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **always** **Description** Always advertise default route **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **metric** **Description** OSPF default metric (OSPF metric) **Type:** number **Range:** 0-16777214 **metric-type** **Description** OSPF metric type for default routes **Type:** number **Range:** 1-2 **Default:** 2 **originate** **Description** Distribute a default route **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **route-map** **Description** Route map reference (Pointer to route-map entries) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2537_overflow: overflow ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **database** **Description:** database is a **JSON Block**. Please see below for :ref:`2537_overflow_database` **Type:** Object .. _2537_overflow_database: overflow_database ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **count** **Description** Maximum number of LSAs **Type:** number **Range:** 0-4294967294 **Default:** 4294967294 **db-external** **Description** Maximum number of LSAs **Type:** number **Range:** 0-2147483647 **Default:** 2147483647 **limit** **Description** 'hard': Hard limit: Instance will be shutdown if exceeded; 'soft': Soft limit: Warning will be given if exceeded; **Type:** string **Supported Values:** hard, soft **Default:** hard **recovery-time** **Description** Time to recover (0 not recover) **Type:** number **Range:** 0-65535 **Default:** 0 .. _2537_distance: distance ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **distance-ospf** **Description:** distance-ospf is a **JSON Block**. Please see below for :ref:`2537_distance_distance-ospf` **Type:** Object **distance-value** **Description** OSPF Administrative distance **Type:** number **Range:** 1-255 **Default:** 110 .. _2537_distance_distance-ospf: distance_distance-ospf ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **distance-external** **Description** External routes (Distance for external routes) **Type:** number **Range:** 1-255 **distance-inter-area** **Description** Inter-area routes (Distance for inter-area routes) **Type:** number **Range:** 1-255 **distance-intra-area** **Description** Intra-area routes (Distance for intra-area routes) **Type:** number **Range:** 1-255 .. _2537_redistribute: redistribute ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ip-nat** **Description** IP-NAT **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ip-nat-floating-list** **Type:** List **metric-ip-nat** **Description** OSPF default metric (OSPF metric) **Type:** number **Range:** 0-16777214 **metric-type-ip-nat** **Description** '1': Set OSPF External Type 1 metrics; '2': Set OSPF External Type 2 metrics; **Type:** string **Supported Values:** 1, 2 **Default:** 2 **ospf-list** **Type:** List **redist-list** **Type:** List **route-map-ip-nat** **Description** Route map reference (Pointer to route-map entries) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **tag-ip-nat** **Description** Set tag for routes redistributed into OSPF (32-bit tag value) **Type:** number **Range:** 0-2147483647 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vip-floating-list** **Type:** List **vip-list** **Type:** List .. _2537_redistribute_redist-list: redistribute_redist-list ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **metric** **Description** OSPF default metric (OSPF metric) **Type:** number **Range:** 0-16777214 **metric-type** **Description** '1': Set OSPF External Type 1 metrics; '2': Set OSPF External Type 2 metrics; **Type:** string **Supported Values:** 1, 2 **Default:** 2 **route-map** **Description** Route map reference (Pointer to route-map entries) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **tag** **Description** Set tag for routes redistributed into OSPF (32-bit tag value) **Type:** number **Range:** 0-4294967295 **type** **Description** 'bgp': Border Gateway Protocol (BGP); 'connected': Connected; 'floating-ip': Floating IP; 'ip-nat-list': IP NAT list; 'lw4o6': LW4O6 Prefix; 'nat-map': NAT MAP Prefix; 'static-nat': Static NAT; 'isis': ISO IS-IS; 'rip': Routing Information Protocol (RIP); 'static': Static routes; **Type:** string **Supported Values:** bgp, connected, floating-ip, ip-nat-list, lw4o6, nat-map, static-nat, isis, rip, static .. _2537_redistribute_ospf-list: redistribute_ospf-list ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **metric-ospf** **Description** OSPF default metric (OSPF metric) **Type:** number **Range:** 0-16777214 **metric-type-ospf** **Description** '1': Set OSPF External Type 1 metrics; '2': Set OSPF External Type 2 metrics; **Type:** string **Supported Values:** 1, 2 **Default:** 2 **ospf** **Description** Open Shortest Path First (OSPF) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **process-id** **Description** OSPF process ID **Type:** number **Range:** 1-65535 **route-map-ospf** **Description** Route map reference (Pointer to route-map entries) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **tag-ospf** **Description** Set tag for routes redistributed into OSPF (32-bit tag value) **Type:** number **Range:** 0-4294967295 .. _2537_redistribute_ip-nat-floating-list: redistribute_ip-nat-floating-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ip-nat-floating-IP-forward** **Description** Floating-IP as forward address **Type:** string **Format:** ipv4-address **ip-nat-prefix** **Description** Address **Type:** string **Format:** ipv4-cidr .. _2537_redistribute_vip-list: redistribute_vip-list ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **metric-type-vip** **Description** '1': Set OSPF External Type 1 metrics; '2': Set OSPF External Type 2 metrics; **Type:** string **Supported Values:** 1, 2 **Default:** 2 **metric-vip** **Description** OSPF default metric (OSPF metric) **Type:** number **Range:** 0-16777214 **route-map-vip** **Description** Route map reference (Pointer to route-map entries) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **tag-vip** **Description** Set tag for routes redistributed into OSPF (32-bit tag value) **Type:** number **Range:** 0-2147483647 **type-vip** **Description** 'only-flagged': Selected Virtual IP (VIP); 'only-not-flagged': Only not flagged; **Type:** string **Supported Values:** only-flagged, only-not-flagged .. _2537_redistribute_vip-floating-list: redistribute_vip-floating-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **vip-address** **Description** Address **Type:** string **Format:** ipv4-address **vip-floating-IP-forward** **Description** Floating-IP as forward address **Type:** string **Format:** ipv4-address .. _2537_network-list: network-list ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **network-area** **Description:** network-area is a **JSON Block**. Please see below for :ref:`2537_network-list_network-area` **Type:** Object **network-ipv4** **Description** Network number **Type:** string **Format:** ipv4-address **network-ipv4-cidr** **Description** OSPF network prefix **Type:** string **Format:** ipv4-cidr **network-ipv4-mask** **Description** OSPF wild card bits **Type:** string **Format:** ipv4-rev-netmask .. _2537_network-list_network-area: network-list_network-area ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **instance-value** **Description** Instance ID **Type:** number **Range:** 0-255 **Default:** 0 **network-area-ipv4** **Description** OSPF area ID in IP address format **Type:** string **Format:** ipv4-address **network-area-num** **Description** OSPF area ID as a decimal value **Type:** number **Range:** 0-4294967295 .. _2537_timers: timers ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **spf** **Description:** spf is a **JSON Block**. Please see below for :ref:`2537_timers_spf` **Type:** Object .. _2537_timers_spf: timers_spf ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **exp** **Description:** exp is a **JSON Block**. Please see below for :ref:`2537_timers_spf_exp` **Type:** Object .. _2537_timers_spf_exp: timers_spf_exp ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **max-delay** **Description** Maximum delay between receiving a change to SPF calculation in milliseconds **Type:** number **Range:** 0-2147483647 **Default:** 50000 **min-delay** **Description** Minimum delay between receiving a change to SPF calculation in milliseconds **Type:** number **Range:** 0-2147483647 **Default:** 500 .. _2537_ha-standby-extra-cost: ha-standby-extra-cost ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **extra-cost** **Description** The extra cost value **Type:** number **Range:** 1-65535 **group** **Description** Group (Group ID) **Type:** number **Range:** 0-31