fortinet.fortimanager.fmgr_webproxy_profile (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

This module is able to configure a FortiManager device.

Examples include all parameters and values which need to be adjusted to data sources before usage.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure web proxy profiles.
      fortinet.fortimanager.fmgr_webproxy_profile:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        webproxy_profile:
          header_client_ip: <value in [pass, add, remove]>
          header_front_end_https: <value in [pass, add, remove]>
          header_via_request: <value in [pass, add, remove]>
          header_via_response: <value in [pass, add, remove]>
          header_x_authenticated_groups: <value in [pass, add, remove]>
          header_x_authenticated_user: <value in [pass, add, remove]>
          header_x_forwarded_for: <value in [pass, add, remove]>
          headers:
            -
              action: <value in [add-to-request, add-to-response, remove-from-request, ...]>
              content: <string>
              id: <integer>
              name: <string>
              add_option: <value in [append, new-on-not-found, new]>
              base64_encoding: <value in [disable, enable]>
              dstaddr: <list or string>
              dstaddr6: <list or string>
              protocol:
                - https
                - http
          log_header_change: <value in [disable, enable]>
          name: <string>
          strip_encoding: <value in [disable, enable]>
          header_x_forwarded_client_cert: <value in [pass, add, remove]>

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

webproxy_profile:
    description: The top level parameters set.
    required: false
    suboptions:
      header-client-ip:
        choices:
        - pass
        - add
        - remove
        description: Deprecated, please rename it to header_client_ip. Action to take
          on the HTTP client-IP header in forwarded requests
        type: str
      header-front-end-https:
        choices:
        - pass
        - add
        - remove
        description: Deprecated, please rename it to header_front_end_https. Action to
          take on the HTTP front-end-HTTPS header in forwarded req...
        type: str
      header-via-request:
        choices:
        - pass
        - add
        - remove
        description: Deprecated, please rename it to header_via_request. Action to take
          on the HTTP via header in forwarded requests
        type: str
      header-via-response:
        choices:
        - pass
        - add
        - remove
        description: Deprecated, please rename it to header_via_response. Action to take
          on the HTTP via header in forwarded responses
        type: str
      header-x-authenticated-groups:
        choices:
        - pass
        - add
        - remove
        description: Deprecated, please rename it to header_x_authenticated_groups. Action
          to take on the HTTP x-authenticated-groups header in...
        type: str
      header-x-authenticated-user:
        choices:
        - pass
        - add
        - remove
        description: Deprecated, please rename it to header_x_authenticated_user. Action
          to take on the HTTP x-authenticated-user header in for...
        type: str
      header-x-forwarded-client-cert:
        choices:
        - pass
        - add
        - remove
        description: Deprecated, please rename it to header_x_forwarded_client_cert. Action
          to take on the HTTP x-forwarded-client-cert header ...
        type: str
      header-x-forwarded-for:
        choices:
        - pass
        - add
        - remove
        description: Deprecated, please rename it to header_x_forwarded_for. Action to
          take on the HTTP x-forwarded-for header in forwarded req...
        type: str
      headers:
        description: Headers.
        elements: dict
        suboptions:
          action:
            choices:
            - add-to-request
            - add-to-response
            - remove-from-request
            - remove-from-response
            - monitor-request
            - monitor-response
            description: Action when HTTP the header forwarded.
            type: str
          add-option:
            choices:
            - append
            - new-on-not-found
            - new
            description: Deprecated, please rename it to add_option. Configure options
              to append content to existing HTTP header or add new...
            type: str
          base64-encoding:
            choices:
            - disable
            - enable
            description: Deprecated, please rename it to base64_encoding. Enable/disable
              use of base64 encoding of HTTP content.
            type: str
          content:
            description: HTTP headers content.
            type: str
          dstaddr:
            description: (list or str) Destination address and address group names.
            type: raw
          dstaddr6:
            description: (list or str) Destination address and address group names
            type: raw
          id:
            description: HTTP forwarded header id.
            type: int
          name:
            description: HTTP forwarded header name.
            type: str
          protocol:
            choices:
            - https
            - http
            description: Configure protocol
            elements: str
            type: list
        type: list
      log-header-change:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to log_header_change. Enable/disable
          logging HTTP header changes.
        type: str
      name:
        description: Profile name.
        required: true
        type: str
      strip-encoding:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to strip_encoding. Enable/disable stripping
          unsupported encoding from the request header.
        type: str
    type: dict

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list