fortios_web_proxy_profile – Configure web proxy profiles in Fortinet’s FortiOS and FortiGate  New in version 2.8.   Synopsis Requirements Parameters Notes Examples Return Values Status  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.5  Requirements The below requirements are needed on the host that executes this module.  fortiosapi>=0.9.8  Parameters   Parameter Choices/Defaults Comments    host  string      FortiOS or FortiGate IP address.     https  boolean    
Choices: no 
yes ←    Indicates if the requests towards FortiGate must use HTTPS protocol.     password  string    Default:""   FortiOS or FortiGate password.     ssl_verify  boolean  added in 2.9   
Choices: no 
yes ←    Ensures FortiGate certificate must be verified by a proper CA.     state  string  added in 2.9   
Choices: present absent    Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level.     username  string      FortiOS or FortiGate username.     vdom  string    Default:"root"   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.     web_proxy_profile  dictionary    Default:null   Configure web proxy profiles.      header_client_ip  string    
Choices: pass add remove    Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header.      header_front_end_https  string    
Choices: pass add remove    Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header.      header_via_request  string    
Choices: pass add remove    Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header.      header_via_response  string    
Choices: pass add remove    Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header.      header_x_authenticated_groups  string    
Choices: pass add remove    Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header.      header_x_authenticated_user  string    
Choices: pass add remove    Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header.      header_x_forwarded_for  string    
Choices: pass add remove    Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header.      headers  list      Configure HTTP forwarded requests headers.       action  string    
Choices: add-to-request add-to-response remove-from-request remove-from-response    Action when HTTP the header forwarded.       content  string      HTTP header's content.       id  integer / required      HTTP forwarded header id.       name  string      HTTP forwarded header name.      log_header_change  string    
Choices: enable disable    Enable/disable logging HTTP header changes.      name  string / required      Profile name.      state  string    
Choices: present absent    Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object.      strip_encoding  string    
Choices: enable disable    Enable/disable stripping unsupported encoding from the request header.     Notes  Note  Requires fortiosapi library developed by Fortinet Run as a local_action in your playbook   Examples - hosts: localhost
  vars:
   host: "248-973-5056"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure web proxy profiles.
    fortios_web_proxy_profile:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      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_for: "pass"
        headers:
         -
            action: "add-to-request"
            content: "<your_own_value>"
            id:  "13"
            name: "default_name_14"
        log_header_change: "enable"
        name: "default_name_16"
        strip_encoding: "enable"
 Return Values Common return values are documented here, the following are the fields unique to this module:   Key Returned Description    build  string   always  Build number of the fortigate image  Sample: 1547     http_method  string   always  Last method used to provision the content into FortiGate  Sample: PUT     http_status  string   always  Last result given by FortiGate on last operation applied  Sample: 200     mkey  string   success  Master key (id) used in the last call to FortiGate  Sample: id     name  string   always  Name of the table used to fulfill the request  Sample: urlfilter     path  string   always  Path of the table used to fulfill the request  Sample: webfilter     revision  string   always  Internal revision number  Sample: 30.202-26-51708     serial  string   always  Serial number of the unit  Sample: FGVMEVYYQT3AB5352     status  string   always  Indication of the operation's result  Sample: success     vdom  string   always  Virtual domain used  Sample: root     version  string   always  Version of the FortiGate  Sample: v5.6.3     Status  This module is not guaranteed to have a backwards compatible interface. [preview]
 This module is maintained by the Ansible Community. [community]
  Authors  Miguel Angel Munoz (@mamunozgonzalez) Nicolas Thomas (@thomnico)   Hint If you notice any issues in this documentation, you can edit this document to improve it. 

    © 2012–2018 Michael DeHaan
{'path': 'public/docs/ansible~2.9/modules/fortios_web_proxy_profile_module.html', 'source': 'DevDocs.IO'}