.. _a10_slb_template_http_module:


a10_slb_template_http
=====================

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


Synopsis
--------

HTTP






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                                     |                               | HTTP Template Name                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str/required                             |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| compression_auto_disable_on_high_cpu     |                               | Auto-disable software compression on high cpu usage (Disable compression if cpu usage is above threshold. Default is off.)                                                                                                                                                                                                                                                                                                                                                            |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| compression_content_type                 |                               | Field compression_content_type                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| list                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | content_type                         |                               | Compression content-type                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| compression_enable                       |                               | Enable Compression                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| compression_exclude_content_type         |                               | Field compression_exclude_content_type                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| list                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | exclude_content_type                 |                               | Compression exclude content-type (Compression exclude content type)                                                                                                                                                                                                                                                                                                                                                                                                                   |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| compression_exclude_uri                  |                               | Field compression_exclude_uri                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| list                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | exclude_uri                          |                               | Compression exclude uri                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| compression_keep_accept_encoding         |                               | Keep accept encoding                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| compression_keep_accept_encoding_enable  |                               | Enable Server Accept Encoding                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| compression_level                        |                               | gzip compression level, default 1 (gzip compression level value, default is 1)                                                                                                                                                                                                                                                                                                                                                                                                        |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| compression_br_level                     |                               | brotli compression level, default 1 (brotli compression level value, default is 1)                                                                                                                                                                                                                                                                                                                                                                                                    |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| compression_br_sliding_window_size       |                               | brotli compression sliding window size, default 10 (brotli compression sliding window size in the form of log (i.e., 10 means 1k-16MB bytes))                                                                                                                                                                                                                                                                                                                                         |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| compression_minimum_content_length       |                               | Minimum Content Length (Minimum content length for compression in bytes. Default is 120.)                                                                                                                                                                                                                                                                                                                                                                                             |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| compression_method_order                 |                               | Method Order (Order to decide which compression algorithm to be applied when multiple algorithms are acceptable)                                                                                                                                                                                                                                                                                                                                                                      |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| default_charset                          |                               | 'iso-8859-1'= Use ISO-8859-1 as the default charset; 'utf-8'= Use UTF-8 as the default charset; 'us-ascii'= Use US-ASCII as the default charset;                                                                                                                                                                                                                                                                                                                                      |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| max_concurrent_streams                   |                               | (http2 only) Max concurrent streams, default 50                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| stream_cancellation_limit                |                               | cancellation limit, default 0 (accumulated cancellation limit value, default is 0)                                                                                                                                                                                                                                                                                                                                                                                                    |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| stream_cancellation_rate                 |                               | cancellation rate, default 10 (cancellation rate value, default is 10)                                                                                                                                                                                                                                                                                                                                                                                                                |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| max_transaction_allowed                  |                               | Max transactions allowed, default 0 (no limit)                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| frame_limit                              |                               | Limit the number of CONTINUATION, PING, PRIORITY, RESET, SETTINGS and empty frames in one HTTP2 connection, default 10000                                                                                                                                                                                                                                                                                                                                                             |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| failover_url                             |                               | Failover to this URL (Failover URL Name)                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| host_switching                           |                               | Field host_switching                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| list                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | host_switching_type                  |                               | 'contains'= Select service group if hostname contains another string; 'ends- with'= Select service group if hostname ends with another string; 'equals'= Select service group if hostname equals another string; 'starts-with'= Select service group if hostname starts with another string; 'regex-match'= Select service group if URL string matches with regular expression; 'host-hits- enable'= Enables Host Hits counters;                                                      |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | host_match_string                    |                               | Hostname String                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | host_service_group                   |                               | Create a Service Group comprising Servers (Service Group Name)                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| insert_client_ip                         |                               | Insert Client IP address into HTTP header                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| insert_client_ip_header_name             |                               | HTTP Header Name for inserting Client IP                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| client_ip_hdr_replace                    |                               | Replace the existing header                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| insert_client_port                       |                               | Insert Client Port address into HTTP header                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| insert_client_port_header_name           |                               | HTTP Header Name for inserting Client Port                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| client_port_hdr_replace                  |                               | Replace the existing header                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| log_retry                                |                               | log when HTTP request retry                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| non_http_bypass                          |                               | Bypass non-http traffic instead of dropping                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| bypass_sg                                |                               | Select service group for non-http traffic (Service Group Name)                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| redirect                                 |                               | Automatically send a redirect response                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| rd_simple_loc                            |                               | Redirect location tag absolute URI string                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| rd_secure                                |                               | Use HTTPS                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| rd_port                                  |                               | Port (Port Number)                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| rd_resp_code                             |                               | '301'= Moved Permanently; '302'= Found; '303'= See Other; '307'= Temporary Redirect;                                                                                                                                                                                                                                                                                                                                                                                                  |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| redirect_rewrite                         |                               | Field redirect_rewrite                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| dict                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | match_list                           |                               | Field match_list                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | list                                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | redirect_secure                      |                               | Use HTTPS                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | bool                                 |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | redirect_secure_port                 |                               | Port (Port Number)                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | int                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| request_header_erase_list                |                               | Field request_header_erase_list                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| list                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | request_header_erase                 |                               | Erase a header from HTTP request (Header Name)                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| request_header_insert_list               |                               | Field request_header_insert_list                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| list                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | request_header_insert                |                               | Insert a header into HTTP request (Header Content (Format= '[name]=[value]'))                                                                                                                                                                                                                                                                                                                                                                                                         |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | request_header_insert_type           |                               | 'insert-if-not-exist'= Only insert the header when it does not exist; 'insert- always'= Always insert the header even when there is a header with the same name;                                                                                                                                                                                                                                                                                                                      |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| response_content_replace_list            |                               | Field response_content_replace_list                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| list                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | response_content_replace             |                               | replace the data from HTTP response content (String in the http content need to be replaced)                                                                                                                                                                                                                                                                                                                                                                                          |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | response_new_string                  |                               | String will be in the http content                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| response_header_erase_list               |                               | Field response_header_erase_list                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| list                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | response_header_erase                |                               | Erase a header from HTTP response (Header Name)                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| response_header_insert_list              |                               | Field response_header_insert_list                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| list                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | response_header_insert               |                               | Insert a header into HTTP response (Header Content (Format= '[name]=[value]'))                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | response_header_insert_type          |                               | 'insert-if-not-exist'= Only insert the header when it does not exist; 'insert- always'= Always insert the header even when there is a header with the same name;                                                                                                                                                                                                                                                                                                                      |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| request_timeout                          |                               | Request timeout if response not received (timeout in seconds)                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| retry_on_5xx                             |                               | Retry http request on HTTP 5xx code and request timeout                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| retry_on_5xx_val                         |                               | Number of times to retry (default is 3)                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| retry_on_5xx_per_req                     |                               | Retry http request on HTTP 5xx code for each request                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| retry_on_5xx_per_req_val                 |                               | Number of times to retry (default is 3)                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| strict_transaction_switch                |                               | Force server selection on every HTTP request                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| template                                 |                               | Field template                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| dict                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | logging                              |                               | Logging template (Logging Config name)                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| term_11client_hdr_conn_close             |                               | Terminate HTTP 1.1 client when req has Connection= close                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| persist_on_401                           |                               | Persist to the same server if the response code is 401                                                                                                                                                                                                                                                                                                                                                                                                                                |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| http_100_cont_wait_for_req_complete      |                               | When REQ has Expect 100 and response is not 100, then wait for whole request to be sent                                                                                                                                                                                                                                                                                                                                                                                               |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| http2_client_no_snat                     |                               | Set max-concurrent-stream = 1 when the client side is HTTP2 and no source-nat configuration is under vport                                                                                                                                                                                                                                                                                                                                                                            |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| url_hash_persist                         |                               | Use URL's hash value to select server                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| url_hash_offset                          |                               | Skip part of URL to calculate hash value (Offset of the URL string)                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| url_hash_first                           |                               | Use the begining part of URL to calculate hash value (URL string length to calculate hash value)                                                                                                                                                                                                                                                                                                                                                                                      |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| url_hash_last                            |                               | Use the end part of URL to calculate hash value (URL string length to calculate hash value)                                                                                                                                                                                                                                                                                                                                                                                           |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| use_server_status                        |                               | Use Server-Status header to do URL hashing                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| url_switching                            |                               | Field url_switching                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| list                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | url_switching_type                   |                               | 'contains'= Select service group if URL string contains another string; 'ends- with'= Select service group if URL string ends with another string; 'equals'= Select service group if URL string equals another string; 'starts-with'= Select service group if URL string starts with another string; 'regex-match'= Select service group if URL string matches with regular expression; 'url-case- insensitive'= Case insensitive URL switching; 'url-hits-enable'= Enables URL Hits; |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | url_match_string                     |                               | URL String                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | url_service_group                    |                               | Create a Service Group comprising Servers (Service Group Name)                                                                                                                                                                                                                                                                                                                                                                                                                        |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| req_hdr_wait_time                        |                               | HTTP request header wait time before abort connection                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| req_hdr_wait_time_val                    |                               | Number of seconds wait for client request header (default is 7)                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| request_line_case_insensitive            |                               | Parse http request line as case insensitive                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| keep_client_alive                        |                               | Keep client alive                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| cookie_format                            |                               | 'rfc6265'= Follow rfc6265;                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| prefix                                   |                               | 'host'= the cookie will have been set with a Secure attribute, a Path attribute with a value of /, and no Domain attribute; 'secure'= the cookie will have been set with a Secure attribute; 'check'= check server prefix and enforce prefix format;                                                                                                                                                                                                                                  |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| cookie_samesite                          |                               | 'none'= none; 'lax'= lax; 'strict'= strict;                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| server_support_http2_only                |                               | Notify the vport regarding whether server supports http2 only                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| bool                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| server_support_http2_only_value          |                               | 'auto-detect'= Commuincate with the server via HTTP/2 when an support- http2-only rport is detected; 'force'= Communicate with the server via HTTP/2 when possible;                                                                                                                                                                                                                                                                                                                   |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| client_idle_timeout                      |                               | Client session timeout if the next request is not received (timeout in seconds. 0 means disable, default is 0)                                                                                                                                                                                                                                                                                                                                                                        |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| int                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| disallowed_methods                       |                               | Enable disallowed-method check (List of disallowed HTTP methods)                                                                                                                                                                                                                                                                                                                                                                                                                      |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| disallowed_methods_action                |                               | 'drop'= Respond 400 directly;                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| allowed_methods                          |                               | Enable allowed-method check (List of allowed HTTP methods)                                                                                                                                                                                                                                                                                                                                                                                                                            |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| allowed_methods_action                   |                               | 'drop'= Respond 400 directly;                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| uuid                                     |                               | uuid of the object                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| user_tag                                 |                               | Customized tag                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| str                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
| http_protocol_check                      |                               | Field http_protocol_check                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|                                          |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| dict                                     |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | h2up_content_length_alias            |                               | 'drop'= Drop the request and send 400 to the client side;                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | malformed_h2up_header_value          |                               | 'drop'= Drop the request and send 400 to the client side;                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | malformed_h2up_scheme_value          |                               | 'drop'= Drop the request and send 400 to the client side;                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | h2up_with_transfer_encoding          |                               | 'drop'= Drop the request and send 400 to the client side;                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | multiple_content_length              |                               | 'drop'= Drop the request and send 400 to the client side;                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | multiple_transfer_encoding           |                               | 'drop'= Drop the request and send 400 to the client side;                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | transfer_encoding_and_content_length |                               | 'drop'= Drop the request and Send 400 to the client side;                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | get_and_payload                      |                               | 'drop'= Drop the request and send 400 to the client side;                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | h2up_with_host_and_auth              |                               | 'drop'= Drop the request and send 400 to the client side;                                                                                                                                                                                                                                                                                                                                                                                                                             |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | uuid                                 |                               | uuid of the object                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|   |                                      |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|   | str                                  |                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 
|   | header_filter_rule_list              |                               | Field header_filter_rule_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

