.. _acos_cloud_integration_ecosystem_consul:

acos-cloud-integration ecosystem consul
=======================================

Configure the consul ecosystem for integration


consul Specification
--------------------

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

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

	 **Element Name**                      consul

	 **Element URI**                       /axapi/v3/acos-cloud-integration/ecosystem/consul

	 **Element Attributes**                consul_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`consul schema <acos-cloud-integration-ecosystem-consul/acos-cloud-integration-ecosystem-consul.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/acos-cloud-integration/ecosystem/consul



.. raw:: html

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


:ref:`139_consul_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/acos_cloud_integration_ecosystem_consul_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/acos-cloud-integration/ecosystem/consul



.. raw:: html

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


:ref:`139_consul_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/acos_cloud_integration_ecosystem_consul_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/acos-cloud-integration/ecosystem/consul



.. raw:: html

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


:ref:`139_consul_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/acos-cloud-integration/ecosystem/consul



.. raw:: html

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


:ref:`139_consul_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/acos_cloud_integration_ecosystem_consul_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/acos-cloud-integration/ecosystem/consul



.. raw:: html

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


:ref:`139_consul_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/acos_cloud_integration_ecosystem_consul_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _139_consul_attributes:

consul attributes
-----------------

    **action**

        **Description** 'enable': Enable Configuration; 'disable': Disable Configuration; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **health-check-interval**

        **Description** '5': 5 seconds; '10': 10 seconds; '15': 15 seconds; '20': 20 seconds; 

        **Type:** string

        **Supported Values:** 5, 10, 15, 20

    **host-name**

        **Description** Configure the host name for bootstrap server(e.g www.a10networks.com)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** host-name, ipv4-address, and ipv6-address are mutually exclusive

    **ipv4-address**

        **Description** Configure the bootstrap server's IPv4 address (the host IPv4 address)

        **Type:** string

        **Format:** ipv4-address

        **Mutual Exclusion:** ipv4-address, ipv6-address, and host-name are mutually exclusive

    **ipv6-address**

        **Description** Configure the bootstrap server's IPv6 address (the host IPv6 address)

        **Type:** string

        **Format:** ipv6-address

        **Mutual Exclusion:** ipv6-address, ipv4-address, and host-name are mutually exclusive

    **port**

        **Description** Configure the http port to use (port 8500)

        **Type:** number

        **Range:** 1-65535

    **service-label**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _139_service-label:

service-label
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **service-label-name**

        **Description** Name service group to be monitored

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/service-group <slb_service_group>`