.. _health_monitor_method_kerberos_kdc:

health monitor method kerberos-kdc
==================================

Kerberos KDC type


kerberos-kdc Specification
--------------------------

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

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

	 **Element Name**                      kerberos-kdc

	 **Element URI**                       /axapi/v3/health/monitor/{name}/method/kerberos-kdc

	 **Element Attributes**                kerberos-kdc_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`kerberos-kdc schema <health-monitor-method-kerberos-kdc/health-monitor-method-kerberos-kdc.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/health/monitor/{name}/method/kerberos-kdc



.. raw:: html

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


:ref:`1843_kerberos-kdc_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/health_monitor_method_kerberos_kdc_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/health/monitor/{name}/method/kerberos-kdc



.. raw:: html

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


:ref:`1843_kerberos-kdc_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/health_monitor_method_kerberos_kdc_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/health/monitor/{name}/method/kerberos-kdc



.. raw:: html

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


:ref:`1843_kerberos-kdc_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/health/monitor/{name}/method/kerberos-kdc



.. raw:: html

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


:ref:`1843_kerberos-kdc_attributes`



.. raw:: html

   </td><td></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/health/monitor/{name}/method/kerberos-kdc



.. raw:: html

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


:ref:`1843_kerberos-kdc_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/health_monitor_method_kerberos_kdc_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _1843_kerberos-kdc_attributes:

kerberos-kdc attributes
-----------------------

    **kerberos-cfg**

        **Description:** kerberos-cfg is a **JSON Block**.  Please see below for :ref:`1843_kerberos-cfg` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1843_kerberos-cfg:

kerberos-cfg
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **kadmin**

        **Description** Kerberos admin

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** kadmin, kinit, and kpasswd are mutually exclusive

    **kadmin-encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

    **kadmin-kdc**

        **Description** Specify the kdc server, host|ip [:port]

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **kadmin-password**

        **Description** Password

        **Type:** string

        **Format:** password

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **kadmin-pricipal-name**

        **Description** Specify the principal name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **kadmin-realm**

        **Description** Specify the realm

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **kadmin-server**

        **Description** Specify the admin server, host|ip [:port]

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **kinit**

        **Description** Kerberos KDC

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** kinit, kadmin, and kpasswd are mutually exclusive

    **kinit-encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

    **kinit-kdc**

        **Description** Specify the kdc server, host|ip [:port]

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **kinit-password**

        **Description** Password

        **Type:** string

        **Format:** password

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **kinit-pricipal-name**

        **Description** Specify the principal name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **kpasswd**

        **Description** Kerberos change passwd

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** kpasswd, kinit, and kadmin are mutually exclusive

    **kpasswd-encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

    **kpasswd-kdc**

        **Description** Specify the kdc server, host|ip [:port]

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **kpasswd-password**

        **Description** Password

        **Type:** string

        **Format:** password

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

    **kpasswd-pricipal-name**

        **Description** Specify the principal name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **kpasswd-server**

        **Description** Specify the Kerberos password server, host|ip [:port]

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **tcp-only**

        **Description** Specify the kerberos tcp only

        **Type:** boolean

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

        **Default:** 0