.. _a10_aam_authentication_server_windows_instance_module:


a10_aam_authentication_server_windows_instance
==============================================

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


Synopsis
--------

Windows Server, using Kerberos for authentication






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 Windows authentication server name                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str/required                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| host                              |                               | Field host                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| dict                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | hostip                        |                               | Specify the Windows server's hostname(Length 1-31) or IP address                                                                                                                                                                                                                                                                                                                                                                                                            |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | hostipv6                      |                               | Specify the Windows server's IPV6 address                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| timeout                           |                               | Specify connection timeout to server, default is 10 seconds                                                                                                                                                                                                                                                                                                                                                                                                                 |
|                                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| int                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| auth_protocol                     |                               | Field auth_protocol                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| dict                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | kerberos_port                 |                               | Specify the Kerberos port, default is 88                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | int                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | kport_hm                      |                               | Check Kerberos port's health status                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | kport_hm_disable              |                               | Disable configured Kerberos port health check configuration                                                                                                                                                                                                                                                                                                                                                                                                                 |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | bool                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | kerberos_password_change_port |                               | Specify the Kerbros password change port, default is 464                                                                                                                                                                                                                                                                                                                                                                                                                    |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | int                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | kdc_validate                  |                               | Enable KDC validation                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | bool                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | kerberos_kdc_validation       |                               | Field kerberos_kdc_validation                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | dict                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| realm                             |                               | Specify realm of Windows server                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| support_apacheds_kdc              |                               | Enable weak cipher (DES CRC/MD5/MD4) and merge AS-REQ in single packet                                                                                                                                                                                                                                                                                                                                                                                                      |
|                                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| health_check                      |                               | Check server's health status                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|                                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| health_check_string               |                               | Health monitor name                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| health_check_disable              |                               | Disable configured health check configuration                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| bool                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| uuid                              |                               | uuid of the object                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|                                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| sampling_enable                   |                               | Field sampling_enable                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| list                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | counters1                     |                               | 'all'= all; 'krb_send_req_success'= Kerberos Request; 'krb_get_resp_success'= Kerberos Response; 'krb_timeout_error'= Kerberos Timeout; 'krb_other_error'= Kerberos Other Error; 'krb_pw_expiry'= Kerberos password expiry; 'krb_pw_change_success'= Kerberos password change success; 'krb_pw_change_failure'= Kerberos password change failure; 'krb_validate_kdc_success'= Kerberos KDC Validation Success; 'krb_validate_kdc_failure'= Kerberos KDC Validation Failure; |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| packet_capture_template           |                               | Name of the packet capture template to be bind with this object                                                                                                                                                                                                                                                                                                                                                                                                             |
|                                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| str                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
| stats                             |                               | Field stats                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|                                   |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| dict                              |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | krb_send_req_success          |                               | Kerberos Request                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | krb_get_resp_success          |                               | Kerberos Response                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | krb_timeout_error             |                               | Kerberos Timeout                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | krb_other_error               |                               | Kerberos Other Error                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | krb_pw_expiry                 |                               | Kerberos password expiry                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | krb_pw_change_success         |                               | Kerberos password change success                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | krb_pw_change_failure         |                               | Kerberos password change failure                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | krb_validate_kdc_success      |                               | Kerberos KDC Validation Success                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | krb_validate_kdc_failure      |                               | Kerberos KDC Validation Failure                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                               |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   | str                           |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 
|   | name                          |                               | Specify Windows 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

