fortios_system_fortisandbox.rst

source:	fortios_system_fortisandbox.py
orphan:

fortios_system_fortisandbox -- Configure FortiSandbox in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

Synopsis

• This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and fortisandbox 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.14

Tips

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

FortiOS Version Compatibility

	Supported Version Ranges
fortios_system_fortisandbox	v6.0.0 -> latest

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
• system_fortisandbox - Configure FortiSandbox. type: dict more...

  	Supported Version Ranges
  system_fortisandbox	v6.0.0 -> latest

• email - Notifier email address. type: str more...

  	Supported Version Ranges
  email	v6.0.0 -> latest

• enc_algorithm - Configure the level of SSL protection for secure communication with FortiSandbox. type: str choices: default, high, low more...

  	Supported Version Ranges
  enc_algorithm	v6.0.0 -> latest
  [default]	v6.0.0 -> latest
  [high]	v6.0.0 -> latest
  [low]	v6.0.0 -> latest

• forticloud - Enable/disable FortiSandbox Cloud. type: str choices: enable, disable more...

  	Supported Version Ranges
  forticloud	v7.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• inline_scan - Enable/disable FortiSandbox inline scan. type: str choices: enable, disable more...

  	Supported Version Ranges
  inline_scan	v7.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• interface - Specify outgoing interface to reach server. Source system.interface.name. type: str more...

  	Supported Version Ranges
  interface	v6.4.0 -> v6.4.0	v6.4.4 -> latest

• interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify more...

  	Supported Version Ranges
  interface_select_method	v6.4.0 -> v6.4.0	v6.4.4 -> latest
  [auto]	v6.0.0 -> latest
  [sdwan]	v6.0.0 -> latest
  [specify]	v6.0.0 -> latest

• server - Server IP address or FQDN of the remote FortiSandbox. type: str more...

  	Supported Version Ranges
  server	v6.0.0 -> latest

• source_ip - Source IP address for communications to FortiSandbox. type: str more...

  	Supported Version Ranges
  source_ip	v6.0.0 -> latest

• ssl_min_proto_version - Minimum supported protocol version for SSL/TLS connections . type: str choices: default, SSLv3, TLSv1, TLSv1-1, TLSv1-2, TLSv1-3 more...

  	Supported Version Ranges
  ssl_min_proto_version	v6.0.0 -> latest
  [default]	v6.0.0 -> latest
  [SSLv3]	v6.0.0 -> latest
  [TLSv1]	v6.0.0 -> latest
  [TLSv1-1]	v6.0.0 -> latest
  [TLSv1-2]	v6.0.0 -> latest
  [TLSv1-3]	v7.4.1 -> latest

• status - Enable/disable FortiSandbox. type: str choices: enable, disable more...

  	Supported Version Ranges
  status	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

Notes

Note

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

Examples

- name: Configure FortiSandbox.
  fortinet.fortios.fortios_system_fortisandbox:
      vdom: "{{ vdom }}"
      system_fortisandbox:
          email: "<your_own_value>"
          enc_algorithm: "default"
          forticloud: "enable"
          inline_scan: "enable"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          server: "192.168.100.40"
          source_ip: "84.230.14.43"
          ssl_min_proto_version: "default"
          status: "enable"

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.