:source: faz_report_config_layout.py :orphan: .. _faz_report_config_layout: faz_report_config_layout -- Config layout. ++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 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. .. contents:: :local: :depth: 1 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 ------------------------------------ .. raw:: html

Supported Version Ranges: v6.2.1 -> latest

Parameters ---------- .. raw:: html 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 -------- .. code-block:: yaml+jinja - 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 layout. fortinet.fortianalyzer.faz_report_config_layout: # bypass_validation: false # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] adom: state: present # report_config_layout: layout_id: 0 # Required variable, integer # body: # component: # - component_id: # type: # variable: # - not: # var: # var_value: # description: # drilldown_flag: # status: # var_expression: # var_type: # view_mask: # alignment: # bg_color: # category: # chart: # chart_option: # column: # customized: # device_mode: # devices: # drill_down_report: # filter_logic: # filter_mode: # font_color: # font_family: # font_size: # font_type: # graphic: # include_other: # ldap_query: # ldap_server: # ldap_user_case_change: # left_margin: # macro: # not_vdom: # period_end: # period_last_n: # period_mode: # period_opt: # period_start: # right_margin: # table_color: # text: # time_period: # title: # vdom: # week_start: # width: # description: # footer: # - footer_id: # type: # graphic: # text: # header: # - header_id: # type: # graphic: # text: # language: # subtitle: # title: # alignment: # bg_color: # category: # chart_heading_level: # chart_info_display: # coverpage_background_image: # coverpage_bottom_image: # coverpage_custom_text1: # coverpage_custom_text2: # coverpage_enable_create_time: # coverpage_enable_time_period: # coverpage_footer_bgcolor: # coverpage_footer_left: # coverpage_footer_right: # coverpage_text_color: # coverpage_title: # coverpage_top_image: # coverpage_top_image_position: # dev_type: # folder_id: # font_color: # font_family: # font_size: # font_type: # footer_bgcolor: # header_bgcolor: # hide_report_title: # hide_rowid: # include_empty_charts: # is_template: # left_margin: # protected: # report_tag: # right_margin: # folders: # - folder_id: 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: .. raw:: html
  • 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)