fortinet.fortios.fortios_casb_profile (2.3.6) — module

Configure CASB profile in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of 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 fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify casb 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.
- name: Configure CASB profile.
  fortinet.fortios.fortios_casb_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      casb_profile:
          name: "default_name_3"
          saas_application:
              -
                  access_rule:
                      -
                          action: "bypass"
                          bypass: "av"
                          name: "default_name_8 (source casb.user-activity.name)"
                  custom_control:
                      -
                          name: "default_name_10 (source casb.user-activity.name)"
                          option:
                              -
                                  name: "default_name_12"
                                  user_input:
                                      -
                                          value: "<your_own_value>"
                  domain_control: "enable"
                  domain_control_domains:
                      -
                          name: "default_name_17"
                  log: "enable"
                  name: "default_name_19 (source casb.saas-application.name)"
                  safe_search: "enable"
                  safe_search_control:
                      -
                          name: "default_name_22"
                  status: "enable"
                  tenant_control: "enable"
                  tenant_control_tenants:
                      -
                          name: "default_name_26"

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

casb_profile:
    default: null
    description:
    - Configure CASB profile.
    suboptions:
      name:
        description:
        - CASB profile name.
        required: true
        type: str
      saas_application:
        description:
        - CASB profile SaaS application.
        elements: dict
        suboptions:
          access_rule:
            description:
            - CASB profile access rule.
            elements: dict
            suboptions:
              action:
                choices:
                - bypass
                - block
                - monitor
                description:
                - CASB access rule action.
                type: str
              bypass:
                choices:
                - av
                - dlp
                - web-filter
                - file-filter
                - video-filter
                description:
                - CASB bypass options.
                elements: str
                type: list
              name:
                description:
                - CASB access rule activity name. Source casb.user-activity.name.
                required: true
                type: str
            type: list
          custom_control:
            description:
            - CASB profile custom control.
            elements: dict
            suboptions:
              name:
                description:
                - CASB custom control user activity name. Source casb.user-activity.name.
                required: true
                type: str
              option:
                description:
                - CASB custom control option.
                elements: dict
                suboptions:
                  name:
                    description:
                    - CASB custom control option name.
                    required: true
                    type: str
                  user_input:
                    description:
                    - CASB custom control user input.
                    elements: dict
                    suboptions:
                      value:
                        description:
                        - user input value.
                        required: true
                        type: str
                    type: list
                type: list
            type: list
          domain_control:
            choices:
            - enable
            - disable
            description:
            - Enable/disable domain control.
            type: str
          domain_control_domains:
            description:
            - CASB profile domain control domains.
            elements: dict
            suboptions:
              name:
                description:
                - Domain control domain name.
                required: true
                type: str
            type: list
          log:
            choices:
            - enable
            - disable
            description:
            - Enable/disable log settings.
            type: str
          name:
            description:
            - CASB profile SaaS application name. Source casb.saas-application.name.
            required: true
            type: str
          safe_search:
            choices:
            - enable
            - disable
            description:
            - Enable/disable safe search.
            type: str
          safe_search_control:
            description:
            - CASB profile safe search control.
            elements: dict
            suboptions:
              name:
                description:
                - Safe search control name.
                required: true
                type: str
            type: list
          status:
            choices:
            - enable
            - disable
            description:
            - Enable/disable setting.
            type: str
          tenant_control:
            choices:
            - enable
            - disable
            description:
            - Enable/disable tenant control.
            type: str
          tenant_control_tenants:
            description:
            - CASB profile tenant control tenants.
            elements: dict
            suboptions:
              name:
                description:
                - Tenant control tenants name.
                required: true
                type: str
            type: list
        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