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.2).

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

access_token

string

The token to access FortiManager without using username and password.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

system_csf

dictionary

The top level parameters set.

accept_auth_by_cert

aliases: accept-auth-by-cert

string

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:

  • "disable"

  • "enable"

authorization_request_type

aliases: authorization-request-type

string

Authorization request type.

certificate - Request verification by certificate.

serial - Request verification by serial number.

Choices:

  • "certificate"

  • "serial"

certificate

string

Certificate.

configuration_sync

aliases: configuration-sync

string

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:

  • "default"

  • "local"

downstream_access

aliases: downstream-access

string

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:

  • "disable"

  • "enable"

downstream_accprofile

aliases: downstream-accprofile

string

Default access profile for requests from downstream devices.

fabric_connector

aliases: fabric-connector

list / elements=dictionary

Fabric connector.

accprofile

string

Override access profile.

configuration_write_access

aliases: configuration-write-access

string

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:

  • "disable"

  • "enable"

serial

string

Serial.

fabric_object_unification

aliases: fabric-object-unification

string

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:

  • "local"

  • "default"

fabric_workers

aliases: fabric-workers

integer

Number of worker processes for Security Fabric daemon.

file_mgmt

aliases: file-mgmt

string

Enable/disable Security Fabric daemon file management.

disable - Disable daemon file management.

enable - Enable daemon file management.

Choices:

  • "disable"

  • "enable"

file_quota

aliases: file-quota

integer

Maximum amount of memory that can be used by the daemon files

file_quota_warning

aliases: file-quota-warning

integer

Warn when the set percentage of quota has been used.

fixed_key

aliases: fixed-key

list / elements=string

Auto-generated fixed key used when this device is the root.

forticloud_account_enforcement

aliases: forticloud-account-enforcement

string

Fabric FortiCloud account unification.

disable - Disable FortiCloud accound ID matching for Security Fabric.

enable - Enable FortiCloud account ID matching for Security Fabric.

Choices:

  • "disable"

  • "enable"

group_name

aliases: group-name

string

Security Fabric group name.

group_password

aliases: group-password

list / elements=string

Security Fabric group password.

log_unification

aliases: log-unification

string

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:

  • "disable"

  • "enable"

saml_configuration_sync

aliases: saml-configuration-sync

string

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:

  • "local"

  • "default"

ssl_protocol

aliases: ssl-protocol

string

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:

  • "follow-global-ssl-protocol"

  • "sslv3"

  • "tlsv1.0"

  • "tlsv1.1"

  • "tlsv1.2"

  • "tlsv1.3"

status

string

Enable/disable Security Fabric.

disable - Disable Security Fabric.

enable - Enable Security Fabric.

Choices:

  • "disable"

  • "enable"

trusted_list

aliases: trusted-list

list / elements=dictionary

Trusted list.

action

string

Security fabric authorization action.

accept - Accept authorization request.

deny - Deny authorization request.

Choices:

  • "accept"

  • "deny"

authorization_type

aliases: authorization-type

string

Authorization type.

serial - Verify downstream by serial number.

certificate - Verify downstream by certificate.

Choices:

  • "serial"

  • "certificate"

certificate

string

Certificate.

downstream_authorization

aliases: downstream-authorization

string

Trust authorizations by this node's administrator.

disable - Disable downstream authorization.

enable - Enable downstream authorization.

Choices:

  • "disable"

  • "enable"

ha_members

aliases: ha-members

string

HA members.

index

integer

Index of the downstream in tree.

name

string

Name.

serial

string

Serial.

upstream

string

IP/FQDN of the FortiGate upstream from this FortiGate in the Security Fabric.

upstream_confirm

aliases: upstream-confirm

string

Upstream authorization confirm.

discover - Discover upstream device's info.

confirm - Confirm upstream device's access.

Choices:

  • "discover"

  • "confirm"

upstream_port

aliases: upstream-port

integer

The port number to use to communicate with the FortiGate upstream from this FortiGate in the Security Fabric

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

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

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)