.. _aam_authentication_global:

aam authentication global
=========================

Global AAM authentication statistics


global Specification
--------------------

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

	 **Element Name**                      global

	 **Element URI**                       /axapi/v3/aam/authentication/global

	 **Element Attributes**                global_attributes

	 **Statistics Data URI**               /axapi/v3/aam/authentication/global/stats

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



.. raw:: html

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


:ref:`18_global_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/global



.. raw:: html

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


:ref:`18_global_attributes`



.. 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/global



.. raw:: html

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


:ref:`18_global_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/global



.. raw:: html

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


:ref:`18_global_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/aam/authentication/global



.. raw:: html

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


:ref:`18_global_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _18_global_attributes:

global attributes
-----------------

    **max-auth-resp-size**

        **Description** Specify the max auth resp size in bytes(from authd to a10lb), default is 64KB

        **Type:** number

        **Range:** 2048-131072

        **Default:** 65536

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _18_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'requests': Total Authentication Request; 'responses': Total Authentication Response; 'misses': Total Authentication Request Missed; 'ocsp-stapling-requests-to-a10authd': Total OCSP Stapling Request; 'ocsp-stapling-responses-from-a10authd': Total OCSP Stapling Response; 'opened-socket': Total AAM Socket Opened; 'open-socket-failed': Total AAM Open Socket Failed; 'connect': Total AAM Connection; 'connect-failed': Total AAM Connect Failed; 'created-timer': Total AAM Timer Created; 'create-timer-failed': Total AAM Timer Creation Failed; 'total-request': Total Request Received by A10 Auth Service; 'get-socket-option-failed': Total AAM Get Socket Option Failed; 'aflex-authz-succ': Total Authorization success number in aFleX; 'aflex-authz-fail': Total Authorization failure number in aFleX; 'authn-success': Total Authentication success number; 'authn-failure': Total Authentication failure number; 'authz-success': Total Authorization success number; 'authz-failure': Total Authorization failure number; 'active-session': Total Active Auth-Sessions; 'active-user': Total Active Users; 'dns-resolve-failed': Total AAM DNS resolve failed; 

        **Type:** string

        **Supported Values:** all, requests, responses, misses, ocsp-stapling-requests-to-a10authd, ocsp-stapling-responses-from-a10authd, opened-socket, open-socket-failed, connect, connect-failed, created-timer, create-timer-failed, total-request, get-socket-option-failed, aflex-authz-succ, aflex-authz-fail, authn-success, authn-failure, authz-success, authz-failure, active-session, active-user, dns-resolve-failed

.. _18_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - open-socket-failed
      - 8
      - Total AAM Open Socket Failed

   *  - 
      - connect
      - 8
      - Total AAM Connection

   *  - 
      - aflex-authz-succ
      - 8
      - Total Authorization success number in aFleX

   *  - 
      - authz-success
      - 8
      - Total Authorization success number

   *  - 
      - aflex-authz-fail
      - 8
      - Total Authorization failure number in aFleX

   *  - 
      - create-timer-failed
      - 8
      - Total AAM Timer Creation Failed

   *  - 
      - ocsp-stapling-requests-to-a10authd
      - 8
      - Total OCSP Stapling Request

   *  - 
      - dns-resolve-failed
      - 8
      - Total AAM DNS resolve failed

   *  - 
      - opened-socket
      - 8
      - Total AAM Socket Opened

   *  - 
      - connect-failed
      - 8
      - Total AAM Connect Failed

   *  - 
      - misses
      - 8
      - Total Authentication Request Missed

   *  - 
      - active-session
      - 8
      - Total Active Auth-Sessions

   *  - 
      - active-user
      - 8
      - Total Active Users

   *  - 
      - responses
      - 8
      - Total Authentication Response

   *  - 
      - get-socket-option-failed
      - 8
      - Total AAM Get Socket Option Failed

   *  - 
      - authn-success
      - 8
      - Total Authentication success number

   *  - 
      - authz-failure
      - 8
      - Total Authorization failure number

   *  - 
      - ocsp-stapling-responses-from-a10authd
      - 8
      - Total OCSP Stapling Response

   *  - 
      - authn-failure
      - 8
      - Total Authentication failure number

   *  - 
      - created-timer
      - 8
      - Total AAM Timer Created

   *  - 
      - requests
      - 8
      - Total Authentication Request

   *  - 
      - total-request
      - 8
      - Total Request Received by A10 Auth Service