.. _cloud_services_meta_data:

cloud-services meta-data
========================

user-data Services configuration only works in shared partition


meta-data Specification
-----------------------

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

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

	 **Element Name**                      meta-data

	 **Element URI**                       /axapi/v3/cloud-services/meta-data

	 **Element Attributes**                meta-data_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`meta-data schema <cloud-services-meta-data/cloud-services-meta-data.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/cloud-services/meta-data



.. raw:: html

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


:ref:`643_meta-data_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/cloud_services_meta_data_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/cloud-services/meta-data



.. raw:: html

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


:ref:`643_meta-data_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/cloud_services_meta_data_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/cloud-services/meta-data



.. raw:: html

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


:ref:`643_meta-data_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/cloud-services/meta-data



.. raw:: html

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


:ref:`643_meta-data_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/cloud_services_meta_data_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/cloud-services/meta-data



.. raw:: html

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


:ref:`643_meta-data_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/cloud_services_meta_data_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _643_meta-data_attributes:

meta-data attributes
--------------------

    **action**

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

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** disable

    **prevent-admin-passwd**

        **Description** Prevents admin password from being changed if in YAML config

        **Type:** boolean

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

        **Default:** 0

    **prevent-admin-ssh-key**

        **Description** Prevents admin ssh-key from being added if in YAML config

        **Type:** boolean

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

        **Default:** 0

    **prevent-autofill**

        **Description** prevents use of meta-data to complete user_data configuration

        **Type:** boolean

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

        **Default:** 0

    **prevent-blob**

        **Description** Prevents a10_blob from loading in YAML config

        **Type:** boolean

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

        **Default:** 0

    **prevent-cloud-service**

        **Description** Prevents cloud-service configuration in YAML config

        **Type:** boolean

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

        **Default:** 0

    **prevent-license**

        **Description** Prevents a10_license configuration in YAML config

        **Type:** boolean

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

        **Default:** 0

    **prevent-user-ops**

        **Description** Prevents user from being added command is in user-data

        **Type:** boolean

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

        **Default:** 0

    **prevent-webservice**

        **Description** Prevents a10_license configuration in YAML config

        **Type:** boolean

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

        **Default:** 0

    **provider**

        **Description** 'aws': AWS user-data services; 'openstack': OpenStack user-data services; 

        **Type:** string

        **Supported Values:** openstack

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters