.. _scaleout: scaleout ======== Configure scaleout scaleout Specification ---------------------- ===================================== ================================================= **Parameter** **Value** ===================================== ================================================= **Type** *Intermediate Resource* **Element Name** scaleout **Element URI** /axapi/v3/scaleout **Element Attributes** scaleout_attributes **Partition Visibility** shared **Schema** :download:`scaleout schema ` ===================================== ================================================= **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/scaleout .. raw:: html scaleout_attributes .. raw:: html
.. _2660_scaleout_attributes: scaleout attributes ------------------- **apps** **Description:** apps is a **JSON Block**. Please see below for :ref:`2660_apps` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/apps ` **cluster-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id} ` **debug** **Description:** debug is a **JSON Block**. Please see below for :ref:`2660_debug` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug ` **distributed-forwarding** **Description:** distributed-forwarding is a **JSON Block**. Please see below for :ref:`2660_distributed-forwarding` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/distributed-forwarding ` **status** **Description:** status is a **JSON Block**. Please see below for :ref:`2660_status` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/status ` **traffic-map** **Description:** traffic-map is a **JSON Block**. Please see below for :ref:`2660_traffic-map` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/traffic-map ` .. _2660_status: status ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_apps: apps ^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **enable** **Description** Enable Scaleout for apps **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **skip-mac-overwrite** **Description:** skip-mac-overwrite is a **JSON Block**. Please see below for :ref:`2660_apps_skip-mac-overwrite` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/apps/skip-mac-overwrite ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_apps_skip-mac-overwrite: apps_skip-mac-overwrite ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **enable** **Description** Skips overwriting dest MAC of flooded packets on Active node **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 .. _2660_traffic-map: traffic-map ^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_distributed-forwarding: distributed-forwarding ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cgn** **Description:** cgn is a **JSON Block**. Please see below for :ref:`2660_distributed-forwarding_cgn` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/distributed-forwarding/cgn ` **fw** **Description:** fw is a **JSON Block**. Please see below for :ref:`2660_distributed-forwarding_fw` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/distributed-forwarding/fw ` **slb** **Description:** slb is a **JSON Block**. Please see below for :ref:`2660_distributed-forwarding_slb` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/distributed-forwarding/slb ` .. _2660_distributed-forwarding_fw: distributed-forwarding_fw ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **fw-value** **Description** 'enable': Enable FW; 'disable': Disable FW; **Type:** string **Supported Values:** enable, disable **Default:** disable **session-offload-direction** **Description** 'uplink': Enable session offload only in uplink direction; 'downlink': Enable session offload in downlink direction; 'both': Enable session offload in both direction; **Type:** string **Supported Values:** uplink, downlink, both **Default:** both **threshold** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_distributed-forwarding_fw_threshold: distributed-forwarding_fw_threshold ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **protocol-value** **Description** 'UDP': configure threshold for udp session offload; 'TCP': configure threshold for tcp session offload; **Type:** string **Supported Values:** UDP, TCP **threshold-value** **Description** configure packet threshold value to offload sessions(default 5) **Type:** number **Range:** 4-63 **Default:** 5 .. _2660_distributed-forwarding_slb: distributed-forwarding_slb ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **slb-value** **Description** 'enable': Enable SLB; 'disable': Disable SLB; **Type:** string **Supported Values:** enable, disable **Default:** disable **tcp-threshold** **Description** configure packet threshold value to offload TCP sessions(default 5) **Type:** number **Range:** 4-63 **Default:** 5 **udp-threshold** **Description** configure packet threshold value to offload UDP sessions(default 5) **Type:** number **Range:** 4-63 **Default:** 5 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_distributed-forwarding_cgn: distributed-forwarding_cgn ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cgn-value** **Description** 'enable': Enable CGN; 'disable': Disable CGN; **Type:** string **Supported Values:** enable, disable **Default:** disable **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_debug: debug ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cluster** **Description:** cluster is a **JSON Block**. Please see below for :ref:`2660_debug_cluster` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/cluster ` **hash-table** **Description:** hash-table is a **JSON Block**. Please see below for :ref:`2660_debug_hash-table` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/hash-table ` **info** **Description:** info is a **JSON Block**. Please see below for :ref:`2660_debug_info` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/info ` **ipv6** **Description:** ipv6 is a **JSON Block**. Please see below for :ref:`2660_debug_ipv6` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/ipv6 ` **nat-list** **Description:** nat-list is a **JSON Block**. Please see below for :ref:`2660_debug_nat-list` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/nat-list ` **nat-map** **Description:** nat-map is a **JSON Block**. Please see below for :ref:`2660_debug_nat-map` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/nat-map ` **reachability** **Description:** reachability is a **JSON Block**. Please see below for :ref:`2660_debug_reachability` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/reachability ` **redirect-table** **Description:** redirect-table is a **JSON Block**. Please see below for :ref:`2660_debug_redirect-table` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/redirect-table ` **resource-tracking** **Description:** resource-tracking is a **JSON Block**. Please see below for :ref:`2660_debug_resource-tracking` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/resource-tracking ` **role** **Description:** role is a **JSON Block**. Please see below for :ref:`2660_debug_role` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/role ` **traffic-map** **Description:** traffic-map is a **JSON Block**. Please see below for :ref:`2660_debug_traffic-map` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/traffic-map ` .. _2660_debug_info: debug_info ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_debug_resource-tracking: debug_resource-tracking ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_debug_cluster: debug_cluster ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **database** **Description:** database is a **JSON Block**. Please see below for :ref:`2660_debug_cluster_database` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/cluster/database ` **status** **Description:** status is a **JSON Block**. Please see below for :ref:`2660_debug_cluster_status` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/cluster/status ` .. _2660_debug_cluster_status: debug_cluster_status ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_debug_cluster_database: debug_cluster_database ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_debug_nat-map: debug_nat-map ^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_debug_traffic-map: debug_traffic-map ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_debug_nat-list: debug_nat-list ^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_debug_reachability: debug_reachability ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_debug_role: debug_role ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_debug_redirect-table: debug_redirect-table ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **l2** **Description:** l2 is a **JSON Block**. Please see below for :ref:`2660_debug_redirect-table_l2` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/redirect-table/l2 ` **l3** **Description:** l3 is a **JSON Block**. Please see below for :ref:`2660_debug_redirect-table_l3` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/redirect-table/l3 ` .. _2660_debug_redirect-table_l2: debug_redirect-table_l2 ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_debug_redirect-table_l3: debug_redirect-table_l3 ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_debug_ipv6: debug_ipv6 ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **reachability** **Description:** reachability is a **JSON Block**. Please see below for :ref:`2660_debug_ipv6_reachability` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/ipv6/reachability ` **redirect-table** **Description:** redirect-table is a **JSON Block**. Please see below for :ref:`2660_debug_ipv6_redirect-table` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/ipv6/redirect-table ` .. _2660_debug_ipv6_reachability: debug_ipv6_reachability ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_debug_ipv6_redirect-table: debug_ipv6_redirect-table ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **l2** **Description:** l2 is a **JSON Block**. Please see below for :ref:`2660_debug_ipv6_redirect-table_l2` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/ipv6/redirect-table/l2 ` **l3** **Description:** l3 is a **JSON Block**. Please see below for :ref:`2660_debug_ipv6_redirect-table_l3` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/debug/ipv6/redirect-table/l3 ` .. _2660_debug_ipv6_redirect-table_l2: debug_ipv6_redirect-table_l2 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_debug_ipv6_redirect-table_l3: debug_ipv6_redirect-table_l3 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_debug_hash-table: debug_hash-table ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_cluster-list: cluster-list ^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **cluster-devices** **Description:** cluster-devices is a **JSON Block**. Please see below for :ref:`2660_cluster-list_cluster-devices` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices ` **cluster-id** **Description** Scaleout cluster-id **Type:** number **Range:** 1-64 **db-config** **Description:** db-config is a **JSON Block**. Please see below for :ref:`2660_cluster-list_db-config` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/db-config ` **device-groups** **Description:** device-groups is a **JSON Block**. Please see below for :ref:`2660_cluster-list_device-groups` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/device-groups ` **local-device** **Description:** local-device is a **JSON Block**. Please see below for :ref:`2660_cluster-list_local-device` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device ` **service-config** **Description:** service-config is a **JSON Block**. Please see below for :ref:`2660_cluster-list_service-config` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/service-config ` **slog-level** **Description** Set the level of slog for Scaleout **Type:** number **Range:** 1-8 **Default:** 5 **tracking-template** **Description:** tracking-template is a **JSON Block**. Please see below for :ref:`2660_cluster-list_tracking-template` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/tracking-template ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_cluster-list_local-device: cluster-list_local-device ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action** **Description** 'enable': enable; 'disable': disable; **Type:** string **Supported Values:** enable, disable **Default:** enable **cluster-mode** **Description** 'layer-2': Nodes in cluster are layer 2 connected (default mode); 'layer-3': Nodes in cluster are l3 connected; **Type:** string **Supported Values:** layer-2, layer-3 **Default:** layer-2 **exclude-interfaces** **Description:** exclude-interfaces is a **JSON Block**. Please see below for :ref:`2660_cluster-list_local-device_exclude-interfaces` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/exclude-interfaces ` **id** **Description** **Type:** number **Range:** 1-16 **l2-redirect** **Description:** l2-redirect is a **JSON Block**. Please see below for :ref:`2660_cluster-list_local-device_l2-redirect` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/l2-redirect ` **priority** **Description** **Type:** number **Range:** 1-255 **session-sync** **Description:** session-sync is a **JSON Block**. Please see below for :ref:`2660_cluster-list_local-device_session-sync` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/session-sync ` **start-delay** **Description** **Type:** number **Range:** 10-300 **tracking-template** **Description:** tracking-template is a **JSON Block**. Please see below for :ref:`2660_cluster-list_local-device_tracking-template` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template ` **traffic-redirection** **Description:** traffic-redirection is a **JSON Block**. Please see below for :ref:`2660_cluster-list_local-device_traffic-redirection` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/traffic-redirection ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_cluster-list_local-device_session-sync: cluster-list_local-device_session-sync ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **follow-shared** **Description** Follow shared partition for session sync **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **interfaces** **Description:** interfaces is a **JSON Block**. Please see below for :ref:`2660_cluster-list_local-device_session-sync_interfaces` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/session-sync/interfaces ` **reachability-options** **Description:** reachability-options is a **JSON Block**. Please see below for :ref:`2660_cluster-list_local-device_session-sync_reachability-options` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/session-sync/reachability-options ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_cluster-list_local-device_session-sync_interfaces: cluster-list_local-device_session-sync_interfaces ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **eth-cfg** **Type:** List **loopback-cfg** **Type:** List **trunk-cfg** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **ve-cfg** **Type:** List .. _2660_cluster-list_local-device_session-sync_interfaces_ve-cfg: cluster-list_local-device_session-sync_interfaces_ve-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ve** **Description** Virtual ethernet Interface (Virtual ethernet interface number) **Type:** number **Range:** 2-4094 .. _2660_cluster-list_local-device_session-sync_interfaces_loopback-cfg: cluster-list_local-device_session-sync_interfaces_loopback-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **loopback** **Description** Loopback Interface(Not applicable in 'layer-2' mode) (Loopback interface number) **Type:** number **Range:** 0-10 .. _2660_cluster-list_local-device_session-sync_interfaces_trunk-cfg: cluster-list_local-device_session-sync_interfaces_trunk-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **trunk** **Description** Trunk Interface (Trunk interface number) **Type:** number **Range:** 1-4096 .. _2660_cluster-list_local-device_session-sync_interfaces_eth-cfg: cluster-list_local-device_session-sync_interfaces_eth-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet Interface (Ethernet interface number) **Type:** number **Format:** interface .. _2660_cluster-list_local-device_session-sync_reachability-options: cluster-list_local-device_session-sync_reachability-options ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **skip-default-route** **Description** Do not choose default route for redirection(Not applicable in 'layer-2' mode) **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 .. _2660_cluster-list_local-device_exclude-interfaces: cluster-list_local-device_exclude-interfaces ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **eth-cfg** **Type:** List **loopback-cfg** **Type:** List **trunk-cfg** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **ve-cfg** **Type:** List .. _2660_cluster-list_local-device_exclude-interfaces_ve-cfg: cluster-list_local-device_exclude-interfaces_ve-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ve** **Description** Virtual ethernet Interface (Virtual ethernet interface number) **Type:** number **Range:** 2-4094 .. _2660_cluster-list_local-device_exclude-interfaces_loopback-cfg: cluster-list_local-device_exclude-interfaces_loopback-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **loopback** **Description** Loopback Interface (Loopback interface number) **Type:** number **Range:** 0-10 .. _2660_cluster-list_local-device_exclude-interfaces_trunk-cfg: cluster-list_local-device_exclude-interfaces_trunk-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **trunk** **Description** Trunk Interface (Trunk interface number) **Type:** number **Range:** 1-4096 .. _2660_cluster-list_local-device_exclude-interfaces_eth-cfg: cluster-list_local-device_exclude-interfaces_eth-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet Interface (Ethernet interface number) **Type:** number **Format:** interface .. _2660_cluster-list_local-device_l2-redirect: cluster-list_local-device_l2-redirect ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **ethernet-vlan** **Description** VLAN ID **Type:** number **Range:** 2-4094 **redirect-eth** **Description** Ethernet port (Port Value) **Type:** number **Format:** interface **Mutual Exclusion:** redirect-eth and redirect-trunk are mutually exclusive **redirect-trunk** **Description** L2 Trunk group **Type:** number **Range:** 1-4096 **Mutual Exclusion:** redirect-trunk and redirect-eth are mutually exclusive **trunk-vlan** **Description** VLAN ID **Type:** number **Range:** 2-4094 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_cluster-list_local-device_traffic-redirection: cluster-list_local-device_traffic-redirection ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **follow-shared** **Description** Follow shared partition for redirection **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **interfaces** **Description:** interfaces is a **JSON Block**. Please see below for :ref:`2660_cluster-list_local-device_traffic-redirection_interfaces` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/traffic-redirection/interfaces ` **reachability-options** **Description:** reachability-options is a **JSON Block**. Please see below for :ref:`2660_cluster-list_local-device_traffic-redirection_reachability-options` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/traffic-redirection/reachability-options ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_cluster-list_local-device_traffic-redirection_interfaces: cluster-list_local-device_traffic-redirection_interfaces ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **eth-cfg** **Type:** List **loopback-cfg** **Type:** List **trunk-cfg** **Type:** List **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **ve-cfg** **Type:** List .. _2660_cluster-list_local-device_traffic-redirection_interfaces_ve-cfg: cluster-list_local-device_traffic-redirection_interfaces_ve-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ve** **Description** Virtual ethernet Interface (Virtual ethernet interface number) **Type:** number **Range:** 2-4094 .. _2660_cluster-list_local-device_traffic-redirection_interfaces_loopback-cfg: cluster-list_local-device_traffic-redirection_interfaces_loopback-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **loopback** **Description** Loopback Interface (Loopback interface number) **Type:** number **Range:** 0-10 .. _2660_cluster-list_local-device_traffic-redirection_interfaces_trunk-cfg: cluster-list_local-device_traffic-redirection_interfaces_trunk-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **trunk** **Description** Trunk Interface (Trunk interface number) **Type:** number **Range:** 1-4096 .. _2660_cluster-list_local-device_traffic-redirection_interfaces_eth-cfg: cluster-list_local-device_traffic-redirection_interfaces_eth-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet Interface (Ethernet interface number) **Type:** number **Format:** interface .. _2660_cluster-list_local-device_traffic-redirection_reachability-options: cluster-list_local-device_traffic-redirection_reachability-options ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **skip-default-route** **Description** Do not choose default route for redirection **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 .. _2660_cluster-list_local-device_tracking-template: cluster-list_local-device_tracking-template ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **multi-template-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template/multi-template/{multi-template} ` **template-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template/template/{template} ` .. _2660_cluster-list_local-device_tracking-template_multi-template-list: cluster-list_local-device_tracking-template_multi-template-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'down': node stops processing user traffic; 'exit-cluster': node exits scaleout cluster; **Type:** string **Supported Values:** down, exit-cluster **multi-template** **Description** bind multi tracking template name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **template** **Type:** List **threshold** **Description** action triggering threshold **Type:** number **Range:** 1-65535 **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 .. _2660_cluster-list_local-device_tracking-template_multi-template-list_template: cluster-list_local-device_tracking-template_multi-template-list_template ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **partition-name** **Description** Partition name **Type:** string **Maximum Length:** 14 characters **Maximum Length:** 1 characters **Reference Object:** :doc:`/axapi/v3/partition ` **template-name** **Description** bind tracking template name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _2660_cluster-list_local-device_tracking-template_template-list: cluster-list_local-device_tracking-template_template-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **template** **Description** bind tracking template name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **threshold-cfg** **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 .. _2660_cluster-list_local-device_tracking-template_template-list_threshold-cfg: cluster-list_local-device_tracking-template_template-list_threshold-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'down': node stops processing user traffic; 'exit-cluster': node exits scaleout cluster; **Type:** string **Supported Values:** down, exit-cluster **threshold** **Description** action triggering threshold **Type:** number **Range:** 1-65535 .. _2660_cluster-list_cluster-devices: cluster-list_cluster-devices ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cluster-discovery-timeout** **Description:** cluster-discovery-timeout is a **JSON Block**. Please see below for :ref:`2660_cluster-list_cluster-devices_cluster-discovery-timeout` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices/cluster-discovery-timeout ` **device-id-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices/device-id/{device-id} ` **enable** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **minimum-nodes** **Description:** minimum-nodes is a **JSON Block**. Please see below for :ref:`2660_cluster-list_cluster-devices_minimum-nodes` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices/minimum-nodes ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_cluster-list_cluster-devices_cluster-discovery-timeout: cluster-list_cluster-devices_cluster-discovery-timeout ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_cluster-list_cluster-devices_device-id-list: cluster-list_cluster-devices_device-id-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'enable': enable; 'disable': disable; **Type:** string **Supported Values:** enable, disable **Default:** enable **ip** **Description** **Type:** string **Format:** ipv4-address **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_cluster-list_cluster-devices_minimum-nodes: cluster-list_cluster-devices_minimum-nodes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **minimum-nodes-num** **Description** Specify the minimum number of the node required to start service **Type:** number **Range:** 0-16 **Default:** 0 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_cluster-list_device-groups: cluster-list_device-groups ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **device-group-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/device-groups/device-group/{device-group} ` **enable** **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 .. _2660_cluster-list_device-groups_device-group-list: cluster-list_device-groups_device-group-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **device-group** **Description** scaleout device group **Type:** number **Range:** 1-16 **device-id-list** **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 .. _2660_cluster-list_device-groups_device-group-list_device-id-list: cluster-list_device-groups_device-group-list_device-id-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **device-id-end** **Description** **Type:** number **device-id-start** **Description** **Type:** number .. _2660_cluster-list_service-config: cluster-list_service-config ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **enable** **Description** **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **template-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/service-config/template/{name} ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_cluster-list_service-config_template-list: cluster-list_service-config_template-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **bucket-count** **Description** Number of traffic buckets **Type:** number **Range:** 1-256 **Default:** 256 **device-group** **Description** Device group id **Type:** number **Range:** 1-16 **name** **Description** Scaleout template Name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **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 .. _2660_cluster-list_db-config: cluster-list_db-config ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **broken-detect-timeout** **Description** database connection broken detection timeout (mseconds) (12000 mseconds for default) **Type:** number **Range:** 500-120000 **Default:** 12000 **client-recv-timeout** **Description** **Type:** number **Range:** 50-100000 **Default:** 13000 **clientPort** **Description** client session port **Type:** number **Range:** 100-65535 **elect-conn-timeout** **Description** election connection timeout (mseconds) (1200 for default) **Type:** number **Range:** 50-15000 **Default:** 1200 **initLimit** **Description** **Type:** number **Range:** 1-500 **loopback-intf-support** **Description** support loopback interface for scaleout database (enabled by default) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **maxSessionTimeout** **Description** **Type:** number **Range:** 50-100000 **Default:** 30000 **minSessionTimeout** **Description** **Type:** number **Range:** 50-100000 **Default:** 100 **more-election-packet** **Description** send more election packet in election period (enabled by default) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **syncLimit** **Description** **Type:** number **Range:** 1-500 **tickTime** **Description** **Type:** number **Range:** 50-10000 **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _2660_cluster-list_tracking-template: cluster-list_tracking-template ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **template-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/tracking-template/template/{template} ` .. _2660_cluster-list_tracking-template_template-list: cluster-list_tracking-template_template-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **template** **Description** bind tracking template name **Type:** string **Maximum Length:** 63 characters **Maximum Length:** 1 characters **threshold-cfg** **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 .. _2660_cluster-list_tracking-template_template-list_threshold-cfg: cluster-list_tracking-template_template-list_threshold-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **action** **Description** 'down': node stops processing user traffic; 'exit-cluster': node exits scaleout cluster; **Type:** string **Supported Values:** down, exit-cluster **threshold** **Description** action triggering threshold **Type:** number **Range:** 1-65535