fortios_llm_server – Configure LLM Proxy servers 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 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.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_server - Configure LLM Proxy servers. type: dict more...
- accept_custom_model - accept custom model type: str choices: enable, disable more...
- anthropic_version - Anthropic version in API type: str more...
- api_key - API Keys of the LLM server type: list
- azure_api_version - Azure API version. type: str more...
- azure_resource_name - Azure resource name. type: str more...
- built_in_server - built-in LLM server type: str choices: openai, azure, azure-openai, gemini, anthropic, grok, gemini-with-openai-api, anthropic-with-openai-api more...
- chat_completions_api - Chat Completions API of this server type: str choices: none, openai, azure-openai, gemini, anthropic more...
- custom_model_allow_regex - custom model allow regex, allow all if empty type: str more...
- custom_model_block_regex - custom model block regex, no block if empty type: str more...
- display_name - display name of the LLM Server type: str more...
- end_point - Overwrite the default end-point of the vendor. type: str more...
- image_gen_api - Image-Gen API of this server type: str choices: none, openai, azure-openai more...
- models - models of the LLM Server type: list
- name - LLM Proxy server name. type: str required: true more...
- type - LLM server type type: str choices: built-in, customized more...
- verify_cert - Enable/disable certificate verification. 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 servers.
fortinet.fortios.fortios_llm_server:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
llm_server:
accept_custom_model: "enable"
anthropic_version: "<your_own_value>"
api_key: "<your_own_value>"
azure_api_version: "<your_own_value>"
azure_resource_name: "<your_own_value>"
built_in_server: "openai"
chat_completions_api: "none"
custom_model_allow_regex: "<your_own_value>"
custom_model_block_regex: "<your_own_value>"
display_name: "<your_own_value>"
end_point: "<your_own_value>"
image_gen_api: "none"
models: "<your_own_value>"
name: "default_name_16"
type: "built-in"
verify_cert: "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.