.. _scaleout_cluster_local_device: scaleout cluster local-device ============================= Local device configuration local-device Specification -------------------------- ===================================== =================================================================================== ===================================== =================================================================================== **Type** *Configuration Resource* **Element Name** local-device **Element URI** /axapi/v3/scaleout/cluster/{cluster-id}/local-device **Element Attributes** local-device_attributes **Schema** :download:`local-device schema ` ===================================== =================================================================================== **Operations Allowed:** .. 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/scaleout/cluster/{cluster-id}/local-device .. raw:: html :ref:`1301_local-device_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/scaleout/cluster/{cluster-id}/local-device .. raw:: html :ref:`1301_local-device_attributes` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/scaleout/cluster/{cluster-id}/local-device .. raw:: html :ref:`1301_local-device_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/scaleout/cluster/{cluster-id}/local-device .. raw:: html :ref:`1301_local-device_attributes` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/scaleout/cluster/{cluster-id}/local-device .. raw:: html :ref:`1301_local-device_attributes` .. raw:: html
.. _1301_local-device_attributes: local-device attributes ----------------------- **action** **Description** 'enable': enable; 'disable': disable; **Type:** string **Supported Values:** enable, disable **Default:** enable **id** **Description** **Type:** number **Range:** 1-8 **l2-redirect** **Description:** l2-redirect is a **JSON Block**. Please see below for :ref:`1301_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-interface** **Description:** session-sync-interface is a **JSON Block**. Please see below for :ref:`1301_session-sync-interface` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/session-sync-interface ` **start-delay** **Description** **Type:** number **Range:** 10-300 **tracking-template** **Description:** tracking-template is a **JSON Block**. Please see below for :ref:`1301_tracking-template` **Type:** Object **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template ` **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _1301_session-sync-interface: session-sync-interface ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **eth-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 .. _1301_session-sync-interface_ve-cfg: session-sync-interface_ve-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ve** **Description** Virtual ethernet Interface (Virtual ethernet interface number) **Type:** number **Range:** 2-4094 .. _1301_session-sync-interface_trunk-cfg: session-sync-interface_trunk-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **trunk** **Description** Trunk Interface (Trunk interface number) **Type:** number **Range:** 1-4096 .. _1301_session-sync-interface_eth-cfg: session-sync-interface_eth-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **ethernet** **Description** Ethernet Interface (Ethernet interface number) **Type:** number **Format:** interface **Range:** 0-1 .. _1301_l2-redirect: l2-redirect ^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **ethernet-vlan** **Description** VLAN ID **Type:** number **Range:** 2-4094 **redirect-eth** **Description** Ethernet port (Port Value) **Type:** number **Format:** interface **Range:** 3-64 **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 .. _1301_tracking-template: tracking-template ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **Type** *object* =============================== =================================================== **template-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template/template/{template} ` .. _1301_tracking-template_template-list: tracking-template_template-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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 .. _1301_tracking-template_template-list_threshold-cfg: tracking-template_template-list_threshold-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** =============================== =================================================== **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