.. _a10_aam_authentication_server_ocsp_instance_module:


a10_aam_authentication_server_ocsp_instance
===========================================

.. contents::
   :local:
   :depth: 1


Synopsis
--------

Specify OCSP authentication server name






Parameters
----------

 
| Parameters                       | Choices/Defaults              | Comment                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| state                            | ['noop', 'present', 'absent'] | State of the object to be created.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| str/required                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| ansible_host                     |                               | Host for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| str/required                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| ansible_username                 |                               | Username for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| str/required                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| ansible_password                 |                               | Password for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| str/required                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| ansible_port                     |                               | Port for AXAPI authentication                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| int/required                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| a10_device_context_id            | ['1-8']                       | Device ID for aVCS configuration                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| int                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| a10_partition                    |                               | Destination/target partition for object/command                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| str                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| name                             |                               | Specify OCSP authentication server name                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| str/required                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| url                              |                               | Specify the OCSP server's address (Format= http=//host[=port]/) (The OCSP server's address(Format= http=//host[=port]/))                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| str                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| responder_ca                     |                               | Specify the trusted OCSP responder's CA cert filename                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| str                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| responder_cert                   |                               | Specify the trusted OCSP responder's cert filename                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| str                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| health_check                     |                               | Check server's health status                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| bool                             |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| health_check_string              |                               | Health monitor name                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| str                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| health_check_disable             |                               | Disable configured health check configuration                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| bool                             |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| port_health_check                |                               | Check port's health status                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| str                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| port_health_check_disable        |                               | Disable configured port health check configuration                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| bool                             |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| http_version                     |                               | Set HTTP version (default 1.0)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| bool                             |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| version_type                     |                               | '1.1'= HTTP version 1.1;                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| str                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| uuid                             |                               | uuid of the object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| str                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| sampling_enable                  |                               | Field sampling_enable                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| list                             |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
|   | counters1                    |                               | '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; |
|   |                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   | str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| packet_capture_template          |                               | Name of the packet capture template to be bind with this object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| str                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
| stats                            |                               | Field stats                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| dict                             |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
|   | request                      |                               | Request                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   |                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   | str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
|   | certificate_good             |                               | Good Certificate Response                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   |                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   | str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
|   | certificate_revoked          |                               | Revoked Certificate Response                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   |                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   | str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
|   | certificate_unknown          |                               | Unknown Certificate Response                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   |                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   | str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
|   | timeout                      |                               | Timeout                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   |                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   | str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
|   | fail                         |                               | Handle OCSP response failed                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   |                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   | str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
|   | stapling_request             |                               | OCSP Stapling Request Send                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|   |                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   | str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
|   | stapling_certificate_good    |                               | OCSP Stapling Good Certificate Response                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   |                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   | str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
|   | stapling_certificate_revoked |                               | OCSP Stapling Revoked Certificate Response                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|   |                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   | str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
|   | stapling_certificate_unknown |                               | OCSP Stapling Unknown Certificate Response                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|   |                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   | str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
|   | stapling_timeout             |                               | OCSP Stapling Timeout                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|   |                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   | str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
|   | stapling_fail                |                               | Handle OCSP response failed                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   |                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   | str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 
|   | name                         |                               | Specify OCSP authentication server name                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   |                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   | str                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 







Examples
--------

.. code-block:: yaml+jinja

    



Return Values
-------------

modified_values (changed, dict, )
  Values modified (or potential changes if using check_mode) as a result of task operation


axapi_calls (always, list, )
  Sequential list of AXAPI calls made by the task


  endpoint (, str, ['/axapi/v3/slb/virtual_server', '/axapi/v3/file/ssl-cert'])
    The AXAPI endpoint being accessed.


  http_method (, str, ['POST', 'GET'])
    HTTP method being used by the primary task to interact with the AXAPI endpoint.


  request_body (, complex, )
    Params used to query the AXAPI


  response_body (, complex, )
    Response from the AXAPI






Status
------




- This module is not guaranteed to have a backwards compatible interface. *[preview]*


- This module is maintained by community.



Authors
~~~~~~~

- A10 Networks

