Skip to content

Latest commit

 

History

History
2550 lines (2505 loc) · 77 KB

fortios_web_proxy_profile.rst

File metadata and controls

2550 lines (2505 loc) · 77 KB
Raw
source

fortios_web_proxy_profile.py

orphan

fortios_web_proxy_profile -- Configure web proxy profiles in Fortinet's FortiOS and FortiGate.

2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify web_proxy feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.2.0 v7.2.1 v7.2.2
fortios_web_proxy_profile yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • web_proxy_profile - Configure web proxy profiles. type: dict

    <a id='label0' href="javascript:ContentClick('label1', 'label0');" onmouseover="ContentPreview('label1');" onmouseout="ContentUnpreview('label1');" title="click to collapse or expand..."> more... </a> <div id="label1" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>web_proxy_profile</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">header_client_ip</span> - Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header. <span class="li-normal">type: str</span> <span class="li-normal">choices: pass, add, remove</span> <a id='label2' href="javascript:ContentClick('label3', 'label2');" onmouseover="ContentPreview('label3');" onmouseout="ContentUnpreview('label3');" title="click to collapse or expand..."> more... </a> <div id="label3" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>header_client_ip</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[pass]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[add]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[remove]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">header_front_end_https</span> - Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header. <span class="li-normal">type: str</span> <span class="li-normal">choices: pass, add, remove</span> <a id='label4' href="javascript:ContentClick('label5', 'label4');" onmouseover="ContentPreview('label5');" onmouseout="ContentUnpreview('label5');" title="click to collapse or expand..."> more... </a> <div id="label5" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>header_front_end_https</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[pass]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[add]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[remove]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">header_via_request</span> - Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header. <span class="li-normal">type: str</span> <span class="li-normal">choices: pass, add, remove</span> <a id='label6' href="javascript:ContentClick('label7', 'label6');" onmouseover="ContentPreview('label7');" onmouseout="ContentUnpreview('label7');" title="click to collapse or expand..."> more... </a> <div id="label7" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>header_via_request</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[pass]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[add]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[remove]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">header_via_response</span> - Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header. <span class="li-normal">type: str</span> <span class="li-normal">choices: pass, add, remove</span> <a id='label8' href="javascript:ContentClick('label9', 'label8');" onmouseover="ContentPreview('label9');" onmouseout="ContentUnpreview('label9');" title="click to collapse or expand..."> more... </a> <div id="label9" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>header_via_response</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[pass]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[add]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[remove]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">header_x_authenticated_groups</span> - Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header. <span class="li-normal">type: str</span> <span class="li-normal">choices: pass, add, remove</span> <a id='label10' href="javascript:ContentClick('label11', 'label10');" onmouseover="ContentPreview('label11');" onmouseout="ContentUnpreview('label11');" title="click to collapse or expand..."> more... </a> <div id="label11" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>header_x_authenticated_groups</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[pass]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[add]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[remove]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">header_x_authenticated_user</span> - Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header. <span class="li-normal">type: str</span> <span class="li-normal">choices: pass, add, remove</span> <a id='label12' href="javascript:ContentClick('label13', 'label12');" onmouseover="ContentPreview('label13');" onmouseout="ContentUnpreview('label13');" title="click to collapse or expand..."> more... </a> <div id="label13" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>header_x_authenticated_user</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[pass]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[add]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[remove]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">header_x_forwarded_client_cert</span> - Action to take on the HTTP x-forwarded-client-cert header in forwarded requests: forwards (pass), adds, or removes the HTTP header. <span class="li-normal">type: str</span> <span class="li-normal">choices: pass, add, remove</span> <a id='label14' href="javascript:ContentClick('label15', 'label14');" onmouseover="ContentPreview('label15');" onmouseout="ContentUnpreview('label15');" title="click to collapse or expand..."> more... </a> <div id="label15" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>header_x_forwarded_client_cert</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[pass]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[add]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[remove]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">header_x_forwarded_for</span> - Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header. <span class="li-normal">type: str</span> <span class="li-normal">choices: pass, add, remove</span> <a id='label16' href="javascript:ContentClick('label17', 'label16');" onmouseover="ContentPreview('label17');" onmouseout="ContentUnpreview('label17');" title="click to collapse or expand..."> more... </a> <div id="label17" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>header_x_forwarded_for</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[pass]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[add]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[remove]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">headers</span> - Configure HTTP forwarded requests headers. <span class="li-normal">type: list</span> <a id='label18' href="javascript:ContentClick('label19', 'label18');" onmouseover="ContentPreview('label19');" onmouseout="ContentUnpreview('label19');" title="click to collapse or expand..."> more... </a> <div id="label19" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>headers</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">action</span> - Action when the HTTP header is forwarded. <span class="li-normal">type: str</span> <span class="li-normal">choices: add-to-request, add-to-response, remove-from-request, remove-from-response</span> <a id='label20' href="javascript:ContentClick('label21', 'label20');" onmouseover="ContentPreview('label21');" onmouseout="ContentUnpreview('label21');" title="click to collapse or expand..."> more... </a> <div id="label21" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>action</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[add-to-request]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[add-to-response]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[remove-from-request]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[remove-from-response]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">add_option</span> - Configure options to append content to existing HTTP header or add new HTTP header. <span class="li-normal">type: str</span> <span class="li-normal">choices: append, new-on-not-found, new</span> <a id='label22' href="javascript:ContentClick('label23', 'label22');" onmouseover="ContentPreview('label23');" onmouseout="ContentUnpreview('label23');" title="click to collapse or expand..."> more... </a> <div id="label23" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>add_option</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[append]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[new-on-not-found]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[new]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">base64_encoding</span> - Enable/disable use of base64 encoding of HTTP content. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label24' href="javascript:ContentClick('label25', 'label24');" onmouseover="ContentPreview('label25');" onmouseout="ContentUnpreview('label25');" title="click to collapse or expand..."> more... </a> <div id="label25" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>base64_encoding</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">content</span> - HTTP header content. <span class="li-normal">type: str</span> <a id='label26' href="javascript:ContentClick('label27', 'label26');" onmouseover="ContentPreview('label27');" onmouseout="ContentUnpreview('label27');" title="click to collapse or expand..."> more... </a> <div id="label27" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>content</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">dstaddr</span> - Destination address and address group names. <span class="li-normal">type: list</span> <a id='label28' href="javascript:ContentClick('label29', 'label28');" onmouseover="ContentPreview('label29');" onmouseout="ContentUnpreview('label29');" title="click to collapse or expand..."> more... </a> <div id="label29" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>dstaddr</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">name</span> - Address name. Source firewall.address.name firewall.addrgrp.name. <span class="li-normal">type: str</span> <a id='label30' href="javascript:ContentClick('label31', 'label30');" onmouseover="ContentPreview('label31');" onmouseout="ContentUnpreview('label31');" title="click to collapse or expand..."> more... </a> <div id="label31" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>name</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">dstaddr6</span> - Destination address and address group names (IPv6). <span class="li-normal">type: list</span> <a id='label32' href="javascript:ContentClick('label33', 'label32');" onmouseover="ContentPreview('label33');" onmouseout="ContentUnpreview('label33');" title="click to collapse or expand..."> more... </a> <div id="label33" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>dstaddr6</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">name</span> - Address name. Source firewall.address6.name firewall.addrgrp6.name. <span class="li-normal">type: str</span> <a id='label34' href="javascript:ContentClick('label35', 'label34');" onmouseover="ContentPreview('label35');" onmouseout="ContentUnpreview('label35');" title="click to collapse or expand..."> more... </a> <div id="label35" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>name</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">id</span> - HTTP forwarded header id. <span class="li-normal">type: int</span> <a id='label36' href="javascript:ContentClick('label37', 'label36');" onmouseover="ContentPreview('label37');" onmouseout="ContentUnpreview('label37');" title="click to collapse or expand..."> more... </a> <div id="label37" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>id</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">name</span> - HTTP forwarded header name. <span class="li-normal">type: str</span> <a id='label38' href="javascript:ContentClick('label39', 'label38');" onmouseover="ContentPreview('label39');" onmouseout="ContentUnpreview('label39');" title="click to collapse or expand..."> more... </a> <div id="label39" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>name</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">protocol</span> - Configure protocol(s) to take add-option action on (HTTP, HTTPS, or both). <span class="li-normal">type: list</span> <span class="li-normal">choices: https, http</span> <a id='label40' href="javascript:ContentClick('label41', 'label40');" onmouseover="ContentPreview('label41');" onmouseout="ContentUnpreview('label41');" title="click to collapse or expand..."> more... </a> <div id="label41" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>protocol</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[https]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[http]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">log_header_change</span> - Enable/disable logging HTTP header changes. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label42' href="javascript:ContentClick('label43', 'label42');" onmouseover="ContentPreview('label43');" onmouseout="ContentUnpreview('label43');" title="click to collapse or expand..."> more... </a> <div id="label43" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>log_header_change</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">name</span> - Profile name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label44' href="javascript:ContentClick('label45', 'label44');" onmouseover="ContentPreview('label45');" onmouseout="ContentUnpreview('label45');" title="click to collapse or expand..."> more... </a> <div id="label45" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>name</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">strip_encoding</span> - Enable/disable stripping unsupported encoding from the request header. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label46' href="javascript:ContentClick('label47', 'label46');" onmouseover="ContentPreview('label47');" onmouseout="ContentUnpreview('label47');" title="click to collapse or expand..."> more... </a> <div id="label47" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>strip_encoding</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> </ul> </ul>

    Notes

    Note

    • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

    Examples

    - hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure web proxy profiles.
    fortios_web_proxy_profile:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      web_proxy_profile:
        header_client_ip: "pass"
        header_front_end_https: "pass"
        header_via_request: "pass"
        header_via_response: "pass"
        header_x_authenticated_groups: "pass"
        header_x_authenticated_user: "pass"
        header_x_forwarded_client_cert: "pass"
        header_x_forwarded_for: "pass"
        headers:
         -
            action: "add-to-request"
            add_option: "append"
            base64_encoding: "disable"
            content: "<your_own_value>"
            dstaddr:
             -
                name: "default_name_17 (source firewall.address.name firewall.addrgrp.name)"
            dstaddr6:
             -
                name: "default_name_19 (source firewall.address6.name firewall.addrgrp6.name)"
            id:  "20"
            name: "default_name_21"
            protocol: "https"
        log_header_change: "enable"
        name: "default_name_24"
        strip_encoding: "enable"

    Return Values

    Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

    • build - Build number of the fortigate image returned: always type: str sample: 1547
    • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
    • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
    • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
    • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
    • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
    • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
    • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
    • status - Indication of the operation's result returned: always type: str sample: success
    • vdom - Virtual domain used returned: always type: str sample: root
    • version - Version of the FortiGate returned: always type: str sample: v5.6.3

    Status

    • This module is not guaranteed to have a backwards compatible interface.

    Authors

    • Link Zheng (@chillancezen)
    • Jie Xue (@JieX19)
    • Hongbin Lu (@fgtdev-hblu)
    • Frank Shen (@frankshen01)
    • Miguel Angel Munoz (@mamunozgonzalez)
    • Nicolas Thomas (@thomnico)

    Hint

    If you notice any issues in this documentation, you can create a pull request to improve it.