ansible.builtin.fortios_system_csf (v2.9.27) — 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.9 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

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.5


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Add this FortiGate to a Security Fabric or set up a new Security Fabric on this FortiGate.
    fortios_system_csf:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      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>"
        management_port: "14"
        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: "22"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

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

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol.
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.
    type: str

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    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:
      configuration_sync:
        choices:
        - default
        - local
        description:
        - Configuration sync mode.
        type: str
      fabric_device:
        description:
        - Fabric device configuration.
        suboptions:
          device_ip:
            description:
            - Device IP.
            type: str
          device_type:
            choices:
            - fortimail
            description:
            - Device type.
            type: str
          login:
            description:
            - Device login name.
            type: str
          name:
            description:
            - Device name.
            required: true
            type: str
          password:
            description:
            - Device login password.
            type: str
        type: list
      fixed_key:
        description:
        - Auto-generated fixed key used when this device is the root. (Will automatically
          be generated if not set.)
        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
      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
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable Security Fabric.
        type: str
      trusted_list:
        description:
        - Pre-authorized and blocked security fabric nodes.
        suboptions:
          action:
            choices:
            - accept
            - deny
            description:
            - Security fabric authorization action.
            type: str
          downstream_authorization:
            choices:
            - enable
            - disable
            description:
            - Trust authorizations by this node's administrator.
            type: str
          ha_members:
            description:
            - HA members.
            type: str
          serial:
            description:
            - Serial.
            required: true
            type: str
        type: list
      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

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