fortios_web_proxy_forward_server.rst

source:	fortios_web_proxy_forward_server.py
orphan:

fortios_web_proxy_forward_server -- Configure forward-server addresses in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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 forward_server 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.14

Tips

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

FortiOS Version Compatibility

	Supported Version Ranges
fortios_web_proxy_forward_server	v6.0.0 -> latest

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_forward_server - Configure forward-server addresses. type: dict more...

  	Supported Version Ranges
  web_proxy_forward_server	v6.0.0 -> latest

• addr_type - Address type of the forwarding proxy server: IP or FQDN. type: str choices: ip, ipv6, fqdn more...

  	Supported Version Ranges
  addr_type	v6.0.0 -> latest
  [ip]	v6.0.0 -> latest
  [ipv6]	v7.4.1 -> latest
  [fqdn]	v6.0.0 -> latest

• comment - Comment. type: str more...

  	Supported Version Ranges
  comment	v6.0.0 -> latest

• fqdn - Forward server Fully Qualified Domain Name (FQDN). type: str more...

  	Supported Version Ranges
  fqdn	v6.0.0 -> latest

• healthcheck - Enable/disable forward server health checking. Attempts to connect through the remote forwarding server to a destination to verify that the forwarding server is operating normally. type: str choices: disable, enable more...

  	Supported Version Ranges
  healthcheck	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest

• ip - Forward proxy server IP address. type: str more...

  	Supported Version Ranges
  ip	v6.0.0 -> latest

• ipv6 - Forward proxy server IPv6 address. type: str more...

  	Supported Version Ranges
  ipv6	v7.4.1 -> latest

• monitor - URL for forward server health check monitoring . type: str more...

  	Supported Version Ranges
  monitor	v6.0.0 -> latest

• name - Server name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• password - HTTP authentication password. type: str more...

  	Supported Version Ranges
  password	v6.4.0 -> latest

• port - Port number that the forwarding server expects to receive HTTP sessions on (1 - 65535). type: int more...

  	Supported Version Ranges
  port	v6.0.0 -> latest

• server_down_option - Action to take when the forward server is found to be down: block sessions until the server is back up or pass sessions to their destination. type: str choices: block, pass more...

  	Supported Version Ranges
  server_down_option	v6.0.0 -> latest
  [block]	v6.0.0 -> latest
  [pass]	v6.0.0 -> latest

• username - HTTP authentication user name. type: str more...

  	Supported Version Ranges
  username	v6.4.0 -> latest

Notes

Note

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

Examples

- name: Configure forward-server addresses.
  fortinet.fortios.fortios_web_proxy_forward_server:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      web_proxy_forward_server:
          addr_type: "ip"
          comment: "Comment."
          fqdn: "<your_own_value>"
          healthcheck: "disable"
          ip: "<your_own_value>"
          ipv6: "<your_own_value>"
          monitor: "<your_own_value>"
          name: "default_name_10"
          password: "<your_own_value>"
          port: "3128"
          server_down_option: "block"
          username: "<your_own_value>"

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.