.. _health_external:

health external
===============

Address the External Script Program


external Specification
----------------------

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

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

	 **Element Name**                      external

	 **Element URI**                       /axapi/v3/health/external

	 **Element Attributes**                external_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`external schema <health-external/health-external.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/health/external



.. raw:: html

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


external_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _1831_external_attributes:

external attributes
-------------------

    **copy**

        **Description:** copy is a **JSON Block**.  Please see below for :ref:`1831_copy` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/health/external/copy <health_external_copy>`

    **create**

        **Description:** create is a **JSON Block**.  Please see below for :ref:`1831_create` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/health/external/create <health_external_create>`

    **delete**

        **Description:** delete is a **JSON Block**.  Please see below for :ref:`1831_delete` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/health/external/delete <health_external_delete>`

    **edit**

        **Description:** edit is a **JSON Block**.  Please see below for :ref:`1831_edit` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/health/external/edit <health_external_edit>`

    **rename**

        **Description:** rename is a **JSON Block**.  Please see below for :ref:`1831_rename` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/health/external/rename <health_external_rename>`

.. _1831_edit:

edit
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **description**

        **Description** Describe health external monitor script briefly

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **file-name**

        **Description** External health monitor script file name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

.. _1831_rename:

rename
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **dst-file**

        **Description** Destination external health monitor script file name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **src-file**

        **Description** Source external health monitor script file name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

.. _1831_create:

create
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **description**

        **Description** Describe health external monitor script briefly

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **file-name**

        **Description** External health monitor script file name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

.. _1831_copy:

copy
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **dst-file**

        **Description** Destination external health monitor script file name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **src-file**

        **Description** Source external health monitor script file name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

.. _1831_delete:

delete
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **file-name**

        **Description** External health monitor script file name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters