.. _aam_authentication_relay_kerberos_instance:

aam authentication relay kerberos instance
==========================================

Kerberos Authentication Relay


instance Specification
----------------------

	===================================== ==========================================================================================
	===================================== ==========================================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`47_instance_list`

	 **Collection URI**                    /axapi/v3/aam/authentication/relay/kerberos/instance

	                                       

	 **Element Name**                      instance

	 **Element URI**                       /axapi/v3/aam/authentication/relay/kerberos/instance/{name}

	 **Element Attributes**                instance_attributes

	 **Statistics Data URI**               /axapi/v3/aam/authentication/relay/kerberos/instance/{name}/stats

	 **Operational Data URI**              /axapi/v3/aam/authentication/relay/kerberos/instance/{name}/oper

	 **Schema**                             :download:`instance schema <aam-authentication-relay-kerberos-instance/aam-authentication-relay-kerberos-instance.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/aam/authentication/relay/kerberos/instance



.. raw:: html

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


:ref:`47_instance_attributes`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/aam/authentication/relay/kerberos/instance



.. raw:: html

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


:ref:`47_instance_attributes`



.. raw:: html

   </td><td></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/aam/authentication/relay/kerberos/instance/{name}



.. raw:: html

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


:ref:`47_instance_attributes`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/aam/authentication/relay/kerberos/instance



.. raw:: html

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


:ref:`47_instance_list`



.. raw:: html

   </td><td></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/aam/authentication/relay/kerberos/instance/{name}



.. raw:: html

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


:ref:`47_instance_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/aam/authentication/relay/kerberos/instance/{name}



.. raw:: html

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


:ref:`47_instance_attributes`



.. raw:: html

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




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/aam/authentication/relay/kerberos/instance



.. raw:: html

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


:ref:`47_instance_list`



.. 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/aam/authentication/relay/kerberos/instance/{name}



.. raw:: html

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


:ref:`47_instance_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _47_instance_list:

instance-list
-------------


    instance-list is **JSON List** of :ref:`47_instance_attributes` 

        instance-list : [

             { :ref:`47_instance_attributes` },

             { :ref:`47_instance_attributes` },

             ...

         ]

.. _47_instance_attributes:

instance attributes
-------------------

    **encrypted**

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

    **kerberos-account**

        **Description** Specify the kerberos account name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **kerberos-kdc**

        **Description** Specify the kerberos kdc ip or host name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** kerberos-kdc and kerberos-kdc-service-group are mutually exclusive

    **kerberos-kdc-service-group**

        **Description** Specify an authentication service group as multiple KDCs

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** kerberos-kdc-service-group and kerberos-kdc are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/aam/authentication/service-group <aam_authentication_service_group>`

    **kerberos-realm**

        **Description** Specify the kerberos realm

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **name**

        **Description** Specify Kerberos authentication relay name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **password**

        **Description** Specify password of Kerberos password

        **Type:** boolean

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

        **Default:** 0

    **port**

        **Description** Specify The KDC port, default is 88

        **Type:** number

        **Range:** 1-65535

        **Default:** 88

    **sampling-enable**

        **Type:** List

    **secret-string**

        **Description** The kerberos client password

        **Type:** string

        **Format:** password

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **timeout**

        **Description** Specify timeout for kerberos transport, default is 10 seconds (The timeout, default is 10 seconds)

        **Type:** number

        **Range:** 1-255

        **Default:** 10

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _47_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'request-send': Request Send; 'response-receive': Response Receive; 'current-requests-of-user': Current Pending Requests of User; 'tickets': Tickets; 

        **Type:** string

        **Supported Values:** all, request-send, response-receive, current-requests-of-user, tickets

.. _47_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - current-requests-of-user
      - 8
      - Current Pending Requests of User

   *  - 
      - response-receive
      - 8
      - Response Receive

   *  - 
      - request-send
      - 8
      - Request Send

   *  - 
      - tickets
      - 8
      - Tickets

.. _47_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - ticket-cache
      - string
      - ticket-cache

   *  - 
      - item-list
      - 
      - item-list

   *  - 
      - default-principal
      - string
      - default-principal