.. _aam_authentication_server_ocsp_instance:

aam authentication server ocsp instance
=======================================

Specify OCSP authentication server name


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

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

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

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

	 **Collection Name**                   :ref:`86_instance_list`

	 **Collection URI**                    /axapi/v3/aam/authentication/server/ocsp/instance

	                                       

	 **Element Name**                      instance

	 **Element URI**                       /axapi/v3/aam/authentication/server/ocsp/instance/{name}

	 **Element Attributes**                instance_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/aam/authentication/server/ocsp/instance/{name}/stats

	 **Schema**                             :download:`instance schema <aam-authentication-server-ocsp-instance/aam-authentication-server-ocsp-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/server/ocsp/instance



.. raw:: html

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


:ref:`86_instance_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/aam_authentication_server_ocsp_instance_POST.txt
   :literal:




.. raw:: html

   </div></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/server/ocsp/instance



.. raw:: html

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


:ref:`86_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/server/ocsp/instance/{name}



.. raw:: html

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


:ref:`86_instance_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/aam_authentication_server_ocsp_instance_GET.txt
   :literal:




.. raw:: html

   </div></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/server/ocsp/instance



.. raw:: html

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


:ref:`86_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/server/ocsp/instance/{name}



.. raw:: html

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


:ref:`86_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/server/ocsp/instance/{name}



.. raw:: html

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


:ref:`86_instance_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/aam_authentication_server_ocsp_instance_PUT.txt
   :literal:




.. raw:: html

   </div></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/server/ocsp/instance



.. raw:: html

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


:ref:`86_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/server/ocsp/instance/{name}



.. raw:: html

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


:ref:`86_instance_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/aam_authentication_server_ocsp_instance_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _86_instance_list:

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


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

        instance-list : [

             { :ref:`86_instance_attributes` },

             { :ref:`86_instance_attributes` },

             ...

         ]

.. _86_instance_attributes:

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

    **health-check**

        **Description** Check server's health status

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** health-check and health-check-disable are mutually exclusive

    **health-check-disable**

        **Description** Disable configured health check configuration

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** health-check-disable and health-check are mutually exclusive

    **health-check-string**

        **Description** Health monitor name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/health/monitor <health_monitor>`

    **http-version**

        **Description** Set HTTP version (default 1.0)

        **Type:** boolean

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

        **Default:** 0

    **name**

        **Description** Specify OCSP authentication server name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **packet-capture-template**

        **Description** Name of the packet capture template to be bind with this object

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/aam-auth-server-ocsp-inst-tmpl <visibility_packet_capture_object_templates_aam_auth_server_ocsp_inst_tmpl>`

    **port-health-check**

        **Description** Check port's health status

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** port-health-check and port-health-check-disable are mutually exclusive

        **Reference Object:** :doc:`/axapi/v3/health/monitor <health_monitor>`

    **port-health-check-disable**

        **Description** Disable configured port health check configuration

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** port-health-check-disable and port-health-check are mutually exclusive

    **responder-ca**

        **Description** Specify the trusted OCSP responder's CA cert filename

        **Type:** string

        **Maximum Length:** 245 characters

        **Maximum Length:** 1 characters

    **responder-cert**

        **Description** Specify the trusted OCSP responder's cert filename

        **Type:** string

        **Maximum Length:** 245 characters

        **Maximum Length:** 1 characters

    **sampling-enable**

        **Type:** List

    **url**

        **Description** Specify the OCSP server's address (Format: http://host[:port]/) (The OCSP server's address(Format: http://host[:port]/))

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **version-type**

        **Description** '1.1': HTTP version 1.1; 

        **Type:** string

        **Supported Values:** 1.1

.. _86_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'request': Request; 'certificate-good': Good Certificate Response; 'certificate-revoked': Revoked Certificate Response; 'certificate-unknown': Unknown Certificate Response; 'timeout': Timeout; 'fail': Handle OCSP response failed; 'stapling-request': OCSP Stapling Request Send; 'stapling-certificate-good': OCSP Stapling Good Certificate Response; 'stapling-certificate-revoked': OCSP Stapling Revoked Certificate Response; 'stapling-certificate-unknown': OCSP Stapling Unknown Certificate Response; 'stapling-timeout': OCSP Stapling Timeout; 'stapling-fail': Handle OCSP response failed; 

        **Type:** string

        **Supported Values:** all, request, certificate-good, certificate-revoked, certificate-unknown, timeout, fail, stapling-request, stapling-certificate-good, stapling-certificate-revoked, stapling-certificate-unknown, stapling-timeout, stapling-fail