.. _router: router ====== Configure routing process router Specification -------------------- ===================================== =============================================== ===================================== =============================================== **Type** *Intermediate Resource* **Element Name** router **Element URI** /axapi/v3/router **Element Attributes** router_attributes **Schema** :download:`router schema ` ===================================== =============================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/router .. raw:: html router_attributes .. raw:: html
.. _1521_router_attributes: router attributes ----------------- **bgp-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number} ` **ipv6** **Description:** ipv6 is a **JSON Block**. Please see below for :ref:`1521_ipv6` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/ipv6 ` **isis-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/isis/{tag} ` **log** **Description:** log is a **JSON Block**. Please see below for :ref:`1521_log` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/log ` **ospf-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/ospf/{process-id} ` **rip** **Description:** rip is a **JSON Block**. Please see below for :ref:`1521_rip` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/rip ` .. _1521_ospf-list: ospf-list ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **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:`1521_ospf-list_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:`1521_ospf-list_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:`1521_ospf-list_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:`1521_ospf-list_ospf-1` **Type:** Object **overflow** **Description:** overflow is a **JSON Block**. Please see below for :ref:`1521_ospf-list_overflow` **Type:** Object **passive-interface** **Description:** passive-interface is a **JSON Block**. Please see below for :ref:`1521_ospf-list_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:`1521_ospf-list_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:`1521_ospf-list_router-id` **Type:** Object **summary-address-list** **Type:** List **timers** **Description:** timers is a **JSON Block**. Please see below for :ref:`1521_ospf-list_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 .. _1521_ospf-list_distribute-internal-list: ospf-list_distribute-internal-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_distribute-lists: ospf-list_distribute-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_router-id: ospf-list_router-id ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **value** **Description** OSPF router-id in IPv4 address format **Type:** string **Format:** ipv4-address .. _1521_ospf-list_neighbor-list: ospf-list_neighbor-list ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_ospf-1: ospf-list_ospf-1 ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **abr-type** **Description:** abr-type is a **JSON Block**. Please see below for :ref:`1521_ospf-list_ospf-1_abr-type` **Type:** Object .. _1521_ospf-list_ospf-1_abr-type: ospf-list_ospf-1_abr-type ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_host-list: ospf-list_host-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **area-cfg** **Description:** area-cfg is a **JSON Block**. Please see below for :ref:`1521_ospf-list_host-list_area-cfg` **Type:** Object **host-address** **Description** Host address **Type:** string **Format:** ipv4-address .. _1521_ospf-list_host-list_area-cfg: ospf-list_host-list_area-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_log-adjacency-changes-cfg: ospf-list_log-adjacency-changes-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **state** **Description** 'detail': Log changes in adjacency state; 'disable': Disable logging; **Type:** string **Supported Values:** detail, disable .. _1521_ospf-list_area-list: ospf-list_area-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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:`1521_ospf-list_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:`1521_ospf-list_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:`1521_ospf-list_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 .. _1521_ospf-list_area-list_nssa-cfg: ospf-list_area-list_nssa-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_area-list_filter-lists: ospf-list_area-list_filter-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_area-list_virtual-link-list: ospf-list_area-list_virtual-link-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_area-list_stub-cfg: ospf-list_area-list_stub-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_area-list_auth-cfg: ospf-list_area-list_auth-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_area-list_range-list: ospf-list_area-list_range-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_summary-address-list: ospf-list_summary-address-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_passive-interface: ospf-list_passive-interface ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_passive-interface_tunnel-cfg: ospf-list_passive-interface_tunnel-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_passive-interface_loopback-cfg: ospf-list_passive-interface_loopback-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_passive-interface_ve-cfg: ospf-list_passive-interface_ve-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_passive-interface_lif-cfg: ospf-list_passive-interface_lif-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **lif** **Description** Logical interface (Lif interface number) **Type:** number **Format:** interface **lif-address** **Description** Address of Interface **Type:** string **Format:** ipv4-address .. _1521_ospf-list_passive-interface_trunk-cfg: ospf-list_passive-interface_trunk-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_passive-interface_eth-cfg: ospf-list_passive-interface_eth-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_default-information: ospf-list_default-information ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_overflow: ospf-list_overflow ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **database** **Description:** database is a **JSON Block**. Please see below for :ref:`1521_ospf-list_overflow_database` **Type:** Object .. _1521_ospf-list_overflow_database: ospf-list_overflow_database ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_distance: ospf-list_distance ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **distance-ospf** **Description:** distance-ospf is a **JSON Block**. Please see below for :ref:`1521_ospf-list_distance_distance-ospf` **Type:** Object **distance-value** **Description** OSPF Administrative distance **Type:** number **Range:** 1-255 **Default:** 110 .. _1521_ospf-list_distance_distance-ospf: ospf-list_distance_distance-ospf ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_redistribute: ospf-list_redistribute ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_redistribute_redist-list: ospf-list_redistribute_redist-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_redistribute_ospf-list: ospf-list_redistribute_ospf-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_redistribute_ip-nat-floating-list: ospf-list_redistribute_ip-nat-floating-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_redistribute_vip-list: ospf-list_redistribute_vip-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_redistribute_vip-floating-list: ospf-list_redistribute_vip-floating-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_network-list: ospf-list_network-list ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **network-area** **Description:** network-area is a **JSON Block**. Please see below for :ref:`1521_ospf-list_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 .. _1521_ospf-list_network-list_network-area: ospf-list_network-list_network-area ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_timers: ospf-list_timers ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **spf** **Description:** spf is a **JSON Block**. Please see below for :ref:`1521_ospf-list_timers_spf` **Type:** Object .. _1521_ospf-list_timers_spf: ospf-list_timers_spf ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **exp** **Description:** exp is a **JSON Block**. Please see below for :ref:`1521_ospf-list_timers_spf_exp` **Type:** Object .. _1521_ospf-list_timers_spf_exp: ospf-list_timers_spf_exp ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ospf-list_ha-standby-extra-cost: ospf-list_ha-standby-extra-cost ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_log: log ^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **file** **Description:** file is a **JSON Block**. Please see below for :ref:`1521_log_file` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/log/file ` **log-buffer** **Description** Logging goes to log-buffer **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1521_log_file: log_file ^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **name** **Description** Logging filename (File name) **Type:** string **Maximum Length:** 32 characters **Maximum Length:** 1 characters **per-protocol** **Description** Per protocol **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **rotate** **Description** Log file rotation (Number of backup files) **Type:** number **Range:** 0-100 **size** **Description** Log file maximum size (File size in MBytes) **Type:** number **Range:** 0-1000000 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1521_rip: rip ^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **cisco-metric-behavior** **Description** 'enable': Enables updating metric consistent with Cisco; 'disable': Disables updating metric consistent with Cisco; (Enable/Disable updating metric consistent with Cisco) **Type:** string **Supported Values:** enable, disable **Default:** disable **default-information** **Description** 'originate': originate; (Distribute default route) **Type:** string **Supported Values:** originate **default-metric** **Description** Set a metric of redistribute routes (Default metric) **Type:** number **Range:** 1-16 **Default:** 1 **distance-list-cfg** **Type:** List **distribute-list** **Description:** distribute-list is a **JSON Block**. Please see below for :ref:`1521_rip_distribute-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/rip/distribute-list ` **neighbor** **Type:** List **network-addresses** **Type:** List **network-interface-list-cfg** **Type:** List **offset-list** **Description:** offset-list is a **JSON Block**. Please see below for :ref:`1521_rip_offset-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/rip/offset-list ` **passive-interface-list** **Type:** List **recv-buffer-size** **Description** Set the RIP UDP receive buffer size (the RIP UDP receive buffer size value) **Type:** number **Range:** 8192-2147483647 **redistribute** **Description:** redistribute is a **JSON Block**. Please see below for :ref:`1521_rip_redistribute` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/rip/redistribute ` **rip-maximum-prefix-cfg** **Description:** rip-maximum-prefix-cfg is a **JSON Block**. Please see below for :ref:`1521_rip_rip-maximum-prefix-cfg` **Type:** Object **route-cfg** **Type:** List **timers** **Description:** timers is a **JSON Block**. Please see below for :ref:`1521_rip_timers` **Type:** Object **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **version** **Description** Set routing protocol version (RIP version) **Type:** number **Range:** 1-2 **Default:** 2 .. _1521_rip_rip-maximum-prefix-cfg: rip_rip-maximum-prefix-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **maximum-prefix** **Description** Set the maximum number of RIP routes **Type:** number **Range:** 1-2048 **maximum-prefix-thres** **Description** Percentage of maximum routes to generate a warning (Default 75%) **Type:** number **Range:** 1-100 **Default:** 75 .. _1521_rip_route-cfg: rip_route-cfg ^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **route** **Description** Static route advertisement (debugging purpose) (IP prefix network/length) **Type:** string **Format:** ipv4-cidr .. _1521_rip_passive-interface-list: rip_passive-interface-list ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface .. _1521_rip_redistribute: rip_redistribute ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **redist-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vip-list** **Type:** List .. _1521_rip_redistribute_vip-list: rip_redistribute_vip-list ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **vip-metric** **Description** Metric for redistributed routes (metric value) **Type:** number **Range:** 0-16 **vip-route-map** **Description** Route map reference (Pointer to route-map entries) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **vip-type** **Description** 'only-flagged': Selected Virtual IP (VIP); 'only-not-flagged': Only not flagged; **Type:** string **Supported Values:** only-flagged, only-not-flagged .. _1521_rip_redistribute_redist-list: rip_redistribute_redist-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **metric** **Description** Metric for redistributed routes (metric value) **Type:** number **Range:** 0-16 **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; 'ip-nat': IP NAT; 'isis': ISO IS-IS; 'lw4o6': LW4O6 Prefix; 'nat-map': NAT MAP Prefix; 'static-nat': Static NAT; 'ospf': Open Shortest Path First (OSPF); 'static': Static routes; **Type:** string **Supported Values:** bgp, connected, floating-ip, ip-nat-list, ip-nat, isis, lw4o6, nat-map, static-nat, ospf, static .. _1521_rip_network-interface-list-cfg: rip_network-interface-list-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface .. _1521_rip_timers: rip_timers ^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **timers-cfg** **Description:** timers-cfg is a **JSON Block**. Please see below for :ref:`1521_rip_timers_timers-cfg` **Type:** Object .. _1521_rip_timers_timers-cfg: rip_timers_timers-cfg ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **basic** **Description** Basic routing protocol update timers (Routing table update timer value in second. Default is 30) **Type:** number **Range:** 5-2147483647 **val-2** **Description** Routing information timeout timer. Default is 180 **Type:** number **Range:** 5-2147483647 **val-3** **Description** Garbage collection timer. Default is 120 **Type:** number **Range:** 5-2147483647 .. _1521_rip_neighbor: rip_neighbor ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **value** **Description** Neighbor address **Type:** string **Format:** ipv4-address .. _1521_rip_offset-list: rip_offset-list ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **acl-cfg** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1521_rip_offset-list_acl-cfg: rip_offset-list_acl-cfg ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **acl** **Description** Access-list name **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **metric** **Description** Metric value **Type:** number **Range:** 0-16 **offset-list-direction** **Description** 'in': Filter incoming updates; 'out': Filter outgoing updates; **Type:** string **Supported Values:** in, out **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface .. _1521_rip_distribute-list: rip_distribute-list ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **acl-cfg** **Type:** List **prefix** **Description:** prefix is a **JSON Block**. Please see below for :ref:`1521_rip_distribute-list_prefix` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/rip/distribute-list/prefix ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1521_rip_distribute-list_acl-cfg: rip_distribute-list_acl-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **acl** **Description** Access-list name **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **acl-direction** **Description** 'in': Filter incoming routing updates; 'out': Filter outgoing routing updates; **Type:** string **Supported Values:** in, out **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface .. _1521_rip_distribute-list_prefix: rip_distribute-list_prefix ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **prefix-cfg** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1521_rip_distribute-list_prefix_prefix-cfg: rip_distribute-list_prefix_prefix-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **prefix-list** **Description** Filter prefixes in routing updates (Name of a prefix list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **prefix-list-direction** **Description** 'in': Filter incoming routing updates; 'out': Filter outgoing routing updates; **Type:** string **Supported Values:** in, out **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface .. _1521_rip_distance-list-cfg: rip_distance-list-cfg ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **distance** **Description** Administrative distance (Distance value) **Type:** number **Range:** 1-255 **Default:** 120 **distance-acl** **Description** Access list name **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **distance-ipv4-mask** **Description** IP source prefix **Type:** string **Format:** ipv4-cidr .. _1521_rip_network-addresses: rip_network-addresses ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **network-ipv4-mask** **Description** IP prefix network/length, e.g., 35.0.0.0/8 **Type:** string **Format:** ipv4-cidr .. _1521_bgp-list: bgp-list ^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **address-family** **Description:** address-family is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family ` **aggregate-address-list** **Type:** List **as-number** **Description** AS number **Type:** number **Range:** 1-4294967295 **auto-summary** **Description** Enable automatic network number summarization **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bgp** **Description:** bgp is a **JSON Block**. Please see below for :ref:`1521_bgp-list_bgp` **Type:** Object **distance-list** **Type:** List **maximum-paths-value** **Description** Supported BGP multipath numbers **Type:** number **Range:** 1-64 **Default:** 1 **neighbor** **Description:** neighbor is a **JSON Block**. Please see below for :ref:`1521_bgp-list_neighbor` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/neighbor ` **network** **Description:** network is a **JSON Block**. Please see below for :ref:`1521_bgp-list_network` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/network ` **originate** **Description** Distribute a default route **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **redistribute** **Description:** redistribute is a **JSON Block**. Please see below for :ref:`1521_bgp-list_redistribute` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/redistribute ` **synchronization** **Description** Perform IGP synchronization **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **timers** **Description:** timers is a **JSON Block**. Please see below for :ref:`1521_bgp-list_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 .. _1521_bgp-list_redistribute: bgp-list_redistribute ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **connected-cfg** **Description:** connected-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_redistribute_connected-cfg` **Type:** Object **floating-ip-cfg** **Description:** floating-ip-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_redistribute_floating-ip-cfg` **Type:** Object **ip-nat-cfg** **Description:** ip-nat-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_redistribute_ip-nat-cfg` **Type:** Object **ip-nat-list-cfg** **Description:** ip-nat-list-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_redistribute_ip-nat-list-cfg` **Type:** Object **isis-cfg** **Description:** isis-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_redistribute_isis-cfg` **Type:** Object **lw4o6-cfg** **Description:** lw4o6-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_redistribute_lw4o6-cfg` **Type:** Object **nat-map-cfg** **Description:** nat-map-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_redistribute_nat-map-cfg` **Type:** Object **ospf-cfg** **Description:** ospf-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_redistribute_ospf-cfg` **Type:** Object **rip-cfg** **Description:** rip-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_redistribute_rip-cfg` **Type:** Object **static-cfg** **Description:** static-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_redistribute_static-cfg` **Type:** Object **static-nat-cfg** **Description:** static-nat-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_redistribute_static-nat-cfg` **Type:** Object **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vip** **Description:** vip is a **JSON Block**. Please see below for :ref:`1521_bgp-list_redistribute_vip` **Type:** Object .. _1521_bgp-list_redistribute_ip-nat-list-cfg: bgp-list_redistribute_ip-nat-list-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ip-nat-list** **Description** IP NAT list **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 .. _1521_bgp-list_redistribute_lw4o6-cfg: bgp-list_redistribute_lw4o6-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **lw4o6** **Description** LW4O6 Prefix **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 .. _1521_bgp-list_redistribute_connected-cfg: bgp-list_redistribute_connected-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **connected** **Description** Connected **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 .. _1521_bgp-list_redistribute_vip: bgp-list_redistribute_vip ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **only-flagged-cfg** **Description:** only-flagged-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_redistribute_vip_only-flagged-cfg` **Type:** Object **only-not-flagged-cfg** **Description:** only-not-flagged-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_redistribute_vip_only-not-flagged-cfg` **Type:** Object .. _1521_bgp-list_redistribute_vip_only-not-flagged-cfg: bgp-list_redistribute_vip_only-not-flagged-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **only-not-flagged** **Description** Only not flagged **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 .. _1521_bgp-list_redistribute_vip_only-flagged-cfg: bgp-list_redistribute_vip_only-flagged-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **only-flagged** **Description** Selected Virtual IP (VIP) **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 .. _1521_bgp-list_redistribute_ip-nat-cfg: bgp-list_redistribute_ip-nat-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ip-nat** **Description** IP NAT **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 .. _1521_bgp-list_redistribute_floating-ip-cfg: bgp-list_redistribute_floating-ip-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **floating-ip** **Description** Floating IP **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 .. _1521_bgp-list_redistribute_isis-cfg: bgp-list_redistribute_isis-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **isis** **Description** ISO IS-IS **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 .. _1521_bgp-list_redistribute_nat-map-cfg: bgp-list_redistribute_nat-map-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **nat-map** **Description** NAT MAP Prefix **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 .. _1521_bgp-list_redistribute_rip-cfg: bgp-list_redistribute_rip-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **rip** **Description** Routing Information Protocol (RIP) **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 .. _1521_bgp-list_redistribute_ospf-cfg: bgp-list_redistribute_ospf-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ospf** **Description** Open Shortest Path First (OSPF) **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 .. _1521_bgp-list_redistribute_static-nat-cfg: bgp-list_redistribute_static-nat-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **route-map** **Description** Route map reference (Pointer to route-map entries) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **static-nat** **Description** Static NAT Prefix **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1521_bgp-list_redistribute_static-cfg: bgp-list_redistribute_static-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **route-map** **Description** Route map reference (Pointer to route-map entries) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **static** **Description** Static routes **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1521_bgp-list_aggregate-address-list: bgp-list_aggregate-address-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **aggregate-address** **Description** Configure BGP aggregate entries (Aggregate prefix) **Type:** string **Format:** ipv4-cidr **as-set** **Description** Generate AS set path information **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **summary-only** **Description** Filter more specific routes from updates **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1521_bgp-list_bgp: bgp-list_bgp ^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **always-compare-med** **Description** Allow comparing MED from different neighbors **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bestpath-cfg** **Description:** bestpath-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_bgp_bestpath-cfg` **Type:** Object **bgp-restart-time** **Description** BGP Peer Graceful Restart time in seconds (default 90) **Type:** number **Range:** 1-3600 **Default:** 90 **bgp-stalepath-time** **Description** BGP Graceful Restart Stalepath retention time in seconds (default 360) **Type:** number **Range:** 1-3600 **Default:** 360 **dampening-cfg** **Description:** dampening-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_bgp_dampening-cfg` **Type:** Object **deterministic-med** **Description** Pick the best-MED path among paths advertised from the neighboring AS **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enforce-first-as** **Description** Enforce the first AS for EBGP routes **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **fast-external-failover** **Description** Immediately reset session if a link to a directly connected external peer goes down **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **graceful-restart** **Description** Configure BGP BGP Graceful Restart **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **local-preference-value** **Description** Configure default local preference value **Type:** number **Range:** 0-4294967295 **Default:** 100 **log-neighbor-changes** **Description** Log neighbor up/down and reset reason **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **nexthop-trigger-count** **Description** BGP nexthop-tracking status (count) **Type:** number **Range:** 0-127 **Default:** 0 **override-validation** **Description** override router-id validation **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **router-id** **Description** Override current router identifier (peers will reset) (Manually configured router identifier) **Type:** string **Format:** ipv4-address **scan-time** **Description** Configure background scan interval (Scan interval (sec) [Default:60 Disable:0]) **Type:** number **Range:** 0-60 **Default:** 60 .. _1521_bgp-list_bgp_dampening-cfg: bgp-list_bgp_dampening-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **dampening** **Description** Enable route-flap dampening **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dampening-half-time** **Description** Reachability Half-life time for the penalty(minutes) **Type:** number **Range:** 1-45 **dampening-max-supress** **Description** Maximum duration to suppress a stable route(minutes) **Type:** number **Range:** 1-255 **dampening-penalty** **Description** Un-reachability Half-life time for the penalty(minutes) **Type:** number **Range:** 1-45 **dampening-reuse** **Description** Value to start reusing a route **Type:** number **Range:** 1-20000 **dampening-supress** **Description** Value to start suppressing a route **Type:** number **Range:** 1-20000 **route-map** **Description** Route-map to specify criteria for dampening (Route-map name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _1521_bgp-list_bgp_bestpath-cfg: bgp-list_bgp_bestpath-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **compare-routerid** **Description** Compare router-id for identical EBGP paths **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ignore** **Description** Ignore as-path length in selecting a route **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **missing-as-worst** **Description** Treat missing MED as the least preferred one **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **remove-recv-med** **Description** To remove rcvd MED attribute **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **remove-send-med** **Description** To remove send MED attribute **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1521_bgp-list_network: bgp-list_network ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ip-cidr-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/network/ip-cidr/{network-ipv4-cidr} ` **synchronization** **Description:** synchronization is a **JSON Block**. Please see below for :ref:`1521_bgp-list_network_synchronization` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/network/synchronization ` .. _1521_bgp-list_network_synchronization: bgp-list_network_synchronization ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **network-synchronization** **Description** Perform IGP synchronization **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 .. _1521_bgp-list_network_ip-cidr-list: bgp-list_network_ip-cidr-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **backdoor** **Description** Specify a BGP backdoor route **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **comm-value** **Description** community value in the format 1-4294967295|AA:NN|internet|local-AS|no-advertise|no-export **Type:** string **Format:** string-rlx **description** **Description** Network specific description (Up to 80 characters describing this network) **Type:** string **Format:** string-rlx **Maximum Length:** 80 characters **Maximum Length:** 1 characters **network-ipv4-cidr** **Description** Specify network mask **Type:** string **Format:** ipv4-cidr **route-map** **Description** Route-map to modify the attributes (Name of the route map) **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 .. _1521_bgp-list_timers: bgp-list_timers ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **bgp-holdtime** **Description** Holdtime **Type:** number **Range:** 0-65535 **Default:** 90 **bgp-keepalive** **Description** Keepalive interval **Type:** number **Range:** 0-65535 **Default:** 30 .. _1521_bgp-list_neighbor: bgp-list_neighbor ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ethernet-neighbor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/neighbor/ethernet-neighbor/{ethernet} ` **ipv4-neighbor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/neighbor/ipv4-neighbor/{neighbor-ipv4} ` **ipv6-neighbor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/neighbor/ipv6-neighbor/{neighbor-ipv6} ` **peer-group-neighbor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/neighbor/peer-group-neighbor/{peer-group} ` **trunk-neighbor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/neighbor/trunk-neighbor/{trunk} ` **ve-neighbor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/neighbor/ve-neighbor/{ve} ` .. _1521_bgp-list_neighbor_ve-neighbor-list: bgp-list_neighbor_ve-neighbor-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **peer-group-name** **Description** **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **unnumbered** **Description** **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 **ve** **Description** Virtual ethernet interface number **Type:** number **Format:** interface .. _1521_bgp-list_neighbor_ipv4-neighbor-list: bgp-list_neighbor_ipv4-neighbor-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **acos-application-only** **Description** Send BGP update to ACOS application **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **activate** **Description** Enable the Address Family for this Neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **advertisement-interval** **Description** Minimum interval between sending BGP routing updates (time in seconds) **Type:** number **Range:** 1-600 **Mutual Exclusion:** advertisement-interval and peer-group-name are mutually exclusive **allowas-in** **Description** Accept as-path with my AS present in it **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **allowas-in-count** **Description** Number of occurrences of AS number **Type:** number **Range:** 1-10 **Default:** 3 **as-origination-interval** **Description** Minimum interval between sending AS-origination routing updates (time in seconds) **Type:** number **Range:** 1-600 **Mutual Exclusion:** as-origination-interval and peer-group-name are mutually exclusive **bfd** **Description** Bidirectional Forwarding Detection (BFD) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bfd-encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) **bfd-value** **Description** Key String **Type:** string **Format:** password **Maximum Length:** 63 characters **Maximum Length:** 1 characters **collide-established** **Description** Include Neighbor in Established State for Collision Detection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **connect** **Description** BGP connect timer **Type:** number **Range:** 1-65535 **default-originate** **Description** Originate default route to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** default-originate and peer-group-name are mutually exclusive **description** **Description** Neighbor specific description (Up to 80 characters describing this neighbor) **Type:** string **Format:** string-rlx **Maximum Length:** 80 characters **Maximum Length:** 1 characters **disallow-infinite-holdtime** **Description** BGP per neighbor disallow-infinite-holdtime **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** disallow-infinite-holdtime and peer-group-name are mutually exclusive **distribute-lists** **Type:** List **dont-capability-negotiate** **Description** Do not perform capability negotiation **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dynamic** **Description** Advertise dynamic capability to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ebgp-multihop** **Description** Allow EBGP neighbors not on directly connected networks **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ebgp-multihop-hop-count** **Description** maximum hop count **Type:** number **Range:** 1-255 **enforce-multihop** **Description** Enforce EBGP neighbors to perform multihop **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **Mutual Exclusion:** ethernetupdate-source-ip, update-source-ipv6, loopback, ve, trunk, lif and tunnel are mutually exclusive **graceful-restart** **Description** enable graceful-restart helper for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **inbound** **Description** Allow inbound soft reconfiguration for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **key-id** **Description** Key ID **Type:** number **Range:** 0-255 **key-type** **Description** 'md5': md5; 'meticulous-md5': meticulous-md5; 'meticulous-sha1': meticulous-sha1; 'sha1': sha1; 'simple': simple; (Keyed MD5/Meticulous Keyed MD5/Meticulous Keyed SHA1/Keyed SHA1/Simple Password) **Type:** string **Supported Values:** md5, meticulous-md5, meticulous-sha1, sha1, simple **lif** **Description** Logical interface (Lif interface name) **Type:** string **Maximum Length:** 15 characters **Maximum Length:** 1 characters **Mutual Exclusion:** lifupdate-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk and tunnel are mutually exclusive **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **Mutual Exclusion:** loopbackupdate-source-ip, update-source-ipv6, ethernet, ve, trunk, lif and tunnel are mutually exclusive **maximum-prefix** **Description** Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model)) **Type:** number **maximum-prefix-thres** **Description** threshold-value, 1 to 100 percent **Type:** number **Range:** 1-100 **multihop** **Description** Enable multihop **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **nbr-remote-as** **Description** Specify AS number of BGP neighbor **Type:** number **Range:** 1-4294967295 **neighbor-filter-lists** **Type:** List **neighbor-ipv4** **Description** Neighbor address **Type:** string **Format:** ipv4-address **neighbor-prefix-lists** **Type:** List **neighbor-route-map-lists** **Type:** List **next-hop-self** **Description** Disable the next hop calculation for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** next-hop-self and peer-group-name are mutually exclusive **override-capability** **Description** Override capability negotiation result **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pass-encrypted** **Description** **pass-value** **Description** Key String **Type:** string **Format:** password **Maximum Length:** 80 characters **Maximum Length:** 1 characters **passive** **Description** Don't send open messages to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **peer-group-name** **Description** Configure peer-group (peer-group name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Mutual Exclusion:** peer-group-nameadvertisement-interval, as-origination-interval, default-originate, disallow-infinite-holdtime, next-hop-self, timers and unsuppress-map are mutually exclusive **prefix-list-direction** **Description** 'both': both; 'receive': receive; 'send': send; **Type:** string **Supported Values:** both, receive, send **remove-private-as** **Description** Remove private AS number from outbound updates **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **restart-min** **Description** restart value, 1 to 1440 minutes **Type:** number **Range:** 1-1440 **route-map** **Description** Route-map to specify criteria to originate default (route-map name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **route-refresh** **Description** Advertise route-refresh capability to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **send-community-val** **Description** 'both': Send Standard and Extended Community attributes; 'none': Disable Sending Community attributes; 'standard': Send Standard Community attributes; 'extended': Send Extended Community attributes; **Type:** string **Supported Values:** both, none, standard, extended **Default:** both **shutdown** **Description** Administratively shut down this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **strict-capability-match** **Description** Strict capability negotiation match **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **timers-holdtime** **Description** Holdtime **Type:** number **Range:** 0-65535 **Default:** 90 **timers-keepalive** **Description** Keepalive interval **Type:** number **Range:** 0-65535 **Default:** 30 **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **Mutual Exclusion:** trunkupdate-source-ip, update-source-ipv6, ethernet, loopback, ve, lif and tunnel are mutually exclusive **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **Mutual Exclusion:** tunnelupdate-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk and lif are mutually exclusive **unsuppress-map** **Description** Route-map to selectively unsuppress suppressed routes (Name of route map) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Mutual Exclusion:** unsuppress-map and peer-group-name are mutually exclusive **update-source-ip** **Description** IP address **Type:** string **Format:** ipv4-address **Mutual Exclusion:** update-source-ipupdate-source-ipv6, ethernet, loopback, ve, trunk, lif and tunnel are mutually exclusive **update-source-ipv6** **Description** IPv6 address **Type:** string **Format:** ipv6-address **Mutual Exclusion:** update-source-ipv6update-source-ip, ethernet, loopback, ve, trunk, lif and tunnel are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface **Mutual Exclusion:** veupdate-source-ip, update-source-ipv6, ethernet, loopback, trunk, lif and tunnel are mutually exclusive **weight** **Description** Set default weight for routes from this neighbor **Type:** number **Range:** 0-65535 **Default:** 0 .. _1521_bgp-list_neighbor_ipv4-neighbor-list_distribute-lists: bgp-list_neighbor_ipv4-neighbor-list_distribute-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **distribute-list** **Description** Filter updates to/from this neighbor (IP standard/extended/named access list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **distribute-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_bgp-list_neighbor_ipv4-neighbor-list_neighbor-route-map-lists: bgp-list_neighbor_ipv4-neighbor-list_neighbor-route-map-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nbr-rmap-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out **nbr-route-map** **Description** Apply route map to neighbor (Name of route map) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _1521_bgp-list_neighbor_ipv4-neighbor-list_neighbor-filter-lists: bgp-list_neighbor_ipv4-neighbor-list_neighbor-filter-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **filter-list** **Description** Establish BGP filters (AS path access-list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **filter-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_bgp-list_neighbor_ipv4-neighbor-list_neighbor-prefix-lists: bgp-list_neighbor_ipv4-neighbor-list_neighbor-prefix-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nbr-prefix-list** **Description** Filter updates to/from this neighbor (Name of a prefix list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **nbr-prefix-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_bgp-list_neighbor_peer-group-neighbor-list: bgp-list_neighbor_peer-group-neighbor-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **activate** **Description** Enable the Address Family for this Neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **advertisement-interval** **Description** Minimum interval between sending BGP routing updates (time in seconds) **Type:** number **Range:** 1-600 **allowas-in** **Description** Accept as-path with my AS present in it **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **allowas-in-count** **Description** Number of occurrences of AS number **Type:** number **Range:** 1-10 **Default:** 3 **as-origination-interval** **Description** Minimum interval between sending AS-origination routing updates (time in seconds) **Type:** number **Range:** 1-600 **bfd** **Description** Bidirectional Forwarding Detection (BFD) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **collide-established** **Description** Include Neighbor in Established State for Collision Detection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **connect** **Description** BGP connect timer **Type:** number **Range:** 1-65535 **default-originate** **Description** Originate default route to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **description** **Description** Neighbor specific description (Up to 80 characters describing this neighbor) **Type:** string **Format:** string-rlx **Maximum Length:** 80 characters **Maximum Length:** 1 characters **disallow-infinite-holdtime** **Description** BGP per neighbor disallow-infinite-holdtime **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **distribute-lists** **Type:** List **dont-capability-negotiate** **Description** Do not perform capability negotiation **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dynamic** **Description** Advertise dynamic capability to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ebgp-multihop** **Description** Allow EBGP neighbors not on directly connected networks **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ebgp-multihop-hop-count** **Description** maximum hop count **Type:** number **Range:** 1-255 **enforce-multihop** **Description** Enforce EBGP neighbors to perform multihop **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **Mutual Exclusion:** ethernetupdate-source-ip, update-source-ipv6, loopback, ve, trunk, lif and tunnel are mutually exclusive **extended-nexthop** **Description** Advertise extended-nexthop capability to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **inbound** **Description** Allow inbound soft reconfiguration for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **lif** **Description** Logical interface (Lif interface name) **Type:** string **Maximum Length:** 15 characters **Maximum Length:** 1 characters **Mutual Exclusion:** lifupdate-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk and tunnel are mutually exclusive **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **Mutual Exclusion:** loopbackupdate-source-ip, update-source-ipv6, ethernet, ve, trunk, lif and tunnel are mutually exclusive **maximum-prefix** **Description** Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model)) **Type:** number **maximum-prefix-thres** **Description** threshold-value, 1 to 100 percent **Type:** number **Range:** 1-100 **multihop** **Description** Enable multihop **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **neighbor-filter-lists** **Type:** List **neighbor-prefix-lists** **Type:** List **neighbor-route-map-lists** **Type:** List **next-hop-self** **Description** Disable the next hop calculation for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **override-capability** **Description** Override capability negotiation result **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pass-encrypted** **Description** **pass-value** **Description** Key String **Type:** string **Format:** password **Maximum Length:** 80 characters **Maximum Length:** 1 characters **passive** **Description** Don't send open messages to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **peer-group** **Description** Neighbor tag **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **peer-group-key** **Description** Configure peer-group **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **peer-group-remote-as** **Description** Specify AS number of BGP neighbor **Type:** number **Range:** 1-4294967295 **prefix-list-direction** **Description** 'both': both; 'receive': receive; 'send': send; **Type:** string **Supported Values:** both, receive, send **remove-private-as** **Description** Remove private AS number from outbound updates **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **route-map** **Description** Route-map to specify criteria to originate default (route-map name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **route-refresh** **Description** Advertise route-refresh capability to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **send-community-val** **Description** 'both': Send Standard and Extended Community attributes; 'none': Disable Sending Community attributes; 'standard': Send Standard Community attributes; 'extended': Send Extended Community attributes; **Type:** string **Supported Values:** both, none, standard, extended **Default:** both **shutdown** **Description** Administratively shut down this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **strict-capability-match** **Description** Strict capability negotiation match **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **timers-holdtime** **Description** Holdtime **Type:** number **Range:** 0-65535 **Default:** 90 **timers-keepalive** **Description** Keepalive interval **Type:** number **Range:** 0-65535 **Default:** 30 **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **Mutual Exclusion:** trunkupdate-source-ip, update-source-ipv6, ethernet, loopback, ve, lif and tunnel are mutually exclusive **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **Mutual Exclusion:** tunnelupdate-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk and lif are mutually exclusive **unsuppress-map** **Description** Route-map to selectively unsuppress suppressed routes (Name of route map) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **update-source-ip** **Description** IP address **Type:** string **Format:** ipv4-address **Mutual Exclusion:** update-source-ipupdate-source-ipv6, ethernet, loopback, ve, trunk, lif and tunnel are mutually exclusive **update-source-ipv6** **Description** IPv6 address **Type:** string **Format:** ipv6-address **Mutual Exclusion:** update-source-ipv6update-source-ip, ethernet, loopback, ve, trunk, lif and tunnel are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface **Mutual Exclusion:** veupdate-source-ip, update-source-ipv6, ethernet, loopback, trunk, lif and tunnel are mutually exclusive **weight** **Description** Set default weight for routes from this neighbor **Type:** number **Range:** 0-65535 **Default:** 0 .. _1521_bgp-list_neighbor_peer-group-neighbor-list_distribute-lists: bgp-list_neighbor_peer-group-neighbor-list_distribute-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **distribute-list** **Description** Filter updates to/from this neighbor (IP standard/extended/named access list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **distribute-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_bgp-list_neighbor_peer-group-neighbor-list_neighbor-route-map-lists: bgp-list_neighbor_peer-group-neighbor-list_neighbor-route-map-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nbr-rmap-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out **nbr-route-map** **Description** Apply route map to neighbor (Name of route map) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _1521_bgp-list_neighbor_peer-group-neighbor-list_neighbor-prefix-lists: bgp-list_neighbor_peer-group-neighbor-list_neighbor-prefix-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nbr-prefix-list** **Description** Filter updates to/from this neighbor (Name of a prefix list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **nbr-prefix-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_bgp-list_neighbor_peer-group-neighbor-list_neighbor-filter-lists: bgp-list_neighbor_peer-group-neighbor-list_neighbor-filter-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **filter-list** **Description** Establish BGP filters (AS path access-list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **filter-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_bgp-list_neighbor_ipv6-neighbor-list: bgp-list_neighbor_ipv6-neighbor-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **acos-application-only** **Description** Send BGP update to ACOS application **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **activate** **Description** Enable the Address Family for this Neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **advertisement-interval** **Description** Minimum interval between sending BGP routing updates (time in seconds) **Type:** number **Range:** 1-600 **Mutual Exclusion:** advertisement-interval and peer-group-name are mutually exclusive **allowas-in** **Description** Accept as-path with my AS present in it **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **allowas-in-count** **Description** Number of occurrences of AS number **Type:** number **Range:** 1-10 **Default:** 3 **as-origination-interval** **Description** Minimum interval between sending AS-origination routing updates (time in seconds) **Type:** number **Range:** 1-600 **Mutual Exclusion:** as-origination-interval and peer-group-name are mutually exclusive **bfd** **Description** Bidirectional Forwarding Detection (BFD) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bfd-encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) **bfd-value** **Description** Key String **Type:** string **Format:** password **Maximum Length:** 63 characters **Maximum Length:** 1 characters **collide-established** **Description** Include Neighbor in Established State for Collision Detection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **connect** **Description** BGP connect timer **Type:** number **Range:** 1-65535 **default-originate** **Description** Originate default route to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** default-originate and peer-group-name are mutually exclusive **description** **Description** Neighbor specific description (Up to 80 characters describing this neighbor) **Type:** string **Format:** string-rlx **Maximum Length:** 80 characters **Maximum Length:** 1 characters **disallow-infinite-holdtime** **Description** BGP per neighbor disallow-infinite-holdtime **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** disallow-infinite-holdtime and peer-group-name are mutually exclusive **distribute-lists** **Type:** List **dont-capability-negotiate** **Description** Do not perform capability negotiation **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dynamic** **Description** Advertise dynamic capability to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ebgp-multihop** **Description** Allow EBGP neighbors not on directly connected networks **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ebgp-multihop-hop-count** **Description** maximum hop count **Type:** number **Range:** 1-255 **enforce-multihop** **Description** Enforce EBGP neighbors to perform multihop **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **Mutual Exclusion:** ethernetupdate-source-ip, update-source-ipv6, loopback, ve, trunk, lif and tunnel are mutually exclusive **extended-nexthop** **Description** Advertise extended-nexthop capability to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **graceful-restart** **Description** enable graceful-restart helper for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **inbound** **Description** Allow inbound soft reconfiguration for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **key-id** **Description** Key ID **Type:** number **Range:** 0-255 **key-type** **Description** 'md5': md5; 'meticulous-md5': meticulous-md5; 'meticulous-sha1': meticulous-sha1; 'sha1': sha1; 'simple': simple; (Keyed MD5/Meticulous Keyed MD5/Meticulous Keyed SHA1/Keyed SHA1/Simple Password) **Type:** string **Supported Values:** md5, meticulous-md5, meticulous-sha1, sha1, simple **lif** **Description** Logical interface (Lif interface name) **Type:** string **Maximum Length:** 15 characters **Maximum Length:** 1 characters **Mutual Exclusion:** lifupdate-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk and tunnel are mutually exclusive **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **Mutual Exclusion:** loopbackupdate-source-ip, update-source-ipv6, ethernet, ve, trunk, lif and tunnel are mutually exclusive **maximum-prefix** **Description** Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model)) **Type:** number **maximum-prefix-thres** **Description** threshold-value, 1 to 100 percent **Type:** number **Range:** 1-100 **multihop** **Description** Enable multihop **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **nbr-remote-as** **Description** Specify AS number of BGP neighbor **Type:** number **Range:** 1-4294967295 **neighbor-filter-lists** **Type:** List **neighbor-ipv6** **Description** Neighbor IPv6 address **Type:** string **Format:** ipv6-address **neighbor-prefix-lists** **Type:** List **neighbor-route-map-lists** **Type:** List **next-hop-self** **Description** Disable the next hop calculation for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** next-hop-self and peer-group-name are mutually exclusive **override-capability** **Description** Override capability negotiation result **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **pass-encrypted** **Description** **pass-value** **Description** Key String **Type:** string **Format:** password **Maximum Length:** 80 characters **Maximum Length:** 1 characters **passive** **Description** Don't send open messages to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **peer-group-name** **Description** Configure peer-group (peer-group name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Mutual Exclusion:** peer-group-nameadvertisement-interval, as-origination-interval, default-originate, disallow-infinite-holdtime, next-hop-self, timers and unsuppress-map are mutually exclusive **prefix-list-direction** **Description** 'both': both; 'receive': receive; 'send': send; **Type:** string **Supported Values:** both, receive, send **remove-private-as** **Description** Remove private AS number from outbound updates **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **restart-min** **Description** restart value, 1 to 1440 minutes **Type:** number **Range:** 1-1440 **route-map** **Description** Route-map to specify criteria to originate default (route-map name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **route-refresh** **Description** Advertise route-refresh capability to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **send-community-val** **Description** 'both': Send Standard and Extended Community attributes; 'none': Disable Sending Community attributes; 'standard': Send Standard Community attributes; 'extended': Send Extended Community attributes; **Type:** string **Supported Values:** both, none, standard, extended **Default:** both **shutdown** **Description** Administratively shut down this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **strict-capability-match** **Description** Strict capability negotiation match **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **timers-holdtime** **Description** Holdtime **Type:** number **Range:** 0-65535 **Default:** 90 **timers-keepalive** **Description** Keepalive interval **Type:** number **Range:** 0-65535 **Default:** 30 **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **Mutual Exclusion:** trunkupdate-source-ip, update-source-ipv6, ethernet, loopback, ve, lif and tunnel are mutually exclusive **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **Mutual Exclusion:** tunnelupdate-source-ip, update-source-ipv6, ethernet, loopback, ve, trunk and lif are mutually exclusive **unsuppress-map** **Description** Route-map to selectively unsuppress suppressed routes (Name of route map) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Mutual Exclusion:** unsuppress-map and peer-group-name are mutually exclusive **update-source-ip** **Description** IP address **Type:** string **Format:** ipv4-address **Mutual Exclusion:** update-source-ipupdate-source-ipv6, ethernet, loopback, ve, trunk, lif and tunnel are mutually exclusive **update-source-ipv6** **Description** IPv6 address **Type:** string **Format:** ipv6-address **Mutual Exclusion:** update-source-ipv6update-source-ip, ethernet, loopback, ve, trunk, lif and tunnel are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface **Mutual Exclusion:** veupdate-source-ip, update-source-ipv6, ethernet, loopback, trunk, lif and tunnel are mutually exclusive **weight** **Description** Set default weight for routes from this neighbor **Type:** number **Range:** 0-65535 **Default:** 0 .. _1521_bgp-list_neighbor_ipv6-neighbor-list_distribute-lists: bgp-list_neighbor_ipv6-neighbor-list_distribute-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **distribute-list** **Description** Filter updates to/from this neighbor (IP standard/extended/named access list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **distribute-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_bgp-list_neighbor_ipv6-neighbor-list_neighbor-route-map-lists: bgp-list_neighbor_ipv6-neighbor-list_neighbor-route-map-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nbr-rmap-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out **nbr-route-map** **Description** Apply route map to neighbor (Name of route map) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _1521_bgp-list_neighbor_ipv6-neighbor-list_neighbor-filter-lists: bgp-list_neighbor_ipv6-neighbor-list_neighbor-filter-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **filter-list** **Description** Establish BGP filters (AS path access-list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **filter-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_bgp-list_neighbor_ipv6-neighbor-list_neighbor-prefix-lists: bgp-list_neighbor_ipv6-neighbor-list_neighbor-prefix-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nbr-prefix-list** **Description** Filter updates to/from this neighbor (Name of a prefix list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **nbr-prefix-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_bgp-list_neighbor_ethernet-neighbor-list: bgp-list_neighbor_ethernet-neighbor-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet interface number **Type:** number **Format:** interface **peer-group-name** **Description** **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **unnumbered** **Description** **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 .. _1521_bgp-list_neighbor_trunk-neighbor-list: bgp-list_neighbor_trunk-neighbor-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **peer-group-name** **Description** **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **trunk** **Description** Trunk interface number **Type:** number **Format:** interface **unnumbered** **Description** **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 .. _1521_bgp-list_distance-list: bgp-list_distance-list ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **acl-str** **Description** Access list name **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **admin-distance** **Description** Define an administrative distance **Type:** number **Range:** 1-255 **ext-routes-dist** **Description** Distance for routes external to the AS **Type:** number **Range:** 1-255 **int-routes-dist** **Description** Distance for routes internal to the AS **Type:** number **Range:** 1-255 **local-routes-dist** **Description** Distance for local routes **Type:** number **Range:** 1-255 **src-prefix** **Description** IP source prefix **Type:** string **Format:** ipv4-cidr .. _1521_bgp-list_address-family: bgp-list_address-family ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ipv6** **Description:** ipv6 is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6 ` .. _1521_bgp-list_address-family_ipv6: bgp-list_address-family_ipv6 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **aggregate-address-list** **Type:** List **auto-summary** **Description** Enable automatic network number summarization **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bgp** **Description:** bgp is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_bgp` **Type:** Object **distance** **Description:** distance is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_distance` **Type:** Object **maximum-paths-value** **Description** Supported BGP multipath numbers **Type:** number **Range:** 1-64 **Default:** 1 **neighbor** **Description:** neighbor is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_neighbor` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor ` **network** **Description:** network is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_network` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6/network ` **originate** **Description** Distribute an IPv6 default route **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **redistribute** **Description:** redistribute is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_redistribute` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6/redistribute ` **synchronization** **Description** Perform IGP synchronization **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 .. _1521_bgp-list_address-family_ipv6_distance: bgp-list_address-family_ipv6_distance ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **distance-ext** **Description** Distance for routes external to the AS **Type:** number **Range:** 1-255 **distance-int** **Description** Distance for routes internal to the AS **Type:** number **Range:** 1-255 **distance-local** **Description** Distance for local routes **Type:** number **Range:** 1-255 .. _1521_bgp-list_address-family_ipv6_redistribute: bgp-list_address-family_ipv6_redistribute ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **connected-cfg** **Description:** connected-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_redistribute_connected-cfg` **Type:** Object **floating-ip-cfg** **Description:** floating-ip-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_redistribute_floating-ip-cfg` **Type:** Object **ip-nat-cfg** **Description:** ip-nat-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_redistribute_ip-nat-cfg` **Type:** Object **ip-nat-list-cfg** **Description:** ip-nat-list-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_redistribute_ip-nat-list-cfg` **Type:** Object **isis-cfg** **Description:** isis-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_redistribute_isis-cfg` **Type:** Object **lw4o6-cfg** **Description:** lw4o6-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_redistribute_lw4o6-cfg` **Type:** Object **nat-map-cfg** **Description:** nat-map-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_redistribute_nat-map-cfg` **Type:** Object **nat64-cfg** **Description:** nat64-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_redistribute_nat64-cfg` **Type:** Object **ospf-cfg** **Description:** ospf-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_redistribute_ospf-cfg` **Type:** Object **rip-cfg** **Description:** rip-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_redistribute_rip-cfg` **Type:** Object **static-cfg** **Description:** static-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_redistribute_static-cfg` **Type:** Object **static-nat-cfg** **Description:** static-nat-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_redistribute_static-nat-cfg` **Type:** Object **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vip** **Description:** vip is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_redistribute_vip` **Type:** Object .. _1521_bgp-list_address-family_ipv6_redistribute_ip-nat-list-cfg: bgp-list_address-family_ipv6_redistribute_ip-nat-list-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ip-nat-list** **Description** IP NAT list **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 .. _1521_bgp-list_address-family_ipv6_redistribute_lw4o6-cfg: bgp-list_address-family_ipv6_redistribute_lw4o6-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **lw4o6** **Description** LW4O6 Prefix **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 .. _1521_bgp-list_address-family_ipv6_redistribute_nat64-cfg: bgp-list_address-family_ipv6_redistribute_nat64-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **nat64** **Description** NAT64 Prefix **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 .. _1521_bgp-list_address-family_ipv6_redistribute_connected-cfg: bgp-list_address-family_ipv6_redistribute_connected-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **connected** **Description** Connected **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 .. _1521_bgp-list_address-family_ipv6_redistribute_vip: bgp-list_address-family_ipv6_redistribute_vip ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **only-flagged-cfg** **Description:** only-flagged-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_redistribute_vip_only-flagged-cfg` **Type:** Object **only-not-flagged-cfg** **Description:** only-not-flagged-cfg is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_redistribute_vip_only-not-flagged-cfg` **Type:** Object .. _1521_bgp-list_address-family_ipv6_redistribute_vip_only-not-flagged-cfg: bgp-list_address-family_ipv6_redistribute_vip_only-not-flagged-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **only-not-flagged** **Description** Only not flagged **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 .. _1521_bgp-list_address-family_ipv6_redistribute_vip_only-flagged-cfg: bgp-list_address-family_ipv6_redistribute_vip_only-flagged-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **only-flagged** **Description** Selected Virtual IP (VIP) **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 .. _1521_bgp-list_address-family_ipv6_redistribute_ip-nat-cfg: bgp-list_address-family_ipv6_redistribute_ip-nat-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ip-nat** **Description** IP NAT **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 .. _1521_bgp-list_address-family_ipv6_redistribute_floating-ip-cfg: bgp-list_address-family_ipv6_redistribute_floating-ip-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **floating-ip** **Description** Floating IP **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 .. _1521_bgp-list_address-family_ipv6_redistribute_isis-cfg: bgp-list_address-family_ipv6_redistribute_isis-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **isis** **Description** ISO IS-IS **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 .. _1521_bgp-list_address-family_ipv6_redistribute_nat-map-cfg: bgp-list_address-family_ipv6_redistribute_nat-map-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **nat-map** **Description** NAT MAP Prefix **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 .. _1521_bgp-list_address-family_ipv6_redistribute_rip-cfg: bgp-list_address-family_ipv6_redistribute_rip-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **rip** **Description** Routing Information Protocol (RIP) **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 .. _1521_bgp-list_address-family_ipv6_redistribute_ospf-cfg: bgp-list_address-family_ipv6_redistribute_ospf-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ospf** **Description** Open Shortest Path First (OSPF) **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 .. _1521_bgp-list_address-family_ipv6_redistribute_static-nat-cfg: bgp-list_address-family_ipv6_redistribute_static-nat-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **route-map** **Description** Route map reference (Pointer to route-map entries) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **static-nat** **Description** Static NAT Prefix **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1521_bgp-list_address-family_ipv6_redistribute_static-cfg: bgp-list_address-family_ipv6_redistribute_static-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **route-map** **Description** Route map reference (Pointer to route-map entries) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **static** **Description** Static routes **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1521_bgp-list_address-family_ipv6_aggregate-address-list: bgp-list_address-family_ipv6_aggregate-address-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **aggregate-address** **Description** Configure BGP aggregate entries (Aggregate IPv6 prefix) **Type:** string **Format:** ipv6-address-plen **as-set** **Description** Generate AS set path information **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **summary-only** **Description** Filter more specific routes from updates **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1521_bgp-list_address-family_ipv6_bgp: bgp-list_address-family_ipv6_bgp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **dampening** **Description** Enable route-flap dampening **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dampening-half** **Description** Reachability Half-life time for the penalty(minutes) **Type:** number **Range:** 1-45 **dampening-max-supress** **Description** Maximum duration to suppress a stable route(minutes) **Type:** number **Range:** 1-255 **dampening-start-reuse** **Description** Value to start reusing a route **Type:** number **Range:** 1-20000 **dampening-start-supress** **Description** Value to start suppressing a route **Type:** number **Range:** 1-20000 **dampening-unreachability** **Description** Un-reachability Half-life time for the penalty(minutes) **Type:** number **Range:** 1-45 **route-map** **Description** Route-map to specify criteria for dampening (Route-map name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _1521_bgp-list_address-family_ipv6_network: bgp-list_address-family_ipv6_network ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ipv6-network-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6/network/ipv6-network/{network-ipv6} ` **synchronization** **Description:** synchronization is a **JSON Block**. Please see below for :ref:`1521_bgp-list_address-family_ipv6_network_synchronization` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6/network/synchronization ` .. _1521_bgp-list_address-family_ipv6_network_ipv6-network-list: bgp-list_address-family_ipv6_network_ipv6-network-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **backdoor** **Description** Specify a BGP backdoor route **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **comm-value** **Description** community value in the format 1-4294967295|AA:NN|internet|local-AS|no-advertise|no-export **Type:** string **Format:** string-rlx **description** **Description** Network specific description (Up to 80 characters describing this network) **Type:** string **Format:** string-rlx **Maximum Length:** 80 characters **Maximum Length:** 1 characters **network-ipv6** **Description** Specify a network to announce via BGP **Type:** string **Format:** ipv6-address-plen **route-map** **Description** Route-map to modify the attributes (Name of the route map) **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 .. _1521_bgp-list_address-family_ipv6_network_synchronization: bgp-list_address-family_ipv6_network_synchronization ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **network-synchronization** **Description** Perform IGP synchronization **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 .. _1521_bgp-list_address-family_ipv6_neighbor: bgp-list_address-family_ipv6_neighbor ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ethernet-neighbor-ipv6-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/ethernet-neighbor-ipv6/{ethernet} ` **ipv4-neighbor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/ipv4-neighbor/{neighbor-ipv4} ` **ipv6-neighbor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/ipv6-neighbor/{neighbor-ipv6} ` **peer-group-neighbor-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/peer-group-neighbor/{peer-group} ` **trunk-neighbor-ipv6-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/trunk-neighbor-ipv6/{trunk} ` **ve-neighbor-ipv6-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/bgp/{as-number}/address-family/ipv6/neighbor/ve-neighbor-ipv6/{ve} ` .. _1521_bgp-list_address-family_ipv6_neighbor_ethernet-neighbor-ipv6-list: bgp-list_address-family_ipv6_neighbor_ethernet-neighbor-ipv6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet interface number **Type:** number **Format:** interface **peer-group-name** **Description** **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 .. _1521_bgp-list_address-family_ipv6_neighbor_ipv4-neighbor-list: bgp-list_address-family_ipv6_neighbor_ipv4-neighbor-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **activate** **Description** Enable the Address Family for this Neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **allowas-in** **Description** Accept as-path with my AS present in it **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **allowas-in-count** **Description** Number of occurrences of AS number **Type:** number **Range:** 1-10 **Default:** 3 **default-originate** **Description** Originate default route to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **distribute-lists** **Type:** List **graceful-restart** **Description** enable graceful-restart helper for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **inbound** **Description** Allow inbound soft reconfiguration for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **maximum-prefix** **Description** Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model)) **Type:** number **maximum-prefix-thres** **Description** threshold-value, 1 to 100 percent **Type:** number **Range:** 1-100 **neighbor-filter-lists** **Type:** List **neighbor-ipv4** **Description** Neighbor address **Type:** string **Format:** ipv4-address **neighbor-prefix-lists** **Type:** List **neighbor-route-map-lists** **Type:** List **next-hop-self** **Description** Disable the next hop calculation for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **peer-group-name** **Description** Configure peer-group (peer-group name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **prefix-list-direction** **Description** 'both': both; 'receive': receive; 'send': send; **Type:** string **Supported Values:** both, receive, send **remove-private-as** **Description** Remove private AS number from outbound updates **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **restart-min** **Description** restart value, 1 to 1440 minutes **Type:** number **Range:** 1-1440 **route-map** **Description** Route-map to specify criteria to originate default (route-map name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **send-community-val** **Description** 'both': Send Standard and Extended Community attributes; 'none': Disable Sending Community attributes; 'standard': Send Standard Community attributes; 'extended': Send Extended Community attributes; **Type:** string **Supported Values:** both, none, standard, extended **Default:** both **unsuppress-map** **Description** Route-map to selectively unsuppress suppressed routes (Name of route map) **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 **weight** **Description** Set default weight for routes from this neighbor **Type:** number **Range:** 0-65535 **Default:** 0 .. _1521_bgp-list_address-family_ipv6_neighbor_ipv4-neighbor-list_distribute-lists: bgp-list_address-family_ipv6_neighbor_ipv4-neighbor-list_distribute-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **distribute-list** **Description** Filter updates to/from this neighbor (IP standard/extended/named access list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **distribute-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_bgp-list_address-family_ipv6_neighbor_ipv4-neighbor-list_neighbor-route-map-lists: bgp-list_address-family_ipv6_neighbor_ipv4-neighbor-list_neighbor-route-map-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nbr-rmap-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out **nbr-route-map** **Description** Apply route map to neighbor (Name of route map) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _1521_bgp-list_address-family_ipv6_neighbor_ipv4-neighbor-list_neighbor-filter-lists: bgp-list_address-family_ipv6_neighbor_ipv4-neighbor-list_neighbor-filter-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **filter-list** **Description** Establish BGP filters (AS path access-list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **filter-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_bgp-list_address-family_ipv6_neighbor_ipv4-neighbor-list_neighbor-prefix-lists: bgp-list_address-family_ipv6_neighbor_ipv4-neighbor-list_neighbor-prefix-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nbr-prefix-list** **Description** Filter updates to/from this neighbor (Name of a prefix list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **nbr-prefix-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_bgp-list_address-family_ipv6_neighbor_peer-group-neighbor-list: bgp-list_address-family_ipv6_neighbor_peer-group-neighbor-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **activate** **Description** Enable the Address Family for this Neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **allowas-in** **Description** Accept as-path with my AS present in it **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **allowas-in-count** **Description** Number of occurrences of AS number **Type:** number **Range:** 1-10 **Default:** 3 **default-originate** **Description** Originate default route to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **distribute-lists** **Type:** List **inbound** **Description** Allow inbound soft reconfiguration for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **maximum-prefix** **Description** Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model)) **Type:** number **maximum-prefix-thres** **Description** threshold-value, 1 to 100 percent **Type:** number **Range:** 1-100 **neighbor-filter-lists** **Type:** List **neighbor-prefix-lists** **Type:** List **neighbor-route-map-lists** **Type:** List **next-hop-self** **Description** Disable the next hop calculation for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **peer-group** **Description** Neighbor tag **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **prefix-list-direction** **Description** 'both': both; 'receive': receive; 'send': send; **Type:** string **Supported Values:** both, receive, send **remove-private-as** **Description** Remove private AS number from outbound updates **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **route-map** **Description** Route-map to specify criteria to originate default (route-map name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **send-community-val** **Description** 'both': Send Standard and Extended Community attributes; 'none': Disable Sending Community attributes; 'standard': Send Standard Community attributes; 'extended': Send Extended Community attributes; **Type:** string **Supported Values:** both, none, standard, extended **Default:** both **unsuppress-map** **Description** Route-map to selectively unsuppress suppressed routes (Name of route map) **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 **weight** **Description** Set default weight for routes from this neighbor **Type:** number **Range:** 0-65535 **Default:** 0 .. _1521_bgp-list_address-family_ipv6_neighbor_peer-group-neighbor-list_neighbor-prefix-lists: bgp-list_address-family_ipv6_neighbor_peer-group-neighbor-list_neighbor-prefix-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nbr-prefix-list** **Description** Filter updates to/from this neighbor (Name of a prefix list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **nbr-prefix-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_bgp-list_address-family_ipv6_neighbor_peer-group-neighbor-list_distribute-lists: bgp-list_address-family_ipv6_neighbor_peer-group-neighbor-list_distribute-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **distribute-list** **Description** Filter updates to/from this neighbor (IP standard/extended/named access list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **distribute-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_bgp-list_address-family_ipv6_neighbor_peer-group-neighbor-list_neighbor-route-map-lists: bgp-list_address-family_ipv6_neighbor_peer-group-neighbor-list_neighbor-route-map-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nbr-rmap-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out **nbr-route-map** **Description** Apply route map to neighbor (Name of route map) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _1521_bgp-list_address-family_ipv6_neighbor_peer-group-neighbor-list_neighbor-filter-lists: bgp-list_address-family_ipv6_neighbor_peer-group-neighbor-list_neighbor-filter-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **filter-list** **Description** Establish BGP filters (AS path access-list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **filter-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_bgp-list_address-family_ipv6_neighbor_ve-neighbor-ipv6-list: bgp-list_address-family_ipv6_neighbor_ve-neighbor-ipv6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **peer-group-name** **Description** **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 **ve** **Description** Virtual ethernet interface number **Type:** number **Format:** interface .. _1521_bgp-list_address-family_ipv6_neighbor_trunk-neighbor-ipv6-list: bgp-list_address-family_ipv6_neighbor_trunk-neighbor-ipv6-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **peer-group-name** **Description** **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **trunk** **Description** Trunk interface number **Type:** number **Format:** interface **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1521_bgp-list_address-family_ipv6_neighbor_ipv6-neighbor-list: bgp-list_address-family_ipv6_neighbor_ipv6-neighbor-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **activate** **Description** Enable the Address Family for this Neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **allowas-in** **Description** Accept as-path with my AS present in it **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **allowas-in-count** **Description** Number of occurrences of AS number **Type:** number **Range:** 1-10 **Default:** 3 **default-originate** **Description** Originate default route to this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **distribute-lists** **Type:** List **graceful-restart** **Description** enable graceful-restart helper for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **inbound** **Description** Allow inbound soft reconfiguration for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **maximum-prefix** **Description** Maximum number of prefix accept from this peer (maximum no. of prefix limit (various depends on model)) **Type:** number **maximum-prefix-thres** **Description** threshold-value, 1 to 100 percent **Type:** number **Range:** 1-100 **neighbor-filter-lists** **Type:** List **neighbor-ipv6** **Description** Neighbor IPv6 address **Type:** string **Format:** ipv6-address **neighbor-prefix-lists** **Type:** List **neighbor-route-map-lists** **Type:** List **next-hop-self** **Description** Disable the next hop calculation for this neighbor **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **peer-group-name** **Description** Configure peer-group (peer-group name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **prefix-list-direction** **Description** 'both': both; 'receive': receive; 'send': send; **Type:** string **Supported Values:** both, receive, send **remove-private-as** **Description** Remove private AS number from outbound updates **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **restart-min** **Description** restart value, 1 to 1440 minutes **Type:** number **Range:** 1-1440 **route-map** **Description** Route-map to specify criteria to originate default (route-map name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **send-community-val** **Description** 'both': Send Standard and Extended Community attributes; 'none': Disable Sending Community attributes; 'standard': Send Standard Community attributes; 'extended': Send Extended Community attributes; **Type:** string **Supported Values:** both, none, standard, extended **Default:** both **unsuppress-map** **Description** Route-map to selectively unsuppress suppressed routes (Name of route map) **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 **weight** **Description** Set default weight for routes from this neighbor **Type:** number **Range:** 0-65535 **Default:** 0 .. _1521_bgp-list_address-family_ipv6_neighbor_ipv6-neighbor-list_distribute-lists: bgp-list_address-family_ipv6_neighbor_ipv6-neighbor-list_distribute-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **distribute-list** **Description** Filter updates to/from this neighbor (IP standard/extended/named access list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **distribute-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_bgp-list_address-family_ipv6_neighbor_ipv6-neighbor-list_neighbor-route-map-lists: bgp-list_address-family_ipv6_neighbor_ipv6-neighbor-list_neighbor-route-map-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nbr-rmap-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out **nbr-route-map** **Description** Apply route map to neighbor (Name of route map) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _1521_bgp-list_address-family_ipv6_neighbor_ipv6-neighbor-list_neighbor-filter-lists: bgp-list_address-family_ipv6_neighbor_ipv6-neighbor-list_neighbor-filter-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **filter-list** **Description** Establish BGP filters (AS path access-list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **filter-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_bgp-list_address-family_ipv6_neighbor_ipv6-neighbor-list_neighbor-prefix-lists: bgp-list_address-family_ipv6_neighbor_ipv6-neighbor-list_neighbor-prefix-lists ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **nbr-prefix-list** **Description** Filter updates to/from this neighbor (Name of a prefix list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **nbr-prefix-list-direction** **Description** 'in': in; 'out': out; **Type:** string **Supported Values:** in, out .. _1521_ipv6: ipv6 ^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ospf-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/router/ipv6/ospf/{process-id} ` **rip** **Description:** rip is a **JSON Block**. Please see below for :ref:`1521_ipv6_rip` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/ipv6/rip ` .. _1521_ipv6_ospf-list: ipv6_ospf-list ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **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:`1521_ipv6_ospf-list_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:`1521_ipv6_ospf-list_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:`1521_ipv6_ospf-list_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:`1521_ipv6_ospf-list_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:`1521_ipv6_ospf-list_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 .. _1521_ipv6_ospf-list_distribute-internal-list: ipv6_ospf-list_distribute-internal-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ipv6_ospf-list_redistribute: ipv6_ospf-list_redistribute ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ipv6_ospf-list_redistribute_redist-list: ipv6_ospf-list_redistribute_redist-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ipv6_ospf-list_redistribute_ospf-list: ipv6_ospf-list_redistribute_ospf-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ipv6_ospf-list_redistribute_ip-nat-floating-list: ipv6_ospf-list_redistribute_ip-nat-floating-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ipv6_ospf-list_redistribute_vip-list: ipv6_ospf-list_redistribute_vip-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ipv6_ospf-list_redistribute_vip-floating-list: ipv6_ospf-list_redistribute_vip-floating-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ipv6_ospf-list_distribute-list: ipv6_ospf-list_distribute-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **prefix-list** **Description:** prefix-list is a **JSON Block**. Please see below for :ref:`1521_ipv6_ospf-list_distribute-list_prefix-list` **Type:** Object .. _1521_ipv6_ospf-list_distribute-list_prefix-list: ipv6_ospf-list_distribute-list_prefix-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ipv6_ospf-list_area-list: ipv6_ospf-list_area-list ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ipv6_ospf-list_area-list_virtual-link-list: ipv6_ospf-list_area-list_virtual-link-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ipv6_ospf-list_area-list_range-list: ipv6_ospf-list_area-list_range-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ipv6_ospf-list_default-information: ipv6_ospf-list_default-information ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ipv6_ospf-list_passive-interface: ipv6_ospf-list_passive-interface ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **eth-cfg** **Type:** List **loopback-cfg** **Type:** List **trunk-cfg** **Type:** List **tunnel-cfg** **Type:** List **ve-cfg** **Type:** List .. _1521_ipv6_ospf-list_passive-interface_tunnel-cfg: ipv6_ospf-list_passive-interface_tunnel-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface .. _1521_ipv6_ospf-list_passive-interface_ve-cfg: ipv6_ospf-list_passive-interface_ve-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface .. _1521_ipv6_ospf-list_passive-interface_trunk-cfg: ipv6_ospf-list_passive-interface_trunk-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface .. _1521_ipv6_ospf-list_passive-interface_loopback-cfg: ipv6_ospf-list_passive-interface_loopback-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface .. _1521_ipv6_ospf-list_passive-interface_eth-cfg: ipv6_ospf-list_passive-interface_eth-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface .. _1521_ipv6_ospf-list_timers: ipv6_ospf-list_timers ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **spf** **Description:** spf is a **JSON Block**. Please see below for :ref:`1521_ipv6_ospf-list_timers_spf` **Type:** Object .. _1521_ipv6_ospf-list_timers_spf: ipv6_ospf-list_timers_spf ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **exp** **Description:** exp is a **JSON Block**. Please see below for :ref:`1521_ipv6_ospf-list_timers_spf_exp` **Type:** Object .. _1521_ipv6_ospf-list_timers_spf_exp: ipv6_ospf-list_timers_spf_exp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ipv6_ospf-list_ha-standby-extra-cost: ipv6_ospf-list_ha-standby-extra-cost ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1521_ipv6_rip: ipv6_rip ^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **aggregate-address-cfg** **Type:** List **cisco-metric-behavior** **Description** 'enable': Enables updating metric consistent with Cisco; 'disable': Disables updating metric consistent with Cisco; (Enable/Disable updating metric consistent with Cisco) **Type:** string **Supported Values:** enable, disable **Default:** disable **default-information** **Description** 'originate': originate; (Distribute default route) **Type:** string **Supported Values:** originate **default-metric** **Description** Set a metric of redistribute routes (Default metric) **Type:** number **Range:** 1-16 **Default:** 1 **distribute-list** **Description:** distribute-list is a **JSON Block**. Please see below for :ref:`1521_ipv6_rip_distribute-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/ipv6/rip/distribute-list ` **offset-list** **Description:** offset-list is a **JSON Block**. Please see below for :ref:`1521_ipv6_rip_offset-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/ipv6/rip/offset-list ` **passive-interface-list** **Type:** List **recv-buffer-size** **Description** Set the RIPNG UDP receive buffer size (the RIPNG UDP receive buffer size value) **Type:** number **Range:** 8192-2147483647 **redistribute** **Description:** redistribute is a **JSON Block**. Please see below for :ref:`1521_ipv6_rip_redistribute` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/ipv6/rip/redistribute ` **ripng-neighbor** **Description:** ripng-neighbor is a **JSON Block**. Please see below for :ref:`1521_ipv6_rip_ripng-neighbor` **Type:** Object **route-cfg** **Type:** List **route-map** **Description:** route-map is a **JSON Block**. Please see below for :ref:`1521_ipv6_rip_route-map` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/ipv6/rip/route-map ` **timers** **Description:** timers is a **JSON Block**. Please see below for :ref:`1521_ipv6_rip_timers` **Type:** Object **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1521_ipv6_rip_offset-list: ipv6_rip_offset-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **acl-cfg** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1521_ipv6_rip_offset-list_acl-cfg: ipv6_rip_offset-list_acl-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **acl** **Description** Access-list name **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **metric** **Description** Metric value **Type:** number **Range:** 0-16 **offset-list-direction** **Description** 'in': Filter incoming updates; 'out': Filter outgoing updates; **Type:** string **Supported Values:** in, out **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface .. _1521_ipv6_rip_route-map: ipv6_rip_route-map ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **map-cfg** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1521_ipv6_rip_route-map_map-cfg: ipv6_rip_route-map_map-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **map** **Description** Route map name **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **route-map-direction** **Description** 'in': Route map set for input filtering; 'out': Route map set for output filtering; **Type:** string **Supported Values:** in, out **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface .. _1521_ipv6_rip_passive-interface-list: ipv6_rip_passive-interface-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface .. _1521_ipv6_rip_redistribute: ipv6_rip_redistribute ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **redist-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vip-list** **Type:** List .. _1521_ipv6_rip_redistribute_vip-list: ipv6_rip_redistribute_vip-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **vip-metric** **Description** Metric for redistributed routes (metric value) **Type:** number **Range:** 0-16 **vip-route-map** **Description** Route map reference (Pointer to route-map entries) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **vip-type** **Description** 'only-flagged': Selected Virtual IP (VIP); 'only-not-flagged': Only not flagged; **Type:** string **Supported Values:** only-flagged, only-not-flagged .. _1521_ipv6_rip_redistribute_redist-list: ipv6_rip_redistribute_redist-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **metric** **Description** Metric for redistributed routes (metric value) **Type:** number **Range:** 0-16 **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; 'ip-nat': IP NAT; 'isis': ISO IS-IS; 'lw4o6': LW4O6 Prefix; 'nat-map': NAT MAP Prefix; 'nat64': NAT64 Prefix; 'static-nat': Static NAT; 'ospf': Open Shortest Path First (OSPF); 'static': Static routes; **Type:** string **Supported Values:** bgp, connected, floating-ip, ip-nat-list, ip-nat, isis, lw4o6, nat-map, nat64, static-nat, ospf, static .. _1521_ipv6_rip_route-cfg: ipv6_rip_route-cfg ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **route** **Description** Static route advertisement (debugging purpose) (IP prefix) **Type:** string **Format:** ipv6-address-plen .. _1521_ipv6_rip_timers: ipv6_rip_timers ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **timers-cfg** **Description:** timers-cfg is a **JSON Block**. Please see below for :ref:`1521_ipv6_rip_timers_timers-cfg` **Type:** Object .. _1521_ipv6_rip_timers_timers-cfg: ipv6_rip_timers_timers-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **basic** **Description** Basic routing protocol update timers (Routing table update timer value in second. Default is 30) **Type:** number **Range:** 5-2147483647 **val-2** **Description** Routing information timeout timer. Default is 180 **Type:** number **Range:** 5-2147483647 **val-3** **Description** Garbage collection timer. Default is 120 **Type:** number **Range:** 5-2147483647 .. _1521_ipv6_rip_aggregate-address-cfg: ipv6_rip_aggregate-address-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **aggregate-address** **Description** Set aggregate RIP route announcement (Aggregate network) **Type:** string **Format:** ipv6-address-plen .. _1521_ipv6_rip_ripng-neighbor: ipv6_rip_ripng-neighbor ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ripng-neighbor-cfg** **Type:** List .. _1521_ipv6_rip_ripng-neighbor_ripng-neighbor-cfg: ipv6_rip_ripng-neighbor_ripng-neighbor-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **neighbor-link-local-addr** **Description** IPv6 link-local address **Type:** string **Format:** ipv6-address **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface .. _1521_ipv6_rip_distribute-list: ipv6_rip_distribute-list ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **acl-cfg** **Type:** List **prefix** **Description:** prefix is a **JSON Block**. Please see below for :ref:`1521_ipv6_rip_distribute-list_prefix` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/ipv6/rip/distribute-list/prefix ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1521_ipv6_rip_distribute-list_acl-cfg: ipv6_rip_distribute-list_acl-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **acl** **Description** Access-list name **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **acl-direction** **Description** 'in': Filter incoming routing updates; 'out': Filter outgoing routing updates; **Type:** string **Supported Values:** in, out **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface .. _1521_ipv6_rip_distribute-list_prefix: ipv6_rip_distribute-list_prefix ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **prefix-cfg** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1521_ipv6_rip_distribute-list_prefix_prefix-cfg: ipv6_rip_distribute-list_prefix_prefix-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **prefix-list** **Description** Filter prefixes in routing updates (Name of a prefix list) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **prefix-list-direction** **Description** 'in': Filter incoming routing updates; 'out': Filter outgoing routing updates; **Type:** string **Supported Values:** in, out **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface .. _1521_isis-list: isis-list ^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **address-family** **Description:** address-family is a **JSON Block**. Please see below for :ref:`1521_isis-list_address-family` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/isis/{tag}/address-family ` **adjacency-check** **Description** Check ISIS neighbor protocol support **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **area-password-cfg** **Description:** area-password-cfg is a **JSON Block**. Please see below for :ref:`1521_isis-list_area-password-cfg` **Type:** Object **authentication** **Description:** authentication is a **JSON Block**. Please see below for :ref:`1521_isis-list_authentication` **Type:** Object **bfd** **Description** 'all-interfaces': Enable BFD on all interfaces; **Type:** string **Supported Values:** all-interfaces **default-information** **Description** 'originate': Distribute a default route; **Type:** string **Supported Values:** originate **distance-list** **Type:** List **domain-password-cfg** **Description:** domain-password-cfg is a **JSON Block**. Please see below for :ref:`1521_isis-list_domain-password-cfg` **Type:** Object **ha-standby-extra-cost** **Type:** List **ignore-lsp-errors** **Description** Ignore LSPs with bad checksums **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **is-type** **Description** 'level-1': Act as a station router only; 'level-1-2': Act as both a station router and an area router; 'level-2-only': Act as an area router only; **Type:** string **Supported Values:** level-1, level-1-2, level-2-only **Default:** level-1 **log-adjacency-changes-cfg** **Description:** log-adjacency-changes-cfg is a **JSON Block**. Please see below for :ref:`1521_isis-list_log-adjacency-changes-cfg` **Type:** Object **lsp-gen-interval-list** **Type:** List **lsp-refresh-interval** **Description** Set LSP refresh interval (LSP refresh time in seconds) **Type:** number **Range:** 1-65535 **Default:** 900 **max-lsp-lifetime** **Description** Set maximum LSP lifetime (Maximum LSP lifetime in seconds) **Type:** number **Range:** 350-65535 **Default:** 1200 **metric-style-list** **Type:** List **net-list** **Type:** List **passive-interface-list** **Type:** List **protocol-list** **Type:** List **redistribute** **Description:** redistribute is a **JSON Block**. Please see below for :ref:`1521_isis-list_redistribute` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/isis/{tag}/redistribute ` **set-overload-bit-cfg** **Description:** set-overload-bit-cfg is a **JSON Block**. Please see below for :ref:`1521_isis-list_set-overload-bit-cfg` **Type:** Object **spf-interval-exp-list** **Type:** List **summary-address-list** **Type:** List **tag** **Description** ISO routing area tag **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **Default:** **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 .. _1521_isis-list_domain-password-cfg: isis-list_domain-password-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **authenticate** **Description:** authenticate is a **JSON Block**. Please see below for :ref:`1521_isis-list_domain-password-cfg_authenticate` **Type:** Object **password** **Description** Set the authentication password for a routing domain (Routing domain password) **Type:** string **Format:** string-rlx **Maximum Length:** 254 characters **Maximum Length:** 1 characters .. _1521_isis-list_domain-password-cfg_authenticate: isis-list_domain-password-cfg_authenticate ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **snp** **Description** 'send-only': Send but do not check PDUs on receiving; 'validate': Send and check PDUs on receiving; **Type:** string **Supported Values:** send-only, validate .. _1521_isis-list_set-overload-bit-cfg: isis-list_set-overload-bit-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **on-startup** **Description:** on-startup is a **JSON Block**. Please see below for :ref:`1521_isis-list_set-overload-bit-cfg_on-startup` **Type:** Object **set-overload-bit** **Description** Signal other touers not to use us in SPF **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **suppress-cfg** **Description:** suppress-cfg is a **JSON Block**. Please see below for :ref:`1521_isis-list_set-overload-bit-cfg_suppress-cfg` **Type:** Object .. _1521_isis-list_set-overload-bit-cfg_suppress-cfg: isis-list_set-overload-bit-cfg_suppress-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **external** **Description** If overload-bit set, don't advertise IP prefixes learned from other protocols **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **interlevel** **Description** If overload-bit set, don't advertise IP prefixes learned from another ISIS level **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1521_isis-list_set-overload-bit-cfg_on-startup: isis-list_set-overload-bit-cfg_on-startup ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **delay** **Description** Time in seconds to advertise ourself as overloaded after reboot **Type:** number **Range:** 5-86400 **Mutual Exclusion:** delay and wait-for-bgp are mutually exclusive **wait-for-bgp** **Description** Let BGP decide when to unset the overload bit **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** wait-for-bgp and delay are mutually exclusive .. _1521_isis-list_net-list: isis-list_net-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **net** **Description** A Network Entity Title for this process (XX.XXXX. ... .XXXX.XX Network entity title (NET)) **Type:** string **Format:** nasp-string **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _1521_isis-list_metric-style-list: isis-list_metric-style-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **level** **Description** 'level-1': Level-1 only; 'level-1-2': Level-1-2; 'level-2': Level-2 only; **Type:** string **Supported Values:** level-1, level-1-2, level-2 **Default:** level-1-2 **type** **Description** 'narrow': Use old style of TLVs with narrow metric; 'wide': Use new style of TLVs to carry wider metric; 'transition': Send and accept both styles of TLVs during transition; 'narrow-transition': Send old style of TLVs with narrow metric with accepting both styles of TLVs; 'wide-transition': Send new style of TLVs to carry wider metric with accepting both styles of TLVs; **Type:** string **Supported Values:** narrow, wide, transition, narrow-transition, wide-transition **Default:** narrow .. _1521_isis-list_authentication: isis-list_authentication ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **key-chain-list** **Type:** List **mode-list** **Type:** List **send-only-list** **Type:** List .. _1521_isis-list_authentication_key-chain-list: isis-list_authentication_key-chain-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **key-chain** **Description** Authentication key-chain (Name of key-chain) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **level** **Description** 'level-1': Specify authentication key-chain for level-1 PDUs; 'level-2': Specify authentication key-chain for level-2 PDUs; **Type:** string **Supported Values:** level-1, level-2 .. _1521_isis-list_authentication_mode-list: isis-list_authentication_mode-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **level** **Description** 'level-1': Specify authentication mode for level-1 PDUs; 'level-2': Specify authentication mode for level-2 PDUs; **Type:** string **Supported Values:** level-1, level-2 **mode** **Description** 'md5': Authentication mode; **Type:** string **Supported Values:** md5 .. _1521_isis-list_authentication_send-only-list: isis-list_authentication_send-only-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **level** **Description** 'level-1': Specify authentication send-only for level-1 PDUs; 'level-2': Specify authentication send-only for level-2 PDUs; **Type:** string **Supported Values:** level-1, level-2 **send-only** **Description** Authentication send-only **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1521_isis-list_protocol-list: isis-list_protocol-list ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **protocol-topology** **Description** Protocol Topology **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1521_isis-list_log-adjacency-changes-cfg: isis-list_log-adjacency-changes-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **state** **Description** 'detail': Log changes in adjacency state; 'disable': Disable logging; **Type:** string **Supported Values:** detail, disable .. _1521_isis-list_spf-interval-exp-list: isis-list_spf-interval-exp-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **level** **Description** 'level-1': Set interval for level 1 only; 'level-2': Set interval for level 2 only; **Type:** string **Supported Values:** level-1, level-2 **max** **Description** Maximum Delay between receiving a change to SPF calculation in milliseconds **Type:** number **Range:** 0-2147483647 **Default:** 50000 **min** **Description** Minimum Delay between receiving a change to SPF calculation in milliseconds **Type:** number **Range:** 0-2147483647 **Default:** 500 .. _1521_isis-list_passive-interface-list: isis-list_passive-interface-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet interface (Port number) **Type:** number **Format:** interface **lif** **Description** Logical interface (Lif interface number) **Type:** number **Format:** interface **loopback** **Description** Loopback interface (Port number) **Type:** number **Format:** interface **trunk** **Description** Trunk interface (Trunk interface number) **Type:** number **Format:** interface **tunnel** **Description** Tunnel interface (Tunnel interface number) **Type:** number **Format:** interface **ve** **Description** Virtual ethernet interface (Virtual ethernet interface number) **Type:** number **Format:** interface .. _1521_isis-list_summary-address-list: isis-list_summary-address-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **level** **Description** 'level-1': Summarize into level-1 area; 'level-1-2': Summarize into both area and sub-domain; 'level-2': Summarize into level-2 sub-domain; **Type:** string **Supported Values:** level-1, level-1-2, level-2 **Default:** level-2 **prefix** **Description** IP network prefix **Type:** string **Format:** ipv4-cidr .. _1521_isis-list_address-family: isis-list_address-family ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ipv6** **Description:** ipv6 is a **JSON Block**. Please see below for :ref:`1521_isis-list_address-family_ipv6` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/isis/{tag}/address-family/ipv6 ` .. _1521_isis-list_address-family_ipv6: isis-list_address-family_ipv6 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **adjacency-check** **Description** Check ISIS neighbor protocol support **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **default-information** **Description** 'originate': Distribute a default route; **Type:** string **Supported Values:** originate **distance** **Description** ISIS Administrative Distance (Distance value) **Type:** number **Range:** 1-255 **Default:** 115 **multi-topology-cfg** **Description:** multi-topology-cfg is a **JSON Block**. Please see below for :ref:`1521_isis-list_address-family_ipv6_multi-topology-cfg` **Type:** Object **redistribute** **Description:** redistribute is a **JSON Block**. Please see below for :ref:`1521_isis-list_address-family_ipv6_redistribute` **Type:** Object **Reference Object:** :doc:`/axapi/v3/router/isis/{tag}/address-family/ipv6/redistribute ` **summary-prefix-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1521_isis-list_address-family_ipv6_redistribute: isis-list_address-family_ipv6_redistribute ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **isis** **Description:** isis is a **JSON Block**. Please see below for :ref:`1521_isis-list_address-family_ipv6_redistribute_isis` **Type:** Object **redist-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vip-list** **Type:** List .. _1521_isis-list_address-family_ipv6_redistribute_vip-list: isis-list_address-family_ipv6_redistribute_vip-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **vip-level** **Description** 'level-1': IS-IS level-1 routes only; 'level-1-2': IS-IS level-1 and level-2 routes; 'level-2': IS-IS level-2 routes only; **Type:** string **Supported Values:** level-1, level-1-2, level-2 **Default:** level-2 **vip-metric** **Description** Metric for redistributed routes (IS-IS default metric) **Type:** number **Range:** 0-4261412864 **Default:** 0 **vip-metric-type** **Description** 'external': Set IS-IS External metric type; 'internal': Set IS-IS Internal metric type; **Type:** string **Supported Values:** external, internal **Default:** internal **vip-route-map** **Description** Route map reference (Pointer to route-map entries) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **vip-type** **Description** 'only-flagged': Selected Virtual IP (VIP); 'only-not-flagged': Only not flagged; **Type:** string **Supported Values:** only-flagged, only-not-flagged .. _1521_isis-list_address-family_ipv6_redistribute_redist-list: isis-list_address-family_ipv6_redistribute_redist-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **level** **Description** 'level-1': IS-IS level-1 routes only; 'level-1-2': IS-IS level-1 and level-2 routes; 'level-2': IS-IS level-2 routes only; **Type:** string **Supported Values:** level-1, level-1-2, level-2 **Default:** level-2 **metric** **Description** Metric for redistributed routes (IS-IS default metric) **Type:** number **Range:** 0-4261412864 **Default:** 0 **metric-type** **Description** 'external': Set IS-IS External metric type; 'internal': Set IS-IS Internal metric type; **Type:** string **Supported Values:** external, internal **Default:** internal **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; 'ip-nat': IP NAT; 'lw4o6': LW4O6 Prefix; 'nat-map': NAT MAP Prefix; 'static-nat': Static NAT; 'nat64': NAT64 Prefix; 'ospf': Open Shortest Path First (OSPF); 'rip': Routing Information Protocol (RIP); 'static': Static routes; **Type:** string **Supported Values:** bgp, connected, floating-ip, ip-nat-list, ip-nat, lw4o6, nat-map, static-nat, nat64, ospf, rip, static .. _1521_isis-list_address-family_ipv6_redistribute_isis: isis-list_address-family_ipv6_redistribute_isis ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **level-1-from** **Description:** level-1-from is a **JSON Block**. Please see below for :ref:`1521_isis-list_address-family_ipv6_redistribute_isis_level-1-from` **Type:** Object **level-2-from** **Description:** level-2-from is a **JSON Block**. Please see below for :ref:`1521_isis-list_address-family_ipv6_redistribute_isis_level-2-from` **Type:** Object .. _1521_isis-list_address-family_ipv6_redistribute_isis_level-2-from: isis-list_address-family_ipv6_redistribute_isis_level-2-from ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **into-2** **Description:** into-2 is a **JSON Block**. Please see below for :ref:`1521_isis-list_address-family_ipv6_redistribute_isis_level-2-from_into-2` **Type:** Object .. _1521_isis-list_address-family_ipv6_redistribute_isis_level-2-from_into-2: isis-list_address-family_ipv6_redistribute_isis_level-2-from_into-2 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **distribute-list** **Description** Select routes (Access-list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **level-1** **Description** Inter-area routes into level-2 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1521_isis-list_address-family_ipv6_redistribute_isis_level-1-from: isis-list_address-family_ipv6_redistribute_isis_level-1-from ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **into-1** **Description:** into-1 is a **JSON Block**. Please see below for :ref:`1521_isis-list_address-family_ipv6_redistribute_isis_level-1-from_into-1` **Type:** Object .. _1521_isis-list_address-family_ipv6_redistribute_isis_level-1-from_into-1: isis-list_address-family_ipv6_redistribute_isis_level-1-from_into-1 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **distribute-list** **Description** Select routes (Access-list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **level-2** **Description** Inter-area routes into level-2 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1521_isis-list_address-family_ipv6_multi-topology-cfg: isis-list_address-family_ipv6_multi-topology-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **level** **Description** 'level-1': Level-1 only; 'level-1-2': Level-1-2; 'level-2': Level-2 only; **Type:** string **Supported Values:** level-1, level-1-2, level-2 **Mutual Exclusion:** level and transition are mutually exclusive **level-transition** **Description** Accept and generate both IS-IS IPv6 and Multi-topology IPV6 TLVs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **multi-topology** **Description** Enable multi-topology mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **transition** **Description** Accept and generate both IS-IS IPv6 and Multi-topology IPV6 TLVs **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** transition and level are mutually exclusive .. _1521_isis-list_address-family_ipv6_summary-prefix-list: isis-list_address-family_ipv6_summary-prefix-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **level** **Description** 'level-1': Summarize into level-1 area; 'level-1-2': Summarize into both area and sub-domain; 'level-2': Summarize into level-2 sub-domain; **Type:** string **Supported Values:** level-1, level-1-2, level-2 **Default:** level-2 **prefix** **Description** IPv6 prefix **Type:** string **Format:** ipv6-address-plen .. _1521_isis-list_redistribute: isis-list_redistribute ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **isis** **Description:** isis is a **JSON Block**. Please see below for :ref:`1521_isis-list_redistribute_isis` **Type:** Object **redist-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vip-list** **Type:** List .. _1521_isis-list_redistribute_vip-list: isis-list_redistribute_vip-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **vip-level** **Description** 'level-1': IS-IS level-1 routes only; 'level-1-2': IS-IS level-1 and level-2 routes; 'level-2': IS-IS level-2 routes only; **Type:** string **Supported Values:** level-1, level-1-2, level-2 **Default:** level-2 **vip-metric** **Description** Metric for redistributed routes (IS-IS default metric) **Type:** number **Range:** 0-4261412864 **Default:** 0 **vip-metric-type** **Description** 'external': Set IS-IS External metric type; 'internal': Set IS-IS Internal metric type; **Type:** string **Supported Values:** external, internal **Default:** internal **vip-route-map** **Description** Route map reference (Pointer to route-map entries) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **vip-type** **Description** 'only-flagged': Selected Virtual IP (VIP); 'only-not-flagged': Only not flagged; **Type:** string **Supported Values:** only-flagged, only-not-flagged .. _1521_isis-list_redistribute_redist-list: isis-list_redistribute_redist-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **level** **Description** 'level-1': IS-IS level-1 routes only; 'level-1-2': IS-IS level-1 and level-2 routes; 'level-2': IS-IS level-2 routes only; **Type:** string **Supported Values:** level-1, level-1-2, level-2 **Default:** level-2 **metric** **Description** Metric for redistributed routes (IS-IS default metric) **Type:** number **Range:** 0-4261412864 **Default:** 0 **metric-type** **Description** 'external': Set IS-IS External metric type; 'internal': Set IS-IS Internal metric type; **Type:** string **Supported Values:** external, internal **Default:** internal **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; 'ip-nat': IP NAT; 'lw4o6': LW4O6 Prefix; 'nat-map': NAT MAP Prefix; 'static-nat': Static NAT; 'ospf': Open Shortest Path First (OSPF); 'rip': Routing Information Protocol (RIP); 'static': Static routes; **Type:** string **Supported Values:** bgp, connected, floating-ip, ip-nat-list, ip-nat, lw4o6, nat-map, static-nat, ospf, rip, static .. _1521_isis-list_redistribute_isis: isis-list_redistribute_isis ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **level-1-from** **Description:** level-1-from is a **JSON Block**. Please see below for :ref:`1521_isis-list_redistribute_isis_level-1-from` **Type:** Object **level-2-from** **Description:** level-2-from is a **JSON Block**. Please see below for :ref:`1521_isis-list_redistribute_isis_level-2-from` **Type:** Object .. _1521_isis-list_redistribute_isis_level-2-from: isis-list_redistribute_isis_level-2-from ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **into-2** **Description:** into-2 is a **JSON Block**. Please see below for :ref:`1521_isis-list_redistribute_isis_level-2-from_into-2` **Type:** Object .. _1521_isis-list_redistribute_isis_level-2-from_into-2: isis-list_redistribute_isis_level-2-from_into-2 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **distribute-list** **Description** Select routes (Access-list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **level-1** **Description** Inter-area routes into level-2 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1521_isis-list_redistribute_isis_level-1-from: isis-list_redistribute_isis_level-1-from ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **into-1** **Description:** into-1 is a **JSON Block**. Please see below for :ref:`1521_isis-list_redistribute_isis_level-1-from_into-1` **Type:** Object .. _1521_isis-list_redistribute_isis_level-1-from_into-1: isis-list_redistribute_isis_level-1-from_into-1 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **distribute-list** **Description** Select routes (Access-list name) **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **level-2** **Description** Inter-area routes into level-2 **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1521_isis-list_area-password-cfg: isis-list_area-password-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **authenticate** **Description:** authenticate is a **JSON Block**. Please see below for :ref:`1521_isis-list_area-password-cfg_authenticate` **Type:** Object **password** **Description** Configure the authentication password for an area (Area password) **Type:** string **Format:** string-rlx **Maximum Length:** 254 characters **Maximum Length:** 1 characters .. _1521_isis-list_area-password-cfg_authenticate: isis-list_area-password-cfg_authenticate ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **snp** **Description** 'send-only': Send but do not check PDUs on receiving; 'validate': Send and check PDUs on receiving; **Type:** string **Supported Values:** send-only, validate .. _1521_isis-list_lsp-gen-interval-list: isis-list_lsp-gen-interval-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **interval** **Description** Minimum interval in seconds **Type:** number **Range:** 1-120 **Default:** 30 **level** **Description** 'level-1': Set interval for level 1 only; 'level-2': Set interval for level 2 only; **Type:** string **Supported Values:** level-1, level-2 .. _1521_isis-list_distance-list: isis-list_distance-list ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **System-ID** **Description** System-ID in XXXX.XXXX.XXXX **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **acl** **Description** Access list name **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters **distance** **Description** ISIS Administrative Distance (Distance value) **Type:** number **Range:** 1-255 **Default:** 115 .. _1521_isis-list_ha-standby-extra-cost: isis-list_ha-standby-extra-cost ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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