fortinet.fortios.fortios_system_csf module – Add this FortiGate to a Security Fabric or set up a new Security Fabric on this FortiGate in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.6.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_system_csf.
New in fortinet.fortios 2.0.0
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.16
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Add this FortiGate to a Security Fabric or set up a new Security Fabric on this FortiGate. |
|
Accept connections with unknown certificates and ask admin for approval. Choices:
|
|
Authorization request type. Choices:
|
|
Control system behavior for deleted shared objects. Choices:
|
|
Certificate. Source certificate.local.name. |
|
Configuration sync mode. Choices:
|
|
Enable/disable downstream device access to this device”s configuration and data. Choices:
|
|
Default access profile for requests from downstream devices. Source system.accprofile.name. |
|
Fabric connector configuration. |
|
Override access profile. Source system.accprofile.name. |
|
Enable/disable downstream device write access to configuration. Choices:
|
|
Serial. |
|
Virtual domains that the connector has access to. If none are set, the connector will only have access to the VDOM that it joins the Security Fabric through. |
|
Virtual domain name. Source system.vdom.name. |
|
Disable the fabric datasource check on the tables when synchronizing them. |
|
Name. |
|
Enable/disable the fabric datasource check on the target table. Choices:
|
|
Fabric device configuration. |
|
Device access token. |
|
Device IP. |
|
Device type. Choices:
|
|
HTTPS port for fabric device. |
|
Device login name. |
|
Device name. |
|
Device login password. |
|
Enable/disable the cascade mode for fabric objects datasource check. Choices:
|
|
Fabric CMDB Object Unification. Choices:
|
|
Number of worker processes for Security Fabric daemon. |
|
Enable/disable Security Fabric daemon file management. Choices:
|
|
Maximum amount of memory that can be used by the daemon files (in bytes). |
|
Warn when the set percentage of quota has been used. |
|
Auto-generated fixed key used when this device is the root. (Will automatically be generated if not set.) |
|
Fabric FortiCloud account unification. Choices:
|
|
Security Fabric group name. All FortiGates in a Security Fabric must have the same group name. |
|
Security Fabric group password. For legacy authentication, fabric members must have the same group password. |
|
Enable/disable legacy authentication. Choices:
|
|
Enable/disable broadcast of discovery messages for log unification. Choices:
|
|
Management IP address of this FortiGate. Used to log into this FortiGate from another FortiGate in the Security Fabric. |
|
Overriding port for management connection (Overrides admin port). |
|
SAML setting configuration synchronization. Choices:
|
|
Fabric-wide objects shared by non-root nodes. |
|
UID of the source device. |
|
CMDB table entries. |
|
Keys of CMDB table entries. |
|
key. Source firewall.address.name. |
|
CMDB path and object name. |
|
Trusted list entry name. Source system.csf.trusted-list.name. |
|
Source IP address for communication with the upstream FortiGate. |
|
Enable/disable Security Fabric. Choices:
|
|
Pre-authorized and blocked security fabric nodes. |
|
Security fabric authorization action. Choices:
|
|
Authorization type. Choices:
|
|
Name of a CA on the downstream”s certificat chain. Source certificate.ca.name. |
|
SHA512 fingerprint of a CA on the downstream”s certificate chain. |
|
Certificate. |
|
Certificate CNs used by HA members. |
|
Trust authorizations by this node”s administrator. Choices:
|
|
HA members. |
|
Index of the downstream in tree. |
|
Name. |
|
Device role to this member. Choices:
|
|
Serial. |
|
Unique ID of the current CSF node |
|
Configure uploading shared objects entries to the tree. Choices:
|
|
IP/FQDN of the FortiGate upstream from this FortiGate in the Security Fabric. |
|
Specify outgoing interface to reach server. Source system.interface.name. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
IP address of the FortiGate upstream from this FortiGate in the Security Fabric. |
|
The port number to use to communicate with the FortiGate upstream from this FortiGate in the Security Fabric . |
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Add this FortiGate to a Security Fabric or set up a new Security Fabric on this FortiGate.
fortinet.fortios.fortios_system_csf:
vdom: "{{ vdom }}"
system_csf:
accept_auth_by_cert: "disable"
authorization_request_type: "serial"
autoclear_removed_shared_objects: "enable"
certificate: "<your_own_value> (source certificate.local.name)"
configuration_sync: "default"
downstream_access: "enable"
downstream_accprofile: "<your_own_value> (source system.accprofile.name)"
fabric_connector:
-
accprofile: "<your_own_value> (source system.accprofile.name)"
configuration_write_access: "enable"
serial: "<your_own_value>"
vdom:
-
name: "default_name_15 (source system.vdom.name)"
fabric_datasource_exemption:
-
name: "default_name_17"
status: "enable"
fabric_device:
-
access_token: "<your_own_value>"
device_ip: "<your_own_value>"
device_type: "fortimail"
https_port: "443"
login: "<your_own_value>"
name: "default_name_25"
password: "<your_own_value>"
fabric_object_change_auto_cascade: "enable"
fabric_object_unification: "default"
fabric_workers: "2"
file_mgmt: "enable"
file_quota: "0"
file_quota_warning: "90"
fixed_key: "<your_own_value>"
forticloud_account_enforcement: "enable"
group_name: "<your_own_value>"
group_password: "<your_own_value>"
legacy_authentication: "disable"
log_unification: "disable"
management_ip: "<your_own_value>"
management_port: "32767"
saml_configuration_sync: "default"
shared_objects:
-
name: "default_name_43"
objects:
-
keys:
-
name: "default_name_46 (source firewall.address.name)"
pathname: "<your_own_value>"
trusted_list_entry: "<your_own_value> (source system.csf.trusted-list.name)"
source_ip: "84.230.14.43"
status: "enable"
trusted_list:
-
action: "accept"
authorization_type: "serial"
ca: "<your_own_value> (source certificate.ca.name)"
ca_fingerprint: "<your_own_value>"
certificate: "<your_own_value>"
cn: "<your_own_value>"
downstream_authorization: "enable"
ha_members: "<your_own_value>"
index: "0"
name: "default_name_61"
role: "downstream"
serial: "<your_own_value>"
uid: "<your_own_value>"
upload_shared_objects: "enable"
upstream: "<your_own_value>"
upstream_interface: "<your_own_value> (source system.interface.name)"
upstream_interface_select_method: "auto"
upstream_ip: "<your_own_value>"
upstream_port: "8013"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |