lix_fortinet.fortios.fortios_cifs_profile (102.2.120) — module

Configure CIFS profile in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of lix_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 lix_fortinet.fortios:==102.2.120


Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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>"

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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

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

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

cifs_profile:
    default: null
    description:
    - Configure CIFS profile.
    suboptions:
      domain_controller:
        description:
        - Domain for which to decrypt CIFS traffic. Source credential-store.domain-controller.server-name.
        type: str
      file_filter:
        description:
        - File filter.
        suboptions:
          entries:
            description:
            - File filter entries.
            elements: dict
            suboptions:
              action:
                choices:
                - log
                - block
                description:
                - Action taken for matched file.
                type: str
              comment:
                description:
                - Comment.
                type: str
              direction:
                choices:
                - incoming
                - outgoing
                - any
                description:
                - Match files transmitted in the session"s originating or reply direction.
                type: str
              file_type:
                description:
                - Select file type.
                elements: dict
                suboptions:
                  name:
                    description:
                    - File type name. Source antivirus.filetype.name.
                    type: str
                type: list
              filter:
                description:
                - Add a file filter.
                type: str
              protocol:
                choices:
                - cifs
                description:
                - Protocols to apply with.
                elements: str
                type: list
            type: list
          log:
            choices:
            - enable
            - disable
            description:
            - Enable/disable file filter logging.
            type: str
          status:
            choices:
            - enable
            - disable
            description:
            - Enable/disable file filter.
            type: str
        type: dict
      name:
        description:
        - Profile name.
        required: true
        type: str
      server_credential_type:
        choices:
        - none
        - credential-replication
        - credential-keytab
        description:
        - CIFS server credential type.
        type: str
      server_keytab:
        description:
        - Server keytab.
        elements: dict
        suboptions:
          keytab:
            description:
            - Base64 encoded keytab file containing credential of the server.
            type: str
          password:
            description:
            - Password for keytab.
            type: str
          principal:
            description:
            - Service principal.  For example, "host/cifsserver.example.com@example.com".
            type: str
        type: list
    type: dict

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