Skip to content

Latest commit

 

History

History
679 lines (634 loc) · 24.7 KB

fortios_cifs_profile.rst

File metadata and controls

679 lines (634 loc) · 24.7 KB
Raw
source:fortios_cifs_profile.py
orphan:

fortios_cifs_profile -- Configure CIFS profile in Fortinet's FortiOS and FortiGate.

.. versionadded:: 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.9

Tips

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

FortiOS Version Compatibility


v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.1
fortios_cifs_profile yes yes yes yes yes

Parameters

  • 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...
    v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.1
    cifs_profile yes yes yes yes yes
    • domain_controller - Domain for which to decrypt CIFS traffic. Source credential-store.domain-controller.server-name. type: str more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.1
      domain_controller yes yes yes yes yes
    • file_filter - File filter. type: dict more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7
      file_filter yes yes yes yes
      • entries - File filter entries. type: list member_path: file_filter/entries:filter more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        entries yes yes yes yes
        • action - Action taken for matched file. type: str choices: log, block more...
          v6.2.0 v6.2.3 v6.2.5 v6.2.7
          action yes yes yes yes
          [log] yes yes yes yes
          [block] yes yes yes yes
        • comment - Comment. type: str more...
          v6.2.0 v6.2.3 v6.2.5 v6.2.7
          comment yes yes yes yes
        • direction - Match files transmitted in the session"s originating or reply direction. type: str choices: incoming, outgoing, any more...
          v6.2.0 v6.2.3 v6.2.5 v6.2.7
          direction yes yes yes yes
          [incoming] yes yes yes yes
          [outgoing] yes yes yes yes
          [any] yes yes yes yes
        • file_type - Select file type. type: list member_path: file_filter/entries:filter/file_type:name more...
          v6.2.0 v6.2.3 v6.2.5 v6.2.7
          file_type yes yes yes yes
          • name - File type name. Source antivirus.filetype.name. type: str required: true more...
            v6.2.0 v6.2.3 v6.2.5 v6.2.7
            name yes yes yes yes
        • filter - Add a file filter. type: str required: true more...
          v6.2.0 v6.2.3 v6.2.5 v6.2.7
          filter yes yes yes yes
        • protocol - Protocols to apply with. type: list choices: cifs more...
          v6.2.0 v6.2.3
          protocol no yes
          [cifs] n/a yes
      • log - Enable/disable file filter logging. type: str choices: enable, disable more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        log yes yes yes yes
        [enable] yes yes yes yes
        [disable] yes yes yes yes
      • status - Enable/disable file filter. type: str choices: enable, disable more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7
        status yes yes yes yes
        [enable] yes yes yes yes
        [disable] yes yes yes yes
    • name - Profile name. type: str required: true more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.1
      name yes yes yes yes yes
    • server_credential_type - CIFS server credential type. type: str choices: none, credential-replication, credential-keytab more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.1
      server_credential_type yes yes yes yes yes
      [none] yes yes yes yes yes
      [credential-replication] yes yes yes yes yes
      [credential-keytab] yes yes yes yes yes
    • server_keytab - Server keytab. type: list member_path: server_keytab:principal more...
      v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.1
      server_keytab yes yes yes yes yes
      • keytab - Base64 encoded keytab file containing credential of the server. type: str more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.1
        keytab yes yes yes yes yes
      • password - Password for keytab. type: str more...
        v6.2.0 v6.2.3
        password no yes
      • principal - Service principal. For example, "host/cifsserver.example.com@example.com". type: str required: true more...
        v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.1
        principal yes yes yes yes yes

Notes

Note

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

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure CIFS profile.
    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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, 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: 17.0.2.10658
  • 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

Status

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

Authors

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

Hint

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