.. _interface_lif: interface lif ============= Logical interface lif Specification ----------------- ===================================== =============================================================== **Parameter** **Value** ===================================== =============================================================== **Type** *Collection* **Object Key(s)** *ifname* **Collection Name** :ref:`1953_lif_list` **Collection URI** /axapi/v3/interface/lif **Element Name** lif **Element URI** /axapi/v3/interface/lif/{ifname} **Element Attributes** lif_attributes **Partition Visibility** shared **Statistics Data URI** /axapi/v3/interface/lif/{ifname}/stats **Operational Data URI** /axapi/v3/interface/lif/{ifname}/oper **Schema** :download:`lif schema ` ===================================== =============================================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Create Object .. raw:: html POST .. raw:: html /axapi/v3/interface/lif .. raw:: html :ref:`1953_lif_attributes` .. raw:: html
Create List .. raw:: html POST .. raw:: html /axapi/v3/interface/lif .. raw:: html :ref:`1953_lif_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/interface/lif/{ifname} .. raw:: html :ref:`1953_lif_attributes` .. raw:: html
Get List .. raw:: html GET .. raw:: html /axapi/v3/interface/lif .. raw:: html :ref:`1953_lif_list` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/interface/lif/{ifname} .. raw:: html :ref:`1953_lif_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/interface/lif/{ifname} .. raw:: html :ref:`1953_lif_attributes` .. raw:: html
Replace List .. raw:: html PUT .. raw:: html /axapi/v3/interface/lif .. raw:: html :ref:`1953_lif_list` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/interface/lif/{ifname} .. raw:: html :ref:`1953_lif_attributes` .. raw:: html
.. _1953_lif_list: lif-list -------- lif-list is **JSON List** of :ref:`1953_lif_attributes` lif-list : [ { :ref:`1953_lif_attributes` }, { :ref:`1953_lif_attributes` }, ... ] .. _1953_lif_attributes: lif attributes -------------- **access-list** **Description:** access-list is a **JSON Block**. Please see below for :ref:`1953_access-list` **Type:** Object **action** **Description** 'enable': Enable; 'disable': Disable; **Type:** string **Supported Values:** enable, disable **Default:** enable **bfd** **Description:** bfd is a **JSON Block**. Please see below for :ref:`1953_bfd` **Type:** Object **Reference Object:** :doc:`/axapi/v3/interface/lif/{ifname}/bfd ` **encapsulation** **Description:** encapsulation is a **JSON Block**. Please see below for :ref:`1953_encapsulation` **Type:** Object **Reference Object:** :doc:`/axapi/v3/interface/lif/{ifname}/encapsulation ` **ifname** **Description** Lif interface name **Type:** string **Maximum Length:** 15 characters **Maximum Length:** 1 characters **ip** **Description:** ip is a **JSON Block**. Please see below for :ref:`1953_ip` **Type:** Object **Reference Object:** :doc:`/axapi/v3/interface/lif/{ifname}/ip ` **ipv6** **Description:** ipv6 is a **JSON Block**. Please see below for :ref:`1953_ipv6` **Type:** Object **Reference Object:** :doc:`/axapi/v3/interface/lif/{ifname}/ipv6 ` **isis** **Description:** isis is a **JSON Block**. Please see below for :ref:`1953_isis` **Type:** Object **Reference Object:** :doc:`/axapi/v3/interface/lif/{ifname}/isis ` **mtu** **Description** Interface mtu (Interface MTU, default 1 (min MTU is 1280 for IPv6)) **Type:** number **name** **Description** Name for the interface **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **sampling-enable** **Type:** List **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 .. _1953_isis: isis ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **authentication** **Description:** authentication is a **JSON Block**. Please see below for :ref:`1953_isis_authentication` **Type:** Object **bfd-cfg** **Description:** bfd-cfg is a **JSON Block**. Please see below for :ref:`1953_isis_bfd-cfg` **Type:** Object **circuit-type** **Description** 'level-1': Level-1 only adjacencies are formed; 'level-1-2': Level-1-2 adjacencies are formed; 'level-2-only': Level-2 only adjacencies are formed; **Type:** string **Supported Values:** level-1, level-1-2, level-2-only **Default:** level-1-2 **csnp-interval-list** **Type:** List **hello-interval-list** **Type:** List **hello-interval-minimal-list** **Type:** List **hello-multiplier-list** **Type:** List **lsp-interval** **Description** Set LSP transmission interval (LSP transmission interval (milliseconds)) **Type:** number **Range:** 1-4294967295 **Default:** 33 **mesh-group** **Description:** mesh-group is a **JSON Block**. Please see below for :ref:`1953_isis_mesh-group` **Type:** Object **metric-list** **Type:** List **network** **Description** 'broadcast': Specify IS-IS broadcast multi-access network; 'point-to-point': Specify IS-IS point-to-point network; **Type:** string **Supported Values:** broadcast, point-to-point **padding** **Description** Add padding to IS-IS hello packets **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **password-list** **Type:** List **priority-list** **Type:** List **retransmit-interval** **Description** Set per-LSP retransmission interval (Interval between retransmissions of the same LSP (seconds)) **Type:** number **Range:** 0-65535 **Default:** 5 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **wide-metric-list** **Type:** List .. _1953_isis_priority-list: isis_priority-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **level** **Description** 'level-1': Specify priority for level-1 routing; 'level-2': Specify priority for level-2 routing; **Type:** string **Supported Values:** level-1, level-2 **priority** **Description** Set priority for Designated Router election (Priority value) **Type:** number **Range:** 0-127 **Default:** 64 .. _1953_isis_hello-interval-minimal-list: isis_hello-interval-minimal-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **hello-interval-minimal** **Description** Set Hello holdtime 1 second, interval depends on multiplier **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **level** **Description** 'level-1': Specify hello-interval for level-1 IIHs; 'level-2': Specify hello-interval for level-2 IIHs; **Type:** string **Supported Values:** level-1, level-2 .. _1953_isis_mesh-group: isis_mesh-group ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **blocked** **Description** Block LSPs on this interface **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** blocked and value are mutually exclusive **value** **Description** Mesh group number **Type:** number **Range:** 1-4294967295 **Mutual Exclusion:** value and blocked are mutually exclusive .. _1953_isis_bfd-cfg: isis_bfd-cfg ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bfd** **Description** Bidirectional Forwarding Detection (BFD) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable** **Description** Disable BFD **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1953_isis_password-list: isis_password-list ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **level** **Description** 'level-1': Specify password for level-1 PDUs; 'level-2': Specify password for level-2 PDUs; **Type:** string **Supported Values:** level-1, level-2 **password** **Description** Configure the authentication password for interface **Type:** string **Format:** string-rlx **Maximum Length:** 254 characters **Maximum Length:** 1 characters .. _1953_isis_authentication: isis_authentication ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **key-chain-list** **Type:** List **mode-list** **Type:** List **send-only-list** **Type:** List .. _1953_isis_authentication_key-chain-list: isis_authentication_key-chain-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _1953_isis_authentication_mode-list: isis_authentication_mode-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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': Keyed message digest; **Type:** string **Supported Values:** md5 .. _1953_isis_authentication_send-only-list: isis_authentication_send-only-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 .. _1953_isis_wide-metric-list: isis_wide-metric-list ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **level** **Description** 'level-1': Apply metric to level-1 links; 'level-2': Apply metric to level-2 links; **Type:** string **Supported Values:** level-1, level-2 **wide-metric** **Description** Configure the wide metric for interface **Type:** number **Range:** 1-16777214 **Default:** 10 .. _1953_isis_hello-interval-list: isis_hello-interval-list ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **hello-interval** **Description** Set Hello interval in seconds (Hello interval value) **Type:** number **Range:** 1-65535 **Default:** 10 **level** **Description** 'level-1': Specify hello-interval for level-1 IIHs; 'level-2': Specify hello-interval for level-2 IIHs; **Type:** string **Supported Values:** level-1, level-2 .. _1953_isis_hello-multiplier-list: isis_hello-multiplier-list ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **hello-multiplier** **Description** Set multiplier for Hello holding time (Hello multiplier value) **Type:** number **Range:** 2-100 **Default:** 3 **level** **Description** 'level-1': Specify hello multiplier for level-1 IIHs; 'level-2': Specify hello multiplier for level-2 IIHs; **Type:** string **Supported Values:** level-1, level-2 .. _1953_isis_metric-list: isis_metric-list ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **level** **Description** 'level-1': Apply metric to level-1 links; 'level-2': Apply metric to level-2 links; **Type:** string **Supported Values:** level-1, level-2 **metric** **Description** Configure the metric for interface (Default metric) **Type:** number **Range:** 1-63 **Default:** 10 .. _1953_isis_csnp-interval-list: isis_csnp-interval-list ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **csnp-interval** **Description** Set CSNP interval in seconds (CSNP interval value) **Type:** number **Range:** 1-65535 **Default:** 10 **level** **Description** 'level-1': Speficy interval for level-1 CSNPs; 'level-2': Specify interval for level-2 CSNPs; **Type:** string **Supported Values:** level-1, level-2 .. _1953_bfd: bfd ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **authentication** **Description:** authentication is a **JSON Block**. Please see below for :ref:`1953_bfd_authentication` **Type:** Object **demand** **Description** Demand mode **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **echo** **Description** Enable BFD Echo **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **interval-cfg** **Description:** interval-cfg is a **JSON Block**. Please see below for :ref:`1953_bfd_interval-cfg` **Type:** Object **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1953_bfd_authentication: bfd_authentication ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) **key-id** **Description** Key ID **Type:** number **Range:** 0-255 **method** **Description** 'md5': Keyed MD5; 'meticulous-md5': Meticulous Keyed MD5; 'meticulous-sha1': Meticulous Keyed SHA1; 'sha1': Keyed SHA1; 'simple': Simple Password; **Type:** string **Supported Values:** md5, meticulous-md5, meticulous-sha1, sha1, simple **password** **Description** Key String **Type:** string **Format:** password **Maximum Length:** 16 characters **Maximum Length:** 1 characters .. _1953_bfd_interval-cfg: bfd_interval-cfg ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **interval** **Description** Transmit interval between BFD packets (Milliseconds) **Type:** number **Range:** 48-1000 **min-rx** **Description** Minimum receive interval capability (Milliseconds) **Type:** number **Range:** 48-1000 **multiplier** **Description** Multiplier value used to compute holddown (value used to multiply the interval) **Type:** number **Range:** 3-50 .. _1953_ip: ip ^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **address-list** **Type:** List **allow-promiscuous-vip** **Description** Allow traffic to be associated with promiscuous VIP **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **cache-spoofing-port** **Description** This interface connects to spoofing cache **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **dhcp** **Description** Use DHCP to configure IP address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **generate-membership-query** **Description** Enable Membership Query **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **inside** **Description** Configure interface as inside **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **max-resp-time** **Description** Maximum Response Time (Max Response Time (Default is 100)) **Type:** number **Range:** 1-255 **Default:** 100 **ospf** **Description:** ospf is a **JSON Block**. Please see below for :ref:`1953_ip_ospf` **Type:** Object **Reference Object:** :doc:`/axapi/v3/interface/lif/{ifname}/ip/ospf ` **outside** **Description** Configure interface as outside **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **query-interval** **Description** 1 - 255 (Default is 125) **Type:** number **Range:** 1-255 **Default:** 125 **rip** **Description:** rip is a **JSON Block**. Please see below for :ref:`1953_ip_rip` **Type:** Object **Reference Object:** :doc:`/axapi/v3/interface/lif/{ifname}/ip/rip ` **router** **Description:** router is a **JSON Block**. Please see below for :ref:`1953_ip_router` **Type:** Object **Reference Object:** :doc:`/axapi/v3/interface/lif/{ifname}/ip/router ` **unnumbered** **Description** Set the interface as unnumbered **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 .. _1953_ip_router: ip_router ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **isis** **Description:** isis is a **JSON Block**. Please see below for :ref:`1953_ip_router_isis` **Type:** Object **Reference Object:** :doc:`/axapi/v3/interface/lif/{ifname}/ip/router/isis ` .. _1953_ip_router_isis: ip_router_isis ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **tag** **Description** ISO routing area tag **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 .. _1953_ip_rip: ip_rip ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **authentication** **Description:** authentication is a **JSON Block**. Please see below for :ref:`1953_ip_rip_authentication` **Type:** Object **receive-cfg** **Description:** receive-cfg is a **JSON Block**. Please see below for :ref:`1953_ip_rip_receive-cfg` **Type:** Object **receive-packet** **Description** Enable receiving packet through the specified interface **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **send-cfg** **Description:** send-cfg is a **JSON Block**. Please see below for :ref:`1953_ip_rip_send-cfg` **Type:** Object **send-packet** **Description** Enable sending packets through the specified interface **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **split-horizon-cfg** **Description:** split-horizon-cfg is a **JSON Block**. Please see below for :ref:`1953_ip_rip_split-horizon-cfg` **Type:** Object **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1953_ip_rip_receive-cfg: ip_rip_receive-cfg ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **receive** **Description** Advertisement reception **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **version** **Description** '1': RIP version 1; '2': RIP version 2; '1-2': RIP version 1 & 2; **Type:** string **Supported Values:** 1, 2, 1-2 .. _1953_ip_rip_split-horizon-cfg: ip_rip_split-horizon-cfg ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **state** **Description** 'poisoned': Perform split horizon with poisoned reverse; 'disable': Disable split horizon; 'enable': Perform split horizon without poisoned reverse; **Type:** string **Supported Values:** poisoned, disable, enable **Default:** poisoned .. _1953_ip_rip_authentication: ip_rip_authentication ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **key-chain** **Description:** key-chain is a **JSON Block**. Please see below for :ref:`1953_ip_rip_authentication_key-chain` **Type:** Object **mode** **Description:** mode is a **JSON Block**. Please see below for :ref:`1953_ip_rip_authentication_mode` **Type:** Object **str** **Description:** str is a **JSON Block**. Please see below for :ref:`1953_ip_rip_authentication_str` **Type:** Object .. _1953_ip_rip_authentication_key-chain: ip_rip_authentication_key-chain ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **key-chain** **Description** Authentication key-chain (Name of key-chain) **Type:** string **Format:** string-rlx .. _1953_ip_rip_authentication_mode: ip_rip_authentication_mode ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **mode** **Description** 'md5': Keyed message digest; 'text': Clear text authentication; **Type:** string **Supported Values:** md5, text **Default:** text .. _1953_ip_rip_authentication_str: ip_rip_authentication_str ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **string** **Description** The RIP authentication string **Type:** string **Format:** string-rlx **Maximum Length:** 16 characters **Maximum Length:** 1 characters .. _1953_ip_rip_send-cfg: ip_rip_send-cfg ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **send** **Description** Advertisement transmission **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **version** **Description** '1': RIP version 1; '2': RIP version 2; '1-compatible': RIPv1-compatible; '1-2': RIP version 1 & 2; **Type:** string **Supported Values:** 1, 2, 1-compatible, 1-2 .. _1953_ip_address-list: ip_address-list ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ipv4-address** **Description** IP address **Type:** string **Format:** ipv4-address **ipv4-netmask** **Description** IP subnet mask **Type:** string **Format:** ipv4-netmask .. _1953_ip_ospf: ip_ospf ^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ospf-global** **Description:** ospf-global is a **JSON Block**. Please see below for :ref:`1953_ip_ospf_ospf-global` **Type:** Object **Reference Object:** :doc:`/axapi/v3/interface/lif/{ifname}/ip/ospf/ospf-global ` **ospf-ip-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/interface/lif/{ifname}/ip/ospf/ospf-ip/{ip-addr} ` .. _1953_ip_ospf_ospf-ip-list: ip_ospf_ospf-ip-list ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **authentication** **Description** Enable authentication **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **authentication-key** **Description** Authentication password (key) (The OSPF password (key)) **Type:** string **Format:** string-rlx **Maximum Length:** 8 characters **Maximum Length:** 1 characters **cost** **Description** Interface cost **Type:** number **Range:** 1-65535 **database-filter** **Description** 'all': Filter all LSA; **Type:** string **Supported Values:** all **dead-interval** **Description** Interval after which a neighbor is declared dead (Seconds) **Type:** number **Range:** 1-65535 **Default:** 40 **hello-interval** **Description** Time between HELLO packets (Seconds) **Type:** number **Range:** 1-65535 **Default:** 10 **ip-addr** **Description** Address of interface **Type:** string **Format:** ipv4-address **message-digest-cfg** **Type:** List **mtu-ignore** **Description** Ignores the MTU in DBD packets **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **out** **Description** Outgoing LSA **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **priority** **Description** Router priority **Type:** number **Range:** 0-255 **Default:** 1 **retransmit-interval** **Description** Time between retransmitting lost link state advertisements (Seconds) **Type:** number **Range:** 1-65535 **Default:** 5 **transmit-delay** **Description** Link state transmit delay (Seconds) **Type:** number **Range:** 1-65535 **Default:** 1 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **value** **Description** 'message-digest': Use message-digest authentication; 'null': Use no authentication; **Type:** string **Supported Values:** message-digest, null .. _1953_ip_ospf_ospf-ip-list_message-digest-cfg: ip_ospf_ospf-ip-list_message-digest-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) **md5-value** **Description** The OSPF password (1-16) **Type:** string **Format:** password **Maximum Length:** 16 characters **Maximum Length:** 1 characters **message-digest-key** **Description** Message digest authentication password (key) (Key id) **Type:** number **Range:** 1-255 .. _1953_ip_ospf_ospf-global: ip_ospf_ospf-global ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **authentication-cfg** **Description:** authentication-cfg is a **JSON Block**. Please see below for :ref:`1953_ip_ospf_ospf-global_authentication-cfg` **Type:** Object **authentication-key** **Description** Authentication password (key) (The OSPF password (key)) **Type:** string **Format:** string-rlx **Maximum Length:** 8 characters **Maximum Length:** 1 characters **bfd-cfg** **Description:** bfd-cfg is a **JSON Block**. Please see below for :ref:`1953_ip_ospf_ospf-global_bfd-cfg` **Type:** Object **cost** **Description** Interface cost **Type:** number **Range:** 1-65535 **database-filter-cfg** **Description:** database-filter-cfg is a **JSON Block**. Please see below for :ref:`1953_ip_ospf_ospf-global_database-filter-cfg` **Type:** Object **dead-interval** **Description** Interval after which a neighbor is declared dead (Seconds) **Type:** number **Range:** 1-65535 **Default:** 40 **disable** **Description** 'all': All functionality; **Type:** string **Supported Values:** all **hello-interval** **Description** Time between HELLO packets (Seconds) **Type:** number **Range:** 1-65535 **Default:** 10 **message-digest-cfg** **Type:** List **mtu** **Description** OSPF interface MTU (MTU size) **Type:** number **Range:** 576-65535 **mtu-ignore** **Description** Ignores the MTU in DBD packets **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **network** **Description:** network is a **JSON Block**. Please see below for :ref:`1953_ip_ospf_ospf-global_network` **Type:** Object **priority** **Description** Router priority **Type:** number **Range:** 0-255 **Default:** 1 **retransmit-interval** **Description** Time between retransmitting lost link state advertisements (Seconds) **Type:** number **Range:** 1-65535 **Default:** 5 **transmit-delay** **Description** Link state transmit delay (Seconds) **Type:** number **Range:** 1-65535 **Default:** 1 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1953_ip_ospf_ospf-global_network: ip_ospf_ospf-global_network ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **broadcast** **Description** Specify OSPF broadcast multi-access network **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** broadcast,non-broadcast, point-to-point, and point-to-multipoint are mutually exclusive **non-broadcast** **Description** Specify OSPF NBMA network **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** non-broadcast,broadcast, point-to-point, and point-to-multipoint are mutually exclusive **p2mp-nbma** **Description** Specify non-broadcast point-to-multipoint network **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **point-to-multipoint** **Description** Specify OSPF point-to-multipoint network **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** point-to-multipoint,broadcast, non-broadcast, and point-to-point are mutually exclusive **point-to-point** **Description** Specify OSPF point-to-point network **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **Mutual Exclusion:** point-to-point,broadcast, non-broadcast, and point-to-multipoint are mutually exclusive .. _1953_ip_ospf_ospf-global_authentication-cfg: ip_ospf_ospf-global_authentication-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **authentication** **Description** Enable authentication **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **value** **Description** 'message-digest': Use message-digest authentication; 'null': Use no authentication; **Type:** string **Supported Values:** message-digest, null .. _1953_ip_ospf_ospf-global_database-filter-cfg: ip_ospf_ospf-global_database-filter-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **database-filter** **Description** 'all': Filter all LSA; **Type:** string **Supported Values:** all **out** **Description** Outgoing LSA **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1953_ip_ospf_ospf-global_bfd-cfg: ip_ospf_ospf-global_bfd-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bfd** **Description** Bidirectional Forwarding Detection (BFD) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **disable** **Description** Disable BFD **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1953_ip_ospf_ospf-global_message-digest-cfg: ip_ospf_ospf-global_message-digest-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **md5** **Description:** md5 is a **JSON Block**. Please see below for :ref:`1953_ip_ospf_ospf-global_message-digest-cfg_md5` **Type:** Object **message-digest-key** **Description** Message digest authentication password (key) (Key id) **Type:** number **Range:** 1-255 .. _1953_ip_ospf_ospf-global_message-digest-cfg_md5: ip_ospf_ospf-global_message-digest-cfg_md5 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string) **md5-value** **Description** The OSPF password (1-16) **Type:** string **Format:** password **Maximum Length:** 16 characters **Maximum Length:** 1 characters .. _1953_access-list: access-list ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **acl-id** **Description** ACL id **Type:** number **Range:** 1-199 **Reference Object:** :doc:`/axapi/v3/access-list/standard ` **acl-name** **Description** Apply an access list (Named Access List) **Type:** string **Maximum Length:** 16 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/ip/access-list ` .. _1953_sampling-enable: sampling-enable ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **counters1** **Description** 'all': all; 'num_pkts': some help string; 'num_total_bytes': some help string; 'num_unicast_pkts': some help string; 'num_broadcast_pkts': some help string; 'num_multicast_pkts': some help string; 'num_tx_pkts': some help string; 'num_total_tx_bytes': some help string; 'num_unicast_tx_pkts': some help string; 'num_broadcast_tx_pkts': some help string; 'num_multicast_tx_pkts': some help string; 'dropped_dis_rx_pkts': some help string; 'dropped_rx_pkts': some help string; 'dropped_dis_tx_pkts': some help string; 'dropped_tx_pkts': some help string; 'dropped_rx_pkts_gre_key': some help string; **Type:** string **Supported Values:** all, num_pkts, num_total_bytes, num_unicast_pkts, num_broadcast_pkts, num_multicast_pkts, num_tx_pkts, num_total_tx_bytes, num_unicast_tx_pkts, num_broadcast_tx_pkts, num_multicast_tx_pkts, dropped_dis_rx_pkts, dropped_rx_pkts, dropped_dis_tx_pkts, dropped_tx_pkts, dropped_rx_pkts_gre_key .. _1953_ipv6: ipv6 ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **address-list** **Type:** List **inside** **Description** Configure interface as inside **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ipv6-enable** **Description** Enable IPv6 processing **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ospf** **Description:** ospf is a **JSON Block**. Please see below for :ref:`1953_ipv6_ospf` **Type:** Object **Reference Object:** :doc:`/axapi/v3/interface/lif/{ifname}/ipv6/ospf ` **outside** **Description** Configure interface as outside **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **router** **Description:** router is a **JSON Block**. Please see below for :ref:`1953_ipv6_router` **Type:** Object **Reference Object:** :doc:`/axapi/v3/interface/lif/{ifname}/ipv6/router ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1953_ipv6_address-list: ipv6_address-list ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **anycast** **Description** Configure an IPv6 anycast address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ipv6-addr** **Description** Set the IPv6 address of an interface **Type:** string **Format:** ipv6-address-plen **link-local** **Description** Configure an IPv6 link local address **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1953_ipv6_router: ipv6_router ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **isis** **Description:** isis is a **JSON Block**. Please see below for :ref:`1953_ipv6_router_isis` **Type:** Object **Reference Object:** :doc:`/axapi/v3/interface/lif/{ifname}/ipv6/router/isis ` **ospf** **Description:** ospf is a **JSON Block**. Please see below for :ref:`1953_ipv6_router_ospf` **Type:** Object **Reference Object:** :doc:`/axapi/v3/interface/lif/{ifname}/ipv6/router/ospf ` **ripng** **Description:** ripng is a **JSON Block**. Please see below for :ref:`1953_ipv6_router_ripng` **Type:** Object **Reference Object:** :doc:`/axapi/v3/interface/lif/{ifname}/ipv6/router/ripng ` .. _1953_ipv6_router_ripng: ipv6_router_ripng ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **rip** **Description** RIP Routing for IPv6 **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 .. _1953_ipv6_router_ospf: ipv6_router_ospf ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **area-list** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1953_ipv6_router_ospf_area-list: ipv6_router_ospf_area-list ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **area-id-addr** **Description** OSPF area ID in IP address format **Type:** string **Format:** ipv4-address **area-id-num** **Description** OSPF area ID as a decimal value **Type:** number **Range:** 0-4294967295 **instance-id** **Description** Set the interface instance ID **Type:** number **Range:** 0-255 **Default:** 0 **tag** **Description** Set the OSPFv3 process tag **Type:** string **Maximum Length:** 128 characters **Maximum Length:** 1 characters .. _1953_ipv6_router_isis: ipv6_router_isis ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **tag** **Description** ISO routing area tag **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 .. _1953_ipv6_ospf: ipv6_ospf ^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bfd** **Description** Bidirectional Forwarding Detection (BFD) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **cost-cfg** **Type:** List **dead-interval-cfg** **Type:** List **disable** **Description** Disable BFD **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **hello-interval-cfg** **Type:** List **mtu-ignore-cfg** **Type:** List **neighbor-cfg** **Type:** List **network-list** **Type:** List **priority-cfg** **Type:** List **retransmit-interval-cfg** **Type:** List **transmit-delay-cfg** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1953_ipv6_ospf_cost-cfg: ipv6_ospf_cost-cfg ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **cost** **Description** Interface cost **Type:** number **Range:** 1-65535 **instance-id** **Description** Specify the interface instance ID **Type:** number **Range:** 0-255 **Default:** 0 .. _1953_ipv6_ospf_hello-interval-cfg: ipv6_ospf_hello-interval-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **hello-interval** **Description** Time between HELLO packets (Seconds) **Type:** number **Range:** 1-65535 **Default:** 10 **instance-id** **Description** Specify the interface instance ID **Type:** number **Range:** 0-255 **Default:** 0 .. _1953_ipv6_ospf_priority-cfg: ipv6_ospf_priority-cfg ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **instance-id** **Description** Specify the interface instance ID **Type:** number **Range:** 0-255 **Default:** 0 **priority** **Description** Router priority **Type:** number **Range:** 0-255 **Default:** 1 .. _1953_ipv6_ospf_mtu-ignore-cfg: ipv6_ospf_mtu-ignore-cfg ^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **instance-id** **Description** Specify the interface instance ID **Type:** number **Range:** 0-255 **Default:** 0 **mtu-ignore** **Description** Ignores the MTU in DBD packets **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1953_ipv6_ospf_retransmit-interval-cfg: ipv6_ospf_retransmit-interval-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **instance-id** **Description** Specify the interface instance ID **Type:** number **Range:** 0-255 **Default:** 0 **retransmit-interval** **Description** Time between retransmitting lost link state advertisements (Seconds) **Type:** number **Range:** 1-65535 **Default:** 5 .. _1953_ipv6_ospf_network-list: ipv6_ospf_network-list ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **broadcast-type** **Description** 'broadcast': Specify OSPF broadcast multi-access network; 'non-broadcast': Specify OSPF NBMA network; 'point-to-point': Specify OSPF point-to-point network; 'point-to-multipoint': Specify OSPF point-to-multipoint network; **Type:** string **Supported Values:** broadcast, non-broadcast, point-to-point, point-to-multipoint **network-instance-id** **Description** Specify the interface instance ID **Type:** number **Range:** 0-255 **Default:** 0 **p2mp-nbma** **Description** Specify non-broadcast point-to-multipoint network **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _1953_ipv6_ospf_transmit-delay-cfg: ipv6_ospf_transmit-delay-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **instance-id** **Description** Specify the interface instance ID **Type:** number **Range:** 0-255 **Default:** 0 **transmit-delay** **Description** Link state transmit delay (Seconds) **Type:** number **Range:** 1-65535 **Default:** 1 .. _1953_ipv6_ospf_neighbor-cfg: ipv6_ospf_neighbor-cfg ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **neig-inst** **Description** Specify the interface instance ID **Type:** number **Range:** 0-255 **Default:** 0 **neighbor** **Description** OSPFv3 neighbor (Neighbor IPv6 address) **Type:** string **Format:** ipv6-address **Default:** \:: **neighbor-cost** **Description** OSPF cost for point-to-multipoint neighbor (metric) **Type:** number **Range:** 1-65535 **neighbor-poll-interval** **Description** OSPF dead-router polling interval (Seconds) **Type:** number **Range:** 0-4294967295 **neighbor-priority** **Description** OSPF priority of non-broadcast neighbor **Type:** number **Range:** 0-255 .. _1953_ipv6_ospf_dead-interval-cfg: ipv6_ospf_dead-interval-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **dead-interval** **Description** Interval after which a neighbor is declared dead (Seconds) **Type:** number **Range:** 1-65535 **Default:** 40 **instance-id** **Description** Specify the interface instance ID **Type:** number **Range:** 0-255 **Default:** 0 .. _1953_encapsulation: encapsulation ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **dot1q** **Description:** dot1q is a **JSON Block**. Please see below for :ref:`1953_encapsulation_dot1q` **Type:** Object **Reference Object:** :doc:`/axapi/v3/interface/lif/{ifname}/encapsulation/dot1q ` .. _1953_encapsulation_dot1q: encapsulation_dot1q ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ethernet** **Description** Ethernet Interface (Ethernet port number) **Type:** number **Format:** interface **Mutual Exclusion:** ethernet and trunk are mutually exclusive **tag** **Description** Tag ID **Type:** number **Range:** 2-4094 **trunk** **Description** Trunk Interface (Trunk number) **Type:** number **Range:** 1-4096 **Mutual Exclusion:** trunk and ethernet are mutually exclusive **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters