fortinet.fortios.fortios_system_csf (2.3.6) — module

Add this FortiGate to a Security Fabric or set up a new Security Fabric on this FortiGate in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"
          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_14 (source system.vdom.name)"
          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_21"
                  password: "<your_own_value>"
          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>"
          log_unification: "disable"
          management_ip: "<your_own_value>"
          management_port: "32767"
          saml_configuration_sync: "default"
          status: "enable"
          trusted_list:
              -
                  action: "accept"
                  authorization_type: "serial"
                  certificate: "<your_own_value>"
                  downstream_authorization: "enable"
                  ha_members: "<your_own_value>"
                  index: "0"
                  name: "default_name_44"
                  serial: "<your_own_value>"
          uid: "<your_own_value>"
          upstream: "<your_own_value>"
          upstream_ip: "<your_own_value>"
          upstream_port: "8013"

Inputs

    
vdom:
    default: root
    description:
    - 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

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

system_csf:
    default: null
    description:
    - Add this FortiGate to a Security Fabric or set up a new Security Fabric on this
      FortiGate.
    suboptions:
      accept_auth_by_cert:
        choices:
        - disable
        - enable
        description:
        - Accept connections with unknown certificates and ask admin for approval.
        type: str
      authorization_request_type:
        choices:
        - serial
        - certificate
        description:
        - Authorization request type.
        type: str
      certificate:
        description:
        - Certificate. Source certificate.local.name.
        type: str
      configuration_sync:
        choices:
        - default
        - local
        description:
        - Configuration sync mode.
        type: str
      downstream_access:
        choices:
        - enable
        - disable
        description:
        - Enable/disable downstream device access to this device"s configuration and data.
        type: str
      downstream_accprofile:
        description:
        - Default access profile for requests from downstream devices. Source system.accprofile.name.
        type: str
      fabric_connector:
        description:
        - Fabric connector configuration.
        elements: dict
        suboptions:
          accprofile:
            description:
            - Override access profile. Source system.accprofile.name.
            type: str
          configuration_write_access:
            choices:
            - enable
            - disable
            description:
            - Enable/disable downstream device write access to configuration.
            type: str
          serial:
            description:
            - Serial.
            required: true
            type: str
          vdom:
            description:
            - 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.
            elements: dict
            suboptions:
              name:
                description:
                - Virtual domain name. Source system.vdom.name.
                required: true
                type: str
            type: list
        type: list
      fabric_device:
        description:
        - Fabric device configuration.
        elements: dict
        suboptions:
          access_token:
            description:
            - Device access token.
            type: str
          device_ip:
            description:
            - Device IP.
            type: str
          device_type:
            choices:
            - fortimail
            description:
            - Device type.
            type: str
          https_port:
            description:
            - HTTPS port for fabric device.
            type: int
          login:
            description:
            - Device login name.
            type: str
          name:
            description:
            - Device name.
            required: true
            type: str
          password:
            description:
            - Device login password.
            type: str
        type: list
      fabric_object_unification:
        choices:
        - default
        - local
        description:
        - Fabric CMDB Object Unification.
        type: str
      fabric_workers:
        description:
        - Number of worker processes for Security Fabric daemon.
        type: int
      file_mgmt:
        choices:
        - enable
        - disable
        description:
        - Enable/disable Security Fabric daemon file management.
        type: str
      file_quota:
        description:
        - Maximum amount of memory that can be used by the daemon files (in bytes).
        type: int
      file_quota_warning:
        description:
        - Warn when the set percentage of quota has been used.
        type: int
      fixed_key:
        description:
        - Auto-generated fixed key used when this device is the root. (Will automatically
          be generated if not set.)
        type: str
      forticloud_account_enforcement:
        choices:
        - enable
        - disable
        description:
        - Fabric FortiCloud account unification.
        type: str
      group_name:
        description:
        - Security Fabric group name. All FortiGates in a Security Fabric must have the
          same group name.
        type: str
      group_password:
        description:
        - Security Fabric group password. All FortiGates in a Security Fabric must have
          the same group password.
        type: str
      log_unification:
        choices:
        - disable
        - enable
        description:
        - Enable/disable broadcast of discovery messages for log unification.
        type: str
      management_ip:
        description:
        - Management IP address of this FortiGate. Used to log into this FortiGate from
          another FortiGate in the Security Fabric.
        type: str
      management_port:
        description:
        - Overriding port for management connection (Overrides admin port).
        type: int
      saml_configuration_sync:
        choices:
        - default
        - local
        description:
        - SAML setting configuration synchronization.
        type: str
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable Security Fabric.
        type: str
      trusted_list:
        description:
        - Pre-authorized and blocked security fabric nodes.
        elements: dict
        suboptions:
          action:
            choices:
            - accept
            - deny
            description:
            - Security fabric authorization action.
            type: str
          authorization_type:
            choices:
            - serial
            - certificate
            description:
            - Authorization type.
            type: str
          certificate:
            description:
            - Certificate.
            type: str
          downstream_authorization:
            choices:
            - enable
            - disable
            description:
            - Trust authorizations by this node"s administrator.
            type: str
          ha_members:
            description:
            - HA members.
            elements: str
            type: list
          index:
            description:
            - Index of the downstream in tree.
            type: int
          name:
            description:
            - Name.
            required: true
            type: str
          serial:
            description:
            - Serial.
            type: str
        type: list
      uid:
        description:
        - Unique ID of the current CSF node
        type: str
      upstream:
        description:
        - IP/FQDN of the FortiGate upstream from this FortiGate in the Security Fabric.
        type: str
      upstream_ip:
        description:
        - IP address of the FortiGate upstream from this FortiGate in the Security Fabric.
        type: str
      upstream_port:
        description:
        - The port number to use to communicate with the FortiGate upstream from this
          FortiGate in the Security Fabric .
        type: int
    type: dict

member_path:
    description:
    - 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.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str