Skip to content

Latest commit

 

History

History
375 lines (331 loc) · 15.9 KB

fortios_report_dataset.rst

File metadata and controls

375 lines (331 loc) · 15.9 KB
Raw
source:fortios_report_dataset.py
orphan:

fortios_report_dataset -- Report dataset configuration 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 report feature and dataset 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_report_dataset v6.0.0 -> v6.4.4

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
  • report_dataset - Report dataset configuration. type: dict more...
    Supported Version Ranges
    report_dataset v6.0.0 -> v6.4.4
    • field - Fields. type: list member_path: field:id more...
      Supported Version Ranges
      field v6.0.0 -> v6.4.4
      • displayname - Display name. type: str more...
        Supported Version Ranges
        displayname v6.0.0 -> v6.4.4
      • id - Field ID (1 to number of columns in SQL result). see Notes. type: int required: true more...
        Supported Version Ranges
        id v6.0.0 -> v6.4.4
      • name - Name. type: str more...
        Supported Version Ranges
        name v6.0.0 -> v6.4.4
      • type - Field type. type: str choices: text, integer, double more...
        Supported Version Ranges
        type v6.0.0 -> v6.4.4
        [text] v6.0.0 -> latest
        [integer] v6.0.0 -> latest
        [double] v6.0.0 -> latest
    • name - Name. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> v6.4.4
    • parameters - Parameters. type: list member_path: parameters:id more...
      Supported Version Ranges
      parameters v6.0.0 -> v6.4.4
      • data_type - Data type. type: str choices: text, integer, double, long-integer, date-time more...
        Supported Version Ranges
        data_type v6.0.0 -> v6.4.4
        [text] v6.0.0 -> latest
        [integer] v6.0.0 -> latest
        [double] v6.0.0 -> latest
        [long-integer] v6.0.0 -> latest
        [date-time] v6.0.0 -> latest
      • display_name - Display name. type: str more...
        Supported Version Ranges
        display_name v6.0.0 -> v6.4.4
      • field - SQL field name. type: str more...
        Supported Version Ranges
        field v6.0.0 -> v6.4.4
      • id - Parameter ID (1 to number of columns in SQL result). see Notes. type: int required: true more...
        Supported Version Ranges
        id v6.0.0 -> v6.4.4
    • policy - Used by monitor policy. type: int more...
      Supported Version Ranges
      policy v6.0.0 -> v6.4.4
    • query - SQL query statement. type: str more...
      Supported Version Ranges
      query v6.0.0 -> v6.4.4

Notes

Note

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

Examples

- name: Report dataset configuration.
  fortinet.fortios.fortios_report_dataset:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      report_dataset:
          field:
              -
                  displayname: "<your_own_value>"
                  id: "5"
                  name: "default_name_6"
                  type: "text"
          name: "default_name_8"
          parameters:
              -
                  data_type: "text"
                  display_name: "<your_own_value>"
                  field: "<your_own_value>"
                  id: "13"
          policy: "2147483647"
          query: "<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.