fortinet.fortimanager.fmgr_system_csf module – Add this device to a Security Fabric or set up a new Security Fabric on this device.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.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.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_csf.
New in fortinet.fortimanager 2.3.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The top level parameters set. |
|
Accept connections with unknown certificates and ask admin for approval. disable - Do not accept SSL connections with unknown certificates. enable - Accept SSL connections without automatic certificate verification. Choices:
|
|
Authorization request type. certificate - Request verification by certificate. serial - Request verification by serial number. Choices:
|
|
Certificate. |
|
Configuration sync mode. default - Synchronize configuration for IPAM, FortiAnalyzer, FortiSandbox, and Central Management to root node. local - Do not synchronize configuration with root node. Choices:
|
|
Enable/disable downstream device access to this device's configuration and data. disable - Disable downstream device access to this device's configuration and data. enable - Enable downstream device access to this device's configuration and data. Choices:
|
|
Default access profile for requests from downstream devices. |
|
Fabric connector. |
|
Override access profile. |
|
Enable/disable downstream device write access to configuration. disable - Disable downstream device write access to configuration. enable - Enable downstream device write access to configuration. Choices:
|
|
Serial. |
|
Fabric CMDB Object Unification. local - Global CMDB objects will not be synchronized to and from this device. default - Global CMDB objects will be synchronized in Security Fabric. Choices:
|
|
Number of worker processes for Security Fabric daemon. |
|
Enable/disable Security Fabric daemon file management. disable - Disable daemon file management. enable - Enable daemon file management. Choices:
|
|
Maximum amount of memory that can be used by the daemon files |
|
Warn when the set percentage of quota has been used. |
|
Auto-generated fixed key used when this device is the root. |
|
Fabric FortiCloud account unification. disable - Disable FortiCloud accound ID matching for Security Fabric. enable - Enable FortiCloud account ID matching for Security Fabric. Choices:
|
|
Security Fabric group name. |
|
Security Fabric group password. |
|
Enable/disable broadcast of discovery messages for log unification. disable - Disable broadcast of discovery messages for log unification. enable - Enable broadcast of discovery messages for log unification. Choices:
|
|
SAML setting configuration synchronization. local - Do not apply SAML configuration generated by root. default - SAML setting for fabric members is created by fabric root. Choices:
|
|
set the lowest SSL protocol version for upstream and downstream connections. follow-global-ssl-protocol - Follow system. sslv3 - set SSLv3 as the lowest version. tlsv1. tlsv1. tlsv1. tlsv1. Choices:
|
|
Enable/disable Security Fabric. disable - Disable Security Fabric. enable - Enable Security Fabric. Choices:
|
|
Trusted list. |
|
Security fabric authorization action. accept - Accept authorization request. deny - Deny authorization request. Choices:
|
|
Authorization type. serial - Verify downstream by serial number. certificate - Verify downstream by certificate. Choices:
|
|
Certificate. |
|
Trust authorizations by this node's administrator. disable - Disable downstream authorization. enable - Enable downstream authorization. Choices:
|
|
HA members. |
|
Index of the downstream in tree. |
|
Name. |
|
Serial. |
|
IP/FQDN of the FortiGate upstream from this FortiGate in the Security Fabric. |
|
Upstream authorization confirm. discover - Discover upstream device's info. confirm - Confirm upstream device's access. Choices:
|
|
The port number to use to communicate with the FortiGate upstream from this FortiGate in the Security Fabric |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Add this device to a Security Fabric or set up a new Security Fabric on this device.
fortinet.fortimanager.fmgr_system_csf:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
system_csf:
accept_auth_by_cert: <value in [disable, enable]>
authorization_request_type: <value in [certificate, serial]>
certificate: <string>
configuration_sync: <value in [default, local]>
downstream_access: <value in [disable, enable]>
downstream_accprofile: <string>
fabric_connector:
-
accprofile: <string>
configuration_write_access: <value in [disable, enable]>
serial: <string>
fabric_object_unification: <value in [local, default]>
fabric_workers: <integer>
file_mgmt: <value in [disable, enable]>
file_quota: <integer>
file_quota_warning: <integer>
fixed_key: <list or string>
forticloud_account_enforcement: <value in [disable, enable]>
group_name: <string>
group_password: <list or string>
log_unification: <value in [disable, enable]>
saml_configuration_sync: <value in [local, default]>
status: <value in [disable, enable]>
trusted_list:
-
action: <value in [accept, deny]>
authorization_type: <value in [serial, certificate]>
certificate: <string>
downstream_authorization: <value in [disable, enable]>
ha_members: <string>
index: <integer>
name: <string>
serial: <string>
upstream: <string>
upstream_port: <integer>
upstream_confirm: <value in [discover, confirm]>
ssl_protocol: <value in [follow-global-ssl-protocol, sslv3, tlsv1.0, ...]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |