.. _vcs:

vcs
===

Virtual Chassis System


vcs Specification
-----------------

	===================================== ============================================
	===================================== ============================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      vcs

	 **Element URI**                       /axapi/v3/vcs

	 **Element Attributes**                vcs_attributes

	 **Schema**                             :download:`vcs schema <vcs/vcs.txt>`
	===================================== ============================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/vcs



.. raw:: html

   </td><td valign = 'top'>


vcs_attributes



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _1072_vcs_attributes:

vcs attributes
--------------

    **action**

        **Description:** action is a **JSON Block**.  Please see below for :ref:`1072_action` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/vcs/action <vcs_action>`

    **debug**

        **Description:** debug is a **JSON Block**.  Please see below for :ref:`1072_debug` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/vcs/debug <vcs_debug>`

    **device-list**

        **Type:** List

        **Refernce Object:** :doc:`/axapi/v3/vcs/device/{device} <vcs_device>`

    **discovery-mode**

        **Description:** discovery-mode is a **JSON Block**.  Please see below for :ref:`1072_discovery-mode` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/vcs/discovery-mode <vcs_discovery_mode>`

    **images**

        **Description:** images is a **JSON Block**.  Please see below for :ref:`1072_images` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/vcs/images <vcs_images>`

    **reload**

        **Description:** reload is a **JSON Block**.  Please see below for :ref:`1072_reload` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/vcs/reload <vcs_reload>`

    **showdebug**

        **Description:** showdebug is a **JSON Block**.  Please see below for :ref:`1072_showdebug` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/vcs/showdebug <vcs_showdebug>`

    **stat**

        **Description:** stat is a **JSON Block**.  Please see below for :ref:`1072_stat` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/vcs/stat <vcs_stat>`

    **unicast-election**

        **Description:** unicast-election is a **JSON Block**.  Please see below for :ref:`1072_unicast-election` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/vcs/unicast-election <vcs_unicast_election>`

    **vMaster-maintenance**

        **Description:** vMaster-maintenance is a **JSON Block**.  Please see below for :ref:`1072_vMaster-maintenance` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/vcs/vMaster-maintenance <vcs_vMaster_maintenance>`

    **vcs-para**

        **Description:** vcs-para is a **JSON Block**.  Please see below for :ref:`1072_vcs-para` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/vcs/vcs-para <vcs_vcs_para>`

    **vcs-summary**

        **Description:** vcs-summary is a **JSON Block**.  Please see below for :ref:`1072_vcs-summary` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/vcs/vcs-summary <vcs_vcs_summary>`

    **vmaster-take-over**

        **Description:** vmaster-take-over is a **JSON Block**.  Please see below for :ref:`1072_vmaster-take-over` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/vcs/vmaster-take-over <vcs_vmaster_take_over>`

.. _1072_vcs-summary:

vcs-summary
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1072_discovery-mode:

discovery-mode
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **action**

        **Description** 'Unicast': enable VCS Unicast election; 'Mcast': enable VCS Multicast election; 'Mixed': enable VCS Multicast/Unicastelection; 

        **Type:** string

        **Supported Values:** Unicast, Mcast, Mixed

        **Default:** Mcast

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1072_vmaster-take-over:

vmaster-take-over
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **vmaster-take-over**

        **Description** vMaster take over priority

        **Type:** number

        **Range:** 1-255

.. _1072_vcs-para:

vcs-para
^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **chassis-id**

        **Description** Chassis ID

        **Type:** number

        **Range:** 1-8

    **config-info**

        **Description** Configuration information (Configuration tag)

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **config-seq**

        **Description** Configuration sequence number

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **dead-interval**

        **Description** The node will be considered dead as lack of hearbeats after this time (in unit of second, 10 by default)

        **Type:** number

        **Range:** 5-240

        **Default:** 10

    **failure-retry-count-value**

        **Description** 0-255, default is 2

        **Type:** number

        **Range:** 0-255

        **Default:** 2

        **Mutual Exclusion:** failure-retry-count-value and forever are mutually exclusive

    **floating-ip-cfg**

        **Type:** List

    **floating-ipv6-cfg**

        **Type:** List

    **force-wait-interval**

        **Description** The node will wait the specified time interval before it start aVCS (in unit of second (default is 5))

        **Type:** number

        **Range:** 5-240

        **Default:** 5

    **forever**

        **Description** VCS retry forever if fails to join the chassis

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

        **Mutual Exclusion:** forever and failure-retry-count-value are mutually exclusive

    **multicast-ip**

        **Description** Multicast (group) IP address (Multicast IP address)

        **Type:** string

        **Format:** ipv4-address

        **Default:** 224.0.0.210

        **Mutual Exclusion:** multicast-ip and multicast-ipv6 are mutually exclusive

    **multicast-ipv6**

        **Description** Multicast (group) IPv6 address (Multicast IPv6 address)

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** multicast-ipv6 and multicast-ip are mutually exclusive

    **multicast-port**

        **Description** Port used in multicast communication (Port number)

        **Type:** number

        **Range:** 1-65535

        **Default:** 41217

    **size**

        **Description** file size (MBytes) to transmit to monitor the TCP channel

        **Type:** number

        **Range:** 10-2000

    **speed_limit**

        **Description** speed (KByte/s) limitation for the transmit monitor

        **Type:** number

        **Range:** 5-1000

    **ssl-enable**

        **Description** Enable SSL

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **tcp-channel-monitor**

        **Description** Enable vBlade TCP channel monitor

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **time-interval**

        **Description** how long between heartbeats (in unit of second, default is 3)

        **Type:** number

        **Range:** 1-60

        **Default:** 3

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1072_vcs-para_floating-ipv6-cfg:

vcs-para_floating-ipv6-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **floating-ipv6**

        **Description** Floating IPv6 address

        **Type:** string

        **Format:** ipv6-address-plen

.. _1072_vcs-para_floating-ip-cfg:

vcs-para_floating-ip-cfg
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **floating-ip**

        **Description** Floating IP address (IPv4 address)

        **Type:** string

        **Format:** ipv4-address

    **floating-ip-mask**

        **Description** Netmask

        **Type:** string

        **Format:** ipv4-netmask

.. _1072_showdebug:

showdebug
^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1072_reload:

reload
^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **disable-merge**

        **Description** don't merge this vBlade's configuration to aVCS chassis

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

.. _1072_debug:

debug
^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **daemon**

        **Description** Daemon component

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **daemon_msg**

        **Description** Daemon message component

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **election**

        **Description** Election component

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **election_pdu**

        **Description** Election pdu component

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **encoder**

        **Description** Encoder component

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **handler**

        **Description** Handler component

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **info**

        **Description** Information component

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **lib**

        **Description** Lib component

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **net**

        **Description** Net component

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **ssl**

        **Description** SSL component

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **util**

        **Description** Utility component

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **vblade**

        **Description** vBlade component

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **vblade_msg**

        **Description** vBlade Message component

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **vmaster**

        **Description** vMaster component

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **vmaster_msg**

        **Description** vMaster Message component

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

.. _1072_stat:

stat
^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1072_device-list:

device-list
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **affinity-vrrp-a-vrid**

        **Description** vrid-group

        **Type:** number

        **Range:** 0-31

    **device**

        **Description** Device ID

        **Type:** number

    **enable**

        **Description** Enable

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **ethernet-cfg**

        **Type:** List

    **management**

        **Description** Management interface

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **priority**

        **Description** Device priority

        **Type:** number

        **Range:** 1-255

    **trunk-cfg**

        **Type:** List

    **unicast-port**

        **Description** Port used in unicast communication (Port number)

        **Type:** number

        **Range:** 1024-65535

        **Default:** 41216

    **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

    **ve-cfg**

        **Type:** List

.. _1072_device-list_ethernet-cfg:

device-list_ethernet-cfg
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **ethernet**

        **Description** Ethernet (Ethernet interface number)

        **Type:** number

        **Format:** interface

.. _1072_device-list_ve-cfg:

device-list_ve-cfg
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **ve**

        **Description** VE interface (VE interface number)

        **Type:** number

        **Range:** 2-4094

.. _1072_device-list_trunk-cfg:

device-list_trunk-cfg
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **trunk**

        **Description** Trunk interface (Trunk interface number)

        **Type:** number

        **Range:** 1-4096

.. _1072_images:

images
^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1072_unicast-election:

unicast-election
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **members**

        **Description:** members is a **JSON Block**.  Please see below for :ref:`1072_unicast-election_members` 

        **Type:** Object

        **Refernce Object:** :doc:`/axapi/v3/vcs/unicast-election/members <vcs_unicast_election_members>`

    **port**

        **Description** Destination port for unicast election packet (Destination port for unicast election packet (default 41217))

        **Type:** number

        **Range:** 1024-65000

        **Default:** 41217

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1072_unicast-election_members:

unicast-election_members
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **ip-address-cfg**

        **Type:** List

    **ipv6-address-cfg**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1072_unicast-election_members_ip-address-cfg:

unicast-election_members_ip-address-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **ip-address**

        **Description** IP Address of the member

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** ip-address and ipv6-address are mutually exclusive

    **use-mgmt-port**

        **Description** Use management port for connections in different subnet

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

.. _1072_unicast-election_members_ipv6-address-cfg:

unicast-election_members_ipv6-address-cfg
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **ipv6-address**

        **Description** IPV6 address of the member

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** ipv6-address and ip-address are mutually exclusive

    **use-mgmt-port**

        **Description** Use management port for connections in different subnet

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

.. _1072_action:

action
^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **action**

        **Description** 'disable': disable VCS; 'enable': enable VCS; 

        **Type:** string

        **Supported Values:** disable, enable

        **Default:** disable

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1072_vMaster-maintenance:

vMaster-maintenance
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **vMaster-maintenance**

        **Description** the seconds vMaster will be maintained, 60 by default

        **Type:** number

        **Range:** 0-3600

        **Default:** 60