lix_fortinet.fortios.fortios_report_style (102.2.120) — module

Report style configuration in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of lix_fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120


Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify report feature and style category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Report style configuration.
    fortios_report_style:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      report_style:
        align: "left"
        bg_color: "<your_own_value>"
        border_bottom: "<your_own_value>"
        border_left: "<your_own_value>"
        border_right: "<your_own_value>"
        border_top: "<your_own_value>"
        column_gap: "<your_own_value>"
        column_span: "none"
        fg_color: "<your_own_value>"
        font_family: "Verdana"
        font_size: "<your_own_value>"
        font_style: "normal"
        font_weight: "normal"
        height: "<your_own_value>"
        line_height: "<your_own_value>"
        margin_bottom: "<your_own_value>"
        margin_left: "<your_own_value>"
        margin_right: "<your_own_value>"
        margin_top: "<your_own_value>"
        name: "default_name_22"
        options: "font"
        padding_bottom: "<your_own_value>"
        padding_left: "<your_own_value>"
        padding_right: "<your_own_value>"
        padding_top: "<your_own_value>"
        width: "<your_own_value>"

Inputs

    
vdom:
    default: root
    description:
    - 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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

report_style:
    default: null
    description:
    - Report style configuration.
    suboptions:
      align:
        choices:
        - left
        - center
        - right
        - justify
        description:
        - Alignment.
        type: str
      bg_color:
        description:
        - Background color.
        type: str
      border_bottom:
        description:
        - Border bottom.
        type: str
      border_left:
        description:
        - Border left.
        type: str
      border_right:
        description:
        - Border right.
        type: str
      border_top:
        description:
        - Border top.
        type: str
      column_gap:
        description:
        - Column gap.
        type: str
      column_span:
        choices:
        - none
        - all
        description:
        - Column span.
        type: str
      fg_color:
        description:
        - Foreground color.
        type: str
      font_family:
        choices:
        - Verdana
        - Arial
        - Helvetica
        - Courier
        - Times
        description:
        - Font family.
        type: str
      font_size:
        description:
        - Font size.
        type: str
      font_style:
        choices:
        - normal
        - italic
        description:
        - Font style.
        type: str
      font_weight:
        choices:
        - normal
        - bold
        description:
        - Font weight.
        type: str
      height:
        description:
        - Height.
        type: str
      line_height:
        description:
        - Text line height.
        type: str
      margin_bottom:
        description:
        - Margin bottom.
        type: str
      margin_left:
        description:
        - Margin left.
        type: str
      margin_right:
        description:
        - Margin right.
        type: str
      margin_top:
        description:
        - Margin top.
        type: str
      name:
        description:
        - Report style name.
        required: true
        type: str
      options:
        choices:
        - font
        - text
        - color
        - align
        - size
        - margin
        - border
        - padding
        - column
        description:
        - Report style options.
        elements: str
        type: list
      padding_bottom:
        description:
        - Padding bottom.
        type: str
      padding_left:
        description:
        - Padding left.
        type: str
      padding_right:
        description:
        - Padding right.
        type: str
      padding_top:
        description:
        - Padding top.
        type: str
      width:
        description:
        - Width.
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str