faz_report_config_chart – Config chart.

Added in version 1.5.0.

Warning

Starting in version 2.0.0, all variables will be named in the underscore naming convention.

  • Possible variable names before 2.0.0: variable-name, variable name, variable.name

  • Corresponding variable names since 2.0.0: variable_name

FortiAnalyzer Ansible v1.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

Synopsis

  • This module is able to configure a FortiAnalyzer device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • This module supports check mode and diff mode.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.16.0

FortiAnalyzer Version Compatibility

Supported Version Ranges: v6.2.1 -> latest

Parameters

  • access_token The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str
  • bypass_validation Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool default: False
  • enable_log Enable/Disable logging for task type: bool default: False
  • forticloud_access_token Access token of forticloud analyzer API users. type: str
  • log_path The path to save log. Used if enable_log is true. Please use absolute path instead of relative path. If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.logtype: str default: "/tmp/fortianalyzer.ansible.log"
  • proposed_method The overridden method for the underlying Json RPC request type: str choices: set, update, add
  • version_check If set to True, it will check whether the parameters used are supported by the corresponding version of FortiAnazlyer locally based on FNDN data. A warning will be returned in version_check_warning if there is a mismatch. This warning is only a suggestion and may not be accurate. type: bool default: True
  • rc_succeeded The rc codes list with which the conditions to succeed will be overriden type: list
  • rc_failed The rc codes list with which the conditions to fail will be overriden type: list
  • state The directive to create, update or delete an object type: str required: true choices: present, absent
  • adom The parameter in requested url type: str required: true
  • report_config_chart Config chart. type: dict
    • category type: str more...
    • description type: str more...
    • dev_type type: str choices: [FortiSandbox, FortiWeb, Fabric, Syslog, FortiCache, FortiAuthenticator, FortiMail, FortiProxy, FortiManager, FortiNAC, FortiAnalyzer, FortiClient, FortiDDoS, FortiGate, FortiFirewall] more...
    • disp_name type: str more...
    • drill_down_table reference: /report/adom/<adom-name>/config/chart/<chart_name>/drill-down-table type: list of dict more...
      • chart type: str more...
      • flag type: str choices: [enable, disable] more...
      • table_id type: int more...
      • chart_group type: str more...
      • page_break_after type: str choices: [enable, disable] default: disable more...
      • show_title type: str choices: [enable, disable] default: disable more...
    • name type: str more...
    • table_columns reference: /report/adom/<adom-name>/config/chart/<chart_name>/table-columns type: list of dict more...
      • data_type type: str choices: [aggregate, raw, drilldown] more...
      • header type: str more...
      • id type: int more...
      • column_attr type: str choices: [app-id, email-recver, timespan, obf-url, cal-percent, vuln, bandwidth, dev-type, severity, percent, trend, attack, html, ipsec-tunnel, web-cat, ip-country, email-sender, search, virus, user, state-icon, count, none, dst-country, url, appcat, time, kbps] default: none more...
      • column_graph_type type: str choices: [none, bar, line-down, line-up] default: none more...
      • column_num type: int more...
      • column_span type: int default: 1 more...
      • column_width type: int default: 0 more...
      • data_binding type: str more...
      • data_top type: int default: 3 more...
      • legend type: str more...
    • variable_template reference: /report/adom/<adom-name>/config/chart/<chart_name>/variable-template type: list of dict more...
      • not type: str choices: [enable, disable] more...
      • var type: str more...
      • var_value type: str more...
      • description type: str more...
      • drilldown_flag type: str choices: [enable, disable] default: disable more...
      • status type: str choices: [enable, disable] default: disable more...
      • var_expression type: str more...
      • var_type type: str choices: [ip, integer, string, datetime] more...
      • view_mask type: int default: 0 more...
    • chart_type type: str choices: [map, none, chord, bar, area, pie, donut, radar, table, line] default: none more...
    • dataset type: str more...
    • drill_down_agg type: str choices: [enable, disable] default: disable more...
    • drill_down_desc type: str more...
    • drill_down_title type: str more...
    • favorite type: str choices: [enable, disable] default: disable more...
    • hidden type: str choices: [enable, disable] default: disable more...
    • include_other type: str choices: [enable, disable] default: enable more...
    • line_subtype type: str choices: [back-to-back, stacked, basic] default: stacked more...
    • order_by type: str more...
    • order_desc type: str choices: [enable, disable] default: disable more...
    • protected type: str choices: [enable, disable] default: disable more...
    • resolve_hostname type: str choices: [enable, disable] default: disable more...
    • resolve_hostname_mode type: str choices: [variable, specify] default: variable more...
    • scale type: int more...
    • show_table type: str choices: [enable, disable] default: disable more...
    • x_axis_data_binding type: str more...
    • x_axis_data_top type: int default: 6 more...
    • x_axis_include_other type: str choices: [enable, disable] default: disable more...
    • x_axis_label type: str more...
    • y_axis_data_binding type: str more...
    • y_axis_group type: str choices: [enable, disable] default: disable more...
    • y_axis_group_by type: str more...
    • y_axis_group_top type: int default: 3 more...
    • y_axis_label type: str more...
    • y2_axis_data_binding type: str more...
    • y2_axis_label type: str more...
    • tags type: str more...
    • chart_style type: str more...

Notes

Note

  • To create or update an object, use state: present directive.

  • To delete an object, use state: absent directive

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook
  hosts: fortianalyzers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_network_os: fortinet.fortianalyzer.fortianalyzer
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
  tasks:
    - name: Config chart.
      fortinet.fortianalyzer.faz_report_config_chart:
        # bypass_validation: false
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        report_config_chart:
          name: "your value" # Required variable, string
          # category: <value of string>
          # description: <value of string>
          # dev_type: <value in [FortiSandbox, FortiWeb, Fabric, ...]>
          # disp_name: <value of string>
          # drill_down_table:
          #   - chart: <value of string>
          #     flag: <value in [enable, disable]>
          #     table_id: <value of integer>
          #     chart_group: <value of string>
          #     page_break_after: <value in [enable, disable]>
          #     show_title: <value in [enable, disable]>
          # table_columns:
          #   - data_type: <value in [aggregate, raw, drilldown]>
          #     header: <value of string>
          #     id: <value of integer>
          #     column_attr: <value in [app-id, email-recver, timespan, ...]>
          #     column_graph_type: <value in [none, bar, line-down, ...]>
          #     column_num: <value of integer>
          #     column_span: <value of integer>
          #     column_width: <value of integer>
          #     data_binding: <value of string>
          #     data_top: <value of integer>
          #     legend: <value of string>
          # variable_template:
          #   - not: <value in [enable, disable]>
          #     var: <value of string>
          #     var_value: <value of string>
          #     description: <value of string>
          #     drilldown_flag: <value in [enable, disable]>
          #     status: <value in [enable, disable]>
          #     var_expression: <value of string>
          #     var_type: <value in [ip, integer, string, ...]>
          #     view_mask: <value of integer>
          # chart_type: <value in [map, none, chord, ...]>
          # dataset: <value of string>
          # drill_down_agg: <value in [enable, disable]>
          # drill_down_desc: <value of string>
          # drill_down_title: <value of string>
          # favorite: <value in [enable, disable]>
          # hidden: <value in [enable, disable]>
          # include_other: <value in [enable, disable]>
          # line_subtype: <value in [back-to-back, stacked, basic]>
          # order_by: <value of string>
          # order_desc: <value in [enable, disable]>
          # protected: <value in [enable, disable]>
          # resolve_hostname: <value in [enable, disable]>
          # resolve_hostname_mode: <value in [variable, specify]>
          # scale: <value of integer>
          # show_table: <value in [enable, disable]>
          # x_axis_data_binding: <value of string>
          # x_axis_data_top: <value of integer>
          # x_axis_include_other: <value in [enable, disable]>
          # x_axis_label: <value of string>
          # y_axis_data_binding: <value of string>
          # y_axis_group: <value in [enable, disable]>
          # y_axis_group_by: <value of string>
          # y_axis_group_top: <value of integer>
          # y_axis_label: <value of string>
          # y2_axis_data_binding: <value of string>
          # y2_axis_label: <value of string>
          # tags: <value of string>
          # chart_style: <value of string>

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:

  • meta The result of the request. returned: always type: dict
    • request_url The full url requested. returned: always type: str sample: /sys/login/user
    • response_code The status of api request. returned: always type: int sample: 0
    • response_data The data body of the api response. returned: optional type: list or dict
    • response_message The descriptive message of the api response. returned: always type: str sample: OK
    • system_information The information of the target system. returned: always type: dict
  • rc The status the request. returned: always type: int sample: 0
  • version_check_warning Warning if the parameters used in the playbook are not supported by the current fortianalyzer version. returned: if params are not supported in the current version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Maxx Liu (@MaxxLiu22)

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)