Skip to content

Latest commit

 

History

History
277 lines (233 loc) · 13.1 KB

fortios_web_proxy_forward_server_group.rst

File metadata and controls

277 lines (233 loc) · 13.1 KB
Raw
source:fortios_web_proxy_forward_server_group.py
orphan:

fortios_web_proxy_forward_server_group -- Configure a forward server group consisting or multiple forward servers. Supports failover and load balancing in Fortinet's FortiOS and FortiGate.

.. versionadded:: 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 forward_server_group 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_group 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_group - Configure a forward server group consisting or multiple forward servers. Supports failover and load balancing. type: dict more...
    Supported Version Ranges
    web_proxy_forward_server_group v6.0.0 -> latest
    • affinity - Enable/disable affinity, attaching a source-ip"s traffic to the assigned forwarding server until the forward-server-affinity-timeout is reached (under web-proxy global). type: str choices: enable, disable more...
      Supported Version Ranges
      affinity v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • group_down_option - Action to take when all of the servers in the forward server group are down: block sessions until at least one server is back up or pass sessions to their destination. type: str choices: block, pass more...
      Supported Version Ranges
      group_down_option v6.0.0 -> latest
      [block] v6.0.0 -> latest
      [pass] v6.0.0 -> latest
    • ldb_method - Load balance method: weighted or least-session. type: str choices: weighted, least-session, active-passive more...
      Supported Version Ranges
      ldb_method v6.0.0 -> latest
      [weighted] v6.0.0 -> latest
      [least-session] v6.0.0 -> latest
      [active-passive] v6.2.0 -> latest
    • name - Configure a forward server group consisting one or multiple forward servers. Supports failover and load balancing. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> latest
    • server_list - Add web forward servers to a list to form a server group. Optionally assign weights to each server. type: list member_path: server_list:name more...
      Supported Version Ranges
      server_list v6.0.0 -> latest
      • name - Forward server name. Source web-proxy.forward-server.name. type: str required: true more...
        Supported Version Ranges
        name v6.0.0 -> latest
      • weight - Optionally assign a weight of the forwarding server for weighted load balancing (1 - 100). type: int more...
        Supported Version Ranges
        weight v6.0.0 -> latest

Notes

Note

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

Examples

- name: Configure a forward server group consisting or multiple forward servers. Supports failover and load balancing.
  fortinet.fortios.fortios_web_proxy_forward_server_group:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      web_proxy_forward_server_group:
          affinity: "enable"
          group_down_option: "block"
          ldb_method: "weighted"
          name: "default_name_6"
          server_list:
              -
                  name: "default_name_8 (source web-proxy.forward-server.name)"
                  weight: "10"

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.