.. _vcs_vcs_para:

vcs vcs-para
============

Virtual Chassis System Paramter


vcs-para Specification
----------------------

	===================================== =====================================================
	 **Parameter**                         **Value** 

	===================================== =====================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      vcs-para

	 **Element URI**                       /axapi/v3/vcs/vcs-para

	 **Element Attributes**                vcs-para_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`vcs-para schema <vcs-vcs-para/vcs-vcs-para.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'>


Create Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/vcs/vcs-para



.. raw:: html

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


:ref:`3546_vcs-para_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/vcs_vcs_para_POST.txt
   :literal:




.. raw:: html

   </div></td></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/vcs-para



.. raw:: html

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


:ref:`3546_vcs-para_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/vcs_vcs_para_GET.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Modify Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/vcs/vcs-para



.. raw:: html

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


:ref:`3546_vcs-para_attributes`



.. raw:: html

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




.. raw:: html

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


Replace Object



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/vcs/vcs-para



.. raw:: html

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


:ref:`3546_vcs-para_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/vcs_vcs_para_PUT.txt
   :literal:




.. raw:: html

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


.. raw:: html

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


Delete Object



.. raw:: html

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


DELETE



.. raw:: html

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


/axapi/v3/vcs/vcs-para



.. raw:: html

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


:ref:`3546_vcs-para_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/vcs_vcs_para_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3546_vcs-para_attributes:

vcs-para attributes
-------------------

    **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:** 0-240

        **Default:** 10

    **dead-interval-mseconds**

        **Description** The node will be considered dead as lack of hearbeats after this time (milisecond) (in unit of msecond, default is 0)

        **Type:** number

        **Range:** 100-900

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

    **memory-stat-interval**

        **Description** Interval of aVCS memory statistics record (minutes)

        **Type:** number

        **Range:** 0-120

        **Default:** 30

    **multicast-ip**

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

        **Type:** string

        **Format:** ipv4-address

        **Default:** 224.0.1.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

    **slog-level**

        **Description** Set the level of slog for aVCS

        **Type:** number

        **Range:** 1-8

        **Default:** 7

    **slog-method**

        **Description** Set the print method of slog for aVCS

        **Type:** number

        **Range:** 0-2

        **Default:** 1

    **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:** 0-60

        **Default:** 3

    **time-interval-mseconds**

        **Description** how long between heartbeats (mseconds) (in unit of milisecond, default is 0)

        **Type:** number

        **Range:** 200-900

    **transmit-fragment-size**

        **Description** Set the fragment size (KByte) of the aVCS transmit

        **Type:** number

        **Range:** 500-20000

        **Default:** 6000

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _3546_floating-ipv6-cfg:

floating-ipv6-cfg
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **floating-ipv6**

        **Description** Floating IPv6 address

        **Type:** string

        **Format:** ipv6-address-plen

.. _3546_floating-ip-cfg:

floating-ip-cfg
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **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