W3cubDocs

/Ansible

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

Note

This module is part of the fortinet.fortios collection (version 2.4.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.fortios. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: fortinet.fortios.fortios_cifs_profile.

New in fortinet.fortios 2.0.0

Synopsis

  • 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

Requirements

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

  • ansible>=2.15

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

cifs_profile

dictionary

Configure CIFS profile.

domain_controller

string

Domain for which to decrypt CIFS traffic. Source credential-store.domain-controller.server-name.

file_filter

dictionary

File filter.

entries

list / elements=dictionary

File filter entries.

action

string

Action taken for matched file.

Choices:

  • "log"
  • "block"

comment

string

Comment.

direction

string

Match files transmitted in the session”s originating or reply direction.

Choices:

  • "incoming"
  • "outgoing"
  • "any"

file_type

list / elements=dictionary

Select file type.

name

string / required

File type name. Source antivirus.filetype.name.

filter

string / required

Add a file filter.

protocol

list / elements=string

Protocols to apply with.

Choices:

  • "cifs"

log

string

Enable/disable file filter logging.

Choices:

  • "enable"
  • "disable"

status

string

Enable/disable file filter.

Choices:

  • "enable"
  • "disable"

name

string / required

Profile name.

server_credential_type

string

CIFS server credential type.

Choices:

  • "none"
  • "credential-replication"
  • "credential-keytab"

server_keytab

list / elements=dictionary

Server keytab.

keytab

string

Base64 encoded keytab file containing credential of the server.

password

string

Password for keytab.

principal

string / required

Service principal. For example, “host/cifsserver.example.com@example.com”.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)
  • true

member_path

string

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.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • "present"
  • "absent"

state

string / required

Indicates whether to create or remove the object.

Choices:

  • "present"
  • "absent"

vdom

string

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.

Default: "root"

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
  • The module supports check_mode.

Examples

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

Return Values

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

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: "1547"

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: "PUT"

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: "200"

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: "id"

name

string

Name of the table used to fulfill the request

Returned: always

Sample: "urlfilter"

path

string

Path of the table used to fulfill the request

Returned: always

Sample: "webfilter"

revision

string

Internal revision number

Returned: always

Sample: "17.0.2.10658"

serial

string

Serial number of the unit

Returned: always

Sample: "FGVMEVYYQT3AB5352"

status

string

Indication of the operation’s result

Returned: always

Sample: "success"

vdom

string

Virtual domain used

Returned: always

Sample: "root"

version

string

Version of the FortiGate

Returned: always

Sample: "v5.6.3"

Authors

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_cifs_profile_module.html