.. _router_ipv6_ospf: router ipv6 ospf ================ Open Shortest Path First (OSPFv3) ospf Specification ------------------ ===================================== ====================================================================== **Parameter** **Value** ===================================== ====================================================================== **Type** *Collection* **Object Key(s)** *process-id* **Collection Name** :ref:`2518_ospf_list` **Collection URI** /axapi/v3/router/ipv6/ospf **Element Name** ospf **Element URI** /axapi/v3/router/ipv6/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/ipv6/ospf .. raw:: html :ref:`2518_ospf_attributes` .. raw:: html
Create List .. raw:: html POST .. raw:: html /axapi/v3/router/ipv6/ospf .. raw:: html :ref:`2518_ospf_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/router/ipv6/ospf/{process-id} .. raw:: html :ref:`2518_ospf_attributes` .. raw:: html
Get List .. raw:: html GET .. raw:: html /axapi/v3/router/ipv6/ospf .. raw:: html :ref:`2518_ospf_list` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/router/ipv6/ospf/{process-id} .. raw:: html :ref:`2518_ospf_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/router/ipv6/ospf/{process-id} .. raw:: html :ref:`2518_ospf_attributes` .. raw:: html
Replace List .. raw:: html PUT .. raw:: html /axapi/v3/router/ipv6/ospf .. raw:: html :ref:`2518_ospf_list` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/router/ipv6/ospf/{process-id} .. raw:: html :ref:`2518_ospf_attributes` .. raw:: html
.. _2518_ospf_list: ospf-list --------- ospf-list is **JSON List** of :ref:`2518_ospf_attributes` ospf-list : [ { :ref:`2518_ospf_attributes` }, { :ref:`2518_ospf_attributes` }, ... ] .. _2518_ospf_attributes: ospf attributes --------------- **abr-type-option** **Description** 'cisco': Alternative ABR, Cisco implementation (RFC3509); 'ibm': Alternative ABR, IBM implementation (RFC3509); 'standard': Standard behavior (RFC2328); **Type:** string **Supported Values:** cisco, ibm, standard **Default:** cisco **area-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/ipv6/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:`2518_default-information` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/ipv6/ospf/{process-id}/default-information ` **default-metric** **Description** Set metric of redistributed routes (Default metric) **Type:** number **Range:** 1-16777214 **Default:** 20 **distribute-internal-list** **Type:** List **distribute-list** **Description:** distribute-list is a **JSON Block**. Please see below for :ref:`2518_distribute-list` **Type:** Object **ha-standby-extra-cost** **Type:** List **log-adjacency-changes** **Description** 'detail': Log changes in adjacency state; 'disable': Disable logging; **Type:** string **Supported Values:** detail, disable **max-concurrent-dd** **Description** Maximum number allowed to process DD concurrently (Number of DD process) **Type:** number **Range:** 1-65535 **Default:** 5 **passive-interface** **Description:** passive-interface is a **JSON Block**. Please see below for :ref:`2518_passive-interface` **Type:** Object **process-id** **Description** OSPFv3 process tag **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Default:** 0 **redistribute** **Description:** redistribute is a **JSON Block**. Please see below for :ref:`2518_redistribute` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/ipv6/ospf/{process-id}/redistribute ` **router-id** **Description** router-id for the OSPF process (OSPFv3 router-id in IPv4 address format) **Type:** string **Format:** ipv4-address **timers** **Description:** timers is a **JSON Block**. Please see below for :ref:`2518_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 .. _2518_distribute-internal-list: distribute-internal-list ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **area-ipv4** **Description** OSPF area ID in IP address format **Type:** string **Format:** ipv4-address **Default:** 255.255.255.255 **area-num** **Description** OSPF area ID as a decimal value **Type:** number **Range:** 0-4294967295 **cost** **Description** Cost **Type:** number **Range:** 1-65535 **Default:** 1 **type** **Description** 'lw4o6': LW4O6 Prefix; 'nat64': NAT64 Prefix; 'static-nat': Static NAT; 'floating-ip': Floating IP; 'ip-nat': IP NAT; 'ip-nat-list': IP NAT list; 'vip': Only not flagged Virtual IP (VIP); 'vip-only-flagged': Selected Virtual IP (VIP); **Type:** string **Supported Values:** lw4o6, nat64, static-nat, floating-ip, ip-nat, ip-nat-list, vip, vip-only-flagged .. _2518_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** OSPFV3 default metric (OSPFV3 metric) **Type:** number **Range:** 0-16777214 **metric-type-ip-nat** **Description** '1': Set OSPFV3 External Type 1 metrics; '2': Set OSPFV3 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 **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 .. _2518_redistribute_redist-list: redistribute_redist-list ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **metric** **Description** OSPFV3 default metric (OSPFV3 metric) **Type:** number **Range:** 0-16777214 **metric-type** **Description** '1': Set OSPFV3 External Type 1 metrics; '2': Set OSPFV3 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 **type** **Description** 'bgp': Border Gateway Protocol (BGP); 'connected': Connected; 'floating-ip': Floating IP; 'ip-nat-list': IP NAT list; 'nat-map': NAT MAP Prefix; 'static-nat': Static NAT; 'nat64': NAT64 Prefix; 'lw4o6': LW4O6 Prefix; 'isis': ISO IS-IS; 'rip': Routing Information Protocol (RIP); 'static': Static routes; **Type:** string **Supported Values:** bgp, connected, floating-ip, ip-nat-list, nat-map, static-nat, nat64, lw4o6, isis, rip, static .. _2518_redistribute_ospf-list: redistribute_ospf-list ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **metric-ospf** **Description** OSPFV3 default metric (OSPFV3 metric) **Type:** number **Range:** 0-16777214 **metric-type-ospf** **Description** '1': Set OSPFV3 External Type 1 metrics; '2': Set OSPFV3 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** OSPFV3 process tag **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **route-map-ospf** **Description** Route map reference (Pointer to route-map entries) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _2518_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:** ipv6-address **ip-nat-prefix** **Description** Address **Type:** string **Format:** ipv6-address-plen .. _2518_redistribute_vip-list: redistribute_vip-list ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **metric-type-vip** **Description** '1': Set OSPFV3 External Type 1 metrics; '2': Set OSPFV3 External Type 2 metrics; **Type:** string **Supported Values:** 1, 2 **Default:** 2 **metric-vip** **Description** OSPFV3 default metric (OSPFV3 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 **type-vip** **Description** 'only-flagged': Selected Virtual IP (VIP); 'only-not-flagged': Only not flagged; **Type:** string **Supported Values:** only-flagged, only-not-flagged .. _2518_redistribute_vip-floating-list: redistribute_vip-floating-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **vip-address** **Description** Address **Type:** string **Format:** ipv6-address **vip-floating-IP-forward** **Description** Floating-IP as forward address **Type:** string **Format:** ipv6-address .. _2518_distribute-list: distribute-list ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **prefix-list** **Description:** prefix-list is a **JSON Block**. Please see below for :ref:`2518_distribute-list_prefix-list` **Type:** Object .. _2518_distribute-list_prefix-list: distribute-list_prefix-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **direction** **Description** 'in': Filter incoming routing updates; **Type:** string **Supported Values:** in **value** **Description** Prefix-list name **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _2518_area-list: area-list ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **area-ipv4** **Description** OSPFv3 area ID in IP address format **Type:** string **Format:** ipv4-address **area-num** **Description** OSPFv3 area ID as a decimal value **Type:** number **Range:** 0-4294967295 **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 **no-summary** **Description** Do not inject inter-area routes into area **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **range-list** **Type:** List **stub** **Description** Configure OSPFv3 area as stub **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **virtual-link-list** **Type:** List .. _2518_area-list_virtual-link-list: area-list_virtual-link-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **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 **instance-id** **Description** OSPFv3 instance ID **Type:** number **Range:** 0-255 **Default:** 0 **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 **value** **Description** ID (IP addr) associated with virtual link neighbor **Type:** string **Format:** ipv4-address .. _2518_area-list_range-list: area-list_range-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **option** **Description** 'advertise': Advertise this range (default); 'not-advertise': DoNotAdvertise this range; **Type:** string **Supported Values:** advertise, not-advertise **value** **Description** Area range for IPv6 prefix **Type:** string **Format:** ipv6-address-plen .. _2518_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 .. _2518_passive-interface: passive-interface ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **eth-cfg** **Type:** List **loopback-cfg** **Type:** List **trunk-cfg** **Type:** List **tunnel-cfg** **Type:** List **ve-cfg** **Type:** List .. _2518_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 .. _2518_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 .. _2518_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 .. _2518_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 .. _2518_passive-interface_eth-cfg: passive-interface_eth-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface .. _2518_timers: timers ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **spf** **Description:** spf is a **JSON Block**. Please see below for :ref:`2518_timers_spf` **Type:** Object .. _2518_timers_spf: timers_spf ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **exp** **Description:** exp is a **JSON Block**. Please see below for :ref:`2518_timers_spf_exp` **Type:** Object .. _2518_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 .. _2518_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