.. _vcs_unicast_election:

vcs unicast-election
====================

VCS Device


unicast-election Specification
------------------------------

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

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

	 **Element Name**                      unicast-election

	 **Element URI**                       /axapi/v3/vcs/unicast-election

	 **Element Attributes**                unicast-election_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3542_unicast-election_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_unicast_election_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/unicast-election



.. raw:: html

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


:ref:`3542_unicast-election_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_unicast_election_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/unicast-election



.. raw:: html

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


:ref:`3542_unicast-election_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/unicast-election



.. raw:: html

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


:ref:`3542_unicast-election_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_unicast_election_PUT.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _3542_unicast-election_attributes:

unicast-election attributes
---------------------------

    **members**

        **Description:** members is a **JSON Block**.  Please see below for :ref:`3542_members` 

        **Type:** Object

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

.. _3542_members:

members
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **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

.. _3542_members_ip-address-cfg:

members_ip-address-cfg
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **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

.. _3542_members_ipv6-address-cfg:

members_ipv6-address-cfg
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **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