Skip to content

Latest commit

 

History

History
276 lines (235 loc) · 12.5 KB

fortios_wireless_controller_utm_profile.rst

File metadata and controls

276 lines (235 loc) · 12.5 KB
Raw
source:fortios_wireless_controller_utm_profile.py
orphan:

fortios_wireless_controller_utm_profile -- Configure UTM (Unified Threat Management) 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 wireless_controller feature and utm_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

Tips

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

FortiOS Version Compatibility

Supported Version Ranges: v6.0.0 -> 7.4.3

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
  • wireless_controller_utm_profile - Configure UTM (Unified Threat Management) profile. type: dict more...
    Supported Version Ranges
    wireless_controller_utm_profile v6.0.0 -> 7.4.3
    • antivirus_profile - AntiVirus profile name. Source antivirus.profile.name. type: str more...
      Supported Version Ranges
      antivirus_profile v6.0.0 -> 7.4.3
    • application_list - Application control list name. Source application.list.name. type: str more...
      Supported Version Ranges
      application_list v6.0.0 -> 7.4.3
    • comment - Comment. type: str more...
      Supported Version Ranges
      comment v6.0.0 -> 7.4.3
    • ips_sensor - IPS sensor name. Source ips.sensor.name. type: str more...
      Supported Version Ranges
      ips_sensor v6.0.0 -> 7.4.3
    • name - UTM profile name. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> 7.4.3
    • scan_botnet_connections - Block or monitor connections to Botnet servers or disable Botnet scanning. type: str choices: disable, monitor, block more...
      Supported Version Ranges
      scan_botnet_connections v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
      [monitor] v6.0.0 -> 7.4.3
      [block] v6.0.0 -> 7.4.3
    • utm_log - Enable/disable UTM logging. type: str choices: enable, disable more...
      Supported Version Ranges
      utm_log v6.0.0 -> 7.4.3
      [enable] v6.0.0 -> 7.4.3
      [disable] v6.0.0 -> 7.4.3
    • webfilter_profile - WebFilter profile name. Source webfilter.profile.name. type: str more...
      Supported Version Ranges
      webfilter_profile v6.0.0 -> 7.4.3

Notes

Note

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

Examples

- name: Configure UTM (Unified Threat Management) profile.
  fortinet.fortios.fortios_wireless_controller_utm_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wireless_controller_utm_profile:
          antivirus_profile: "<your_own_value> (source antivirus.profile.name)"
          application_list: "<your_own_value> (source application.list.name)"
          comment: "Comment."
          ips_sensor: "<your_own_value> (source ips.sensor.name)"
          name: "default_name_7"
          scan_botnet_connections: "disable"
          utm_log: "enable"
          webfilter_profile: "<your_own_value> (source webfilter.profile.name)"

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.