fortios_cifs_profile – Configure CIFS profile in Fortinet’s FortiOS and FortiGate.

New in version 2.0.0.


  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify cifs feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0


The below requirements are needed on the host that executes this module.

  • ansible>=2.14


Using member operation to add an element to an existing object.

FortiOS Version Compatibility

Supported Version Ranges
fortios_cifs_profile v6.2.0 -> v6.2.7 v6.4.1 -> v6.4.1


  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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 default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • cifs_profile - Configure CIFS profile. type: dict more...
    • domain_controller - Domain for which to decrypt CIFS traffic. Source credential-store.domain-controller.server-name. type: str more...
    • file_filter - File filter. type: dict more...
      • entries - File filter entries. type: list member_path: file_filter/entries:filter more...
        • action - Action taken for matched file. type: str choices: log, block more...
        • comment - Comment. type: str more...
        • direction - Match files transmitted in the session"s originating or reply direction. type: str choices: incoming, outgoing, any more...
        • file_type - Select file type. type: list member_path: file_filter/entries:filter/file_type:name more...
          • name - File type name. Source type: str required: true more...
        • filter - Add a file filter. type: str required: true more...
        • protocol - Protocols to apply with. type: list choices: cifs more...
      • log - Enable/disable file filter logging. type: str choices: enable, disable more...
      • status - Enable/disable file filter. type: str choices: enable, disable more...
    • name - Profile name. type: str required: true more...
    • server_credential_type - CIFS server credential type. type: str choices: none, credential-replication, credential-keytab more...
    • server_keytab - Server keytab. type: list member_path: server_keytab:principal more...
      • keytab - Base64 encoded keytab file containing credential of the server. type: str more...
      • password - Password for keytab. type: str more...
      • principal - Service principal. For example, "host/". type: str required: true more...



  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks


- name: Configure CIFS profile.
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
          domain_controller: "<your_own_value> (source credential-store.domain-controller.server-name)"
                      action: "log"
                      comment: "Comment."
                      direction: "incoming"
                              name: "default_name_10 (source"
                      filter: "<your_own_value>"
                      protocol: "cifs"
              log: "enable"
              status: "enable"
          name: "default_name_15"
          server_credential_type: "none"
                  keytab: "<your_own_value>"
                  password: "<your_own_value>"
                  principal: "<your_own_value>"

Return Values

Common return values are documented:, the following are the fields unique to this module:

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


  • This module is not guaranteed to have a backwards compatible interface.


  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)


If you notice any issues in this documentation, you can create a pull request to improve it.