.. _a10_aam_authentication_relay_kerberos_module:


a10_aam_authentication_relay_kerberos
=====================================

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


Synopsis
--------

Kerberos Authentication Relay






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                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
| uuid                           |                               | uuid of the object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                                |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| str                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
| sampling_enable                |                               | Field sampling_enable                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                                |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| list                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | counters1                  |                               | 'all'= all; 'request-send'= Total Request Send; 'response-get'= Total Response Get; 'timeout-error'= Total Timeout; 'other-error'= Total Other Error; 'request-normal'= Total Normal Request; 'request-dropped'= Total Dropped Request; 'response-success'= Total Success Response; 'response-failure'= Total Failure Response; 'response-error'= Total Error Response; 'response-timeout'= Total Timeout Response; 'response-other'= Total Other Response; 'job-start- error'= Total Job Start Error; 'polling-control-error'= Total Polling Control Error; |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
| instance_list                  |                               | Field instance_list                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|                                |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| list                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | name                       |                               | Specify Kerberos authentication relay name                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | kerberos_realm             |                               | Specify the kerberos realm                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | kerberos_kdc               |                               | Specify the kerberos kdc ip or host name                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | kerberos_kdc_service_group |                               | Specify an authentication service group as multiple KDCs                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | kerberos_account           |                               | Specify the kerberos account name                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | password                   |                               | Specify password of Kerberos password                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | bool                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | secret_string              |                               | The kerberos client password                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | encrypted                  |                               | Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | port                       |                               | Specify The KDC port, default is 88                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | int                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | timeout                    |                               | Specify timeout for kerberos transport, default is 10 seconds (The timeout, default is 10 seconds)                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | int                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | uuid                       |                               | uuid of the object                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | sampling_enable            |                               | Field sampling_enable                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | list                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
| stats                          |                               | Field stats                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                                |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| dict                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | request_send               |                               | Total Request Send                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | response_get               |                               | Total Response Get                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | timeout_error              |                               | Total Timeout                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | other_error                |                               | Total Other Error                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | request_normal             |                               | Total Normal Request                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | request_dropped            |                               | Total Dropped Request                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | response_success           |                               | Total Success Response                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | response_failure           |                               | Total Failure Response                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | response_error             |                               | Total Error Response                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | response_timeout           |                               | Total Timeout Response                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | response_other             |                               | Total Other Response                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | job_start_error            |                               | Total Job Start Error                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | polling_control_error      |                               | Total Polling Control Error                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | str                        |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 
|   | instance_list              |                               | Field instance_list                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|   |                            |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   | list                       |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 







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

