fortios_llm_proxy – Configure LLM Proxy in Fortinet’s FortiOS and FortiGate.

Added in version 2.0.0.

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify llm feature and proxy 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.16

Tips

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

FortiOS Version Compatibility

Supported Version Ranges: v8.0.0

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
  • llm_proxy - Configure LLM Proxy. type: dict more...
    • hostname - hostname. Source firewall.address.name. type: str more...
    • incoming_http_port - LLM Proxy HTTP incoming port. type: int more...
    • incoming_https_port - LLM Proxy HTTPS incoming port. type: int more...
    • incoming_ip - LLM Proxy incoming IP. type: str more...
    • incoming_ip6 - LLM Proxy incoming IPv6. type: str more...
    • interface - Name of the interfaces to use LLM Proxy. type: list member_path: interface:name more...
      • name - Interface list. Source system.interface.name. type: str required: true more...
    • ipv6_status - Enable/disable the LLM proxy on IPv6. type: str choices: enable, disable more...
    • name - LLM Proxy name. type: str required: true more...
    • protocol - Supported protocols. type: list choices: http, https more...
    • srv_pool_max_concurrent_request - Maximum number of concurrent requests that a server can handle . type: int more...
    • srv_pool_max_request - Maximum number of requests that a server can handle before disconnecting sessions . type: int more...
    • srv_pool_ttl - Time-to-live for idle connections to servers. type: int more...
    • ssl_certificate - Name of the certificates to use for SSL handshake. type: list member_path: ssl_certificate:name more...
      • name - Certificate list. Source vpn.certificate.local.name. type: str required: true more...
    • ssl_max_version - Highest SSL/TLS version acceptable from a client. type: str choices: ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3 more...
    • ssl_min_version - Lowest SSL/TLS version acceptable from a client. type: str choices: ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3 more...
    • status - Enable/disable the LLM proxy. type: str choices: enable, disable more...

Notes

Note

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

Examples

- name: Configure LLM Proxy.
  fortinet.fortios.fortios_llm_proxy:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      llm_proxy:
          hostname: "myhostname (source firewall.address.name)"
          incoming_http_port: "8098"
          incoming_https_port: "8099"
          incoming_ip: "<your_own_value>"
          incoming_ip6: "<your_own_value>"
          interface:
              -
                  name: "default_name_9 (source system.interface.name)"
          ipv6_status: "enable"
          name: "default_name_11"
          protocol: "http"
          srv_pool_max_concurrent_request: "0"
          srv_pool_max_request: "0"
          srv_pool_ttl: "30"
          ssl_certificate:
              -
                  name: "default_name_17 (source vpn.certificate.local.name)"
          ssl_max_version: "ssl-3.0"
          ssl_min_version: "ssl-3.0"
          status: "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.