fortios_system_csf – Add this FortiGate to a Security Fabric or set up a new Security Fabric on this FortiGate in Fortinet’s FortiOS and FortiGate.¶
New in version 2.9.
Synopsis¶
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and csf 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.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- system_csf - Add this FortiGate to a Security Fabric or set up a new Security Fabric on this FortiGate. type: dict
- configuration_sync - Configuration sync mode. type: str choices: default, local
- fabric_device - Fabric device configuration. type: list
- device_ip - Device IP. type: str
- device_type - Device type. type: str choices: fortimail
- login - Device login name. type: str
- name - Device name. type: str required: True
- password - Device login password. type: str
- fixed_key - Auto-generated fixed key used when this device is the root. (Will automatically be generated if not set.) type: str
- group_name - Security Fabric group name. All FortiGates in a Security Fabric must have the same group name. type: str
- group_password - Security Fabric group password. All FortiGates in a Security Fabric must have the same group password. type: str
- management_ip - Management IP address of this FortiGate. Used to log into this FortiGate from another FortiGate in the Security Fabric. type: str
- status - Enable/disable Security Fabric. type: str choices: enable, disable
- trusted_list - Pre-authorized and blocked security fabric nodes. type: list
- action - Security fabric authorization action. type: str choices: accept, deny
- downstream_authorization - Trust authorizations by this node"s administrator. type: str choices: enable, disable
- ha_members - HA members. type: str
- serial - Serial. type: str required: True
- upstream_ip - IP address of the FortiGate upstream from this FortiGate in the Security Fabric. type: str
- upstream_port - The port number to use to communicate with the FortiGate upstream from this FortiGate in the Security Fabric . type: int
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Add this FortiGate to a Security Fabric or set up a new Security Fabric on this FortiGate.
fortios_system_csf:
vdom: "{{ vdom }}"
system_csf:
configuration_sync: "default"
fabric_device:
-
device_ip: "<your_own_value>"
device_type: "fortimail"
login: "<your_own_value>"
name: "default_name_8"
password: "<your_own_value>"
fixed_key: "<your_own_value>"
group_name: "<your_own_value>"
group_password: "<your_own_value>"
management_ip: "<your_own_value>"
status: "enable"
trusted_list:
-
action: "accept"
downstream_authorization: "enable"
ha_members: "<your_own_value>"
serial: "<your_own_value>"
upstream_ip: "<your_own_value>"
upstream_port: "21"
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