EVOLUTION-MANAGER

Edit File: fortios_report_style.py

#!/usr/bin/python
from __future__ import (absolute_import, division, print_function)
# Copyright 2019 Fortinet, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

__metaclass__ = type

ANSIBLE_METADATA = {'status': ['preview'],
                    'supported_by': 'community',
                    'metadata_version': '1.1'}

DOCUMENTATION = '''
---
module: fortios_report_style
short_description: Report style configuration in Fortinet's FortiOS and FortiGate.
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.5
version_added: "2.8"
author:
    - Miguel Angel Munoz (@mamunozgonzalez)
    - Nicolas Thomas (@thomnico)
notes:
    - Requires fortiosapi library developed by Fortinet
    - Run as a local_action in your playbook
requirements:
    - fortiosapi>=0.9.8
options:
    host:
        description:
            - FortiOS or FortiGate IP address.
        type: str
        required: false
    username:
        description:
            - FortiOS or FortiGate username.
        type: str
        required: false
    password:
        description:
            - FortiOS or FortiGate password.
        type: str
        default: ""
    vdom:
        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
        default: root
    https:
        description:
            - Indicates if the requests towards FortiGate must use HTTPS protocol.
        type: bool
        default: true
    ssl_verify:
        description:
            - Ensures FortiGate certificate must be verified by a proper CA.
        type: bool
        default: true
        version_added: 2.9
    state:
        description:
            - Indicates whether to create or remove the object.
              This attribute was present already in previous version in a deeper level.
              It has been moved out to this outer level.
        type: str
        required: false
        choices:
            - present
            - absent
        version_added: 2.9
    report_style:
        description:
            - Report style configuration.
        default: null
        type: dict
        suboptions:
            state:
                description:
                    - B(Deprecated)
                    - Starting with Ansible 2.9 we recommend using the top-level 'state' parameter.
                    - HORIZONTALLINE
                    - Indicates whether to create or remove the object.
                type: str
                required: false
                choices:
                    - present
                    - absent
            align:
                description:
                    - Alignment.
                type: str
                choices:
                    - left
                    - center
                    - right
                    - justify
            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:
                description:
                    - Column span.
                type: str
                choices:
                    - none
                    - all
            fg_color:
                description:
                    - Foreground color.
                type: str
            font_family:
                description:
                    - Font family.
                type: str
                choices:
                    - Verdana
                    - Arial
                    - Helvetica
                    - Courier
                    - Times
            font_size:
                description:
                    - Font size.
                type: str
            font_style:
                description:
                    - Font style.
                type: str
                choices:
                    - normal
                    - italic
            font_weight:
                description:
                    - Font weight.
                type: str
                choices:
                    - normal
                    - bold
            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:
                description:
                    - Report style options.
                type: str
                choices:
                    - font
                    - text
                    - color
                    - align
                    - size
                    - margin
                    - border
                    - padding
                    - column
            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
'''

EXAMPLES = '''
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Report style configuration.
    fortios_report_style:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      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>"
'''

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

'''

from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.connection import Connection
from ansible.module_utils.network.fortios.fortios import FortiOSHandler
from ansible.module_utils.network.fortimanager.common import FAIL_SOCKET_MSG

def login(data, fos):
    host = data['host']
    username = data['username']
    password = data['password']
    ssl_verify = data['ssl_verify']

fos.debug('on')
    if 'https' in data and not data['https']:
        fos.https('off')
    else:
        fos.https('on')

fos.login(host, username, password, verify=ssl_verify)

def filter_report_style_data(json):
    option_list = ['align', 'bg_color', 'border_bottom',
                   'border_left', 'border_right', 'border_top',
                   'column_gap', 'column_span', 'fg_color',
                   'font_family', 'font_size', 'font_style',
                   'font_weight', 'height', 'line_height',
                   'margin_bottom', 'margin_left', 'margin_right',
                   'margin_top', 'name', 'options',
                   'padding_bottom', 'padding_left', 'padding_right',
                   'padding_top', 'width']
    dictionary = {}

for attribute in option_list:
        if attribute in json and json[attribute] is not None:
            dictionary[attribute] = json[attribute]

return dictionary

def underscore_to_hyphen(data):
    if isinstance(data, list):
        for elem in data:
            elem = underscore_to_hyphen(elem)
    elif isinstance(data, dict):
        new_data = {}
        for k, v in data.items():
            new_data[k.replace('_', '-')] = underscore_to_hyphen(v)
        data = new_data

return data

def report_style(data, fos):
    vdom = data['vdom']
    if 'state' in data and data['state']:
        state = data['state']
    elif 'state' in data['report_style'] and data['report_style']:
        state = data['report_style']['state']
    else:
        state = True
    report_style_data = data['report_style']
    filtered_data = underscore_to_hyphen(filter_report_style_data(report_style_data))

if state == "present":
        return fos.set('report',
                       'style',
                       data=filtered_data,
                       vdom=vdom)

elif state == "absent":
        return fos.delete('report',
                          'style',
                          mkey=filtered_data['name'],
                          vdom=vdom)

def is_successful_status(status):
    return status['status'] == "success" or \
        status['http_method'] == "DELETE" and status['http_status'] == 404

def fortios_report(data, fos):

if data['report_style']:
        resp = report_style(data, fos)

return not is_successful_status(resp), \
        resp['status'] == "success", \
        resp

def main():
    fields = {
        "host": {"required": False, "type": "str"},
        "username": {"required": False, "type": "str"},
        "password": {"required": False, "type": "str", "default": "", "no_log": True},
        "vdom": {"required": False, "type": "str", "default": "root"},
        "https": {"required": False, "type": "bool", "default": True},
        "ssl_verify": {"required": False, "type": "bool", "default": True},
        "state": {"required": False, "type": "str",
                  "choices": ["present", "absent"]},
        "report_style": {
            "required": False, "type": "dict", "default": None,
            "options": {
                "state": {"required": False, "type": "str",
                          "choices": ["present", "absent"]},
                "align": {"required": False, "type": "str",
                          "choices": ["left", "center", "right",
                                      "justify"]},
                "bg_color": {"required": False, "type": "str"},
                "border_bottom": {"required": False, "type": "str"},
                "border_left": {"required": False, "type": "str"},
                "border_right": {"required": False, "type": "str"},
                "border_top": {"required": False, "type": "str"},
                "column_gap": {"required": False, "type": "str"},
                "column_span": {"required": False, "type": "str",
                                "choices": ["none", "all"]},
                "fg_color": {"required": False, "type": "str"},
                "font_family": {"required": False, "type": "str",
                                "choices": ["Verdana", "Arial", "Helvetica",
                                            "Courier", "Times"]},
                "font_size": {"required": False, "type": "str"},
                "font_style": {"required": False, "type": "str",
                               "choices": ["normal", "italic"]},
                "font_weight": {"required": False, "type": "str",
                                "choices": ["normal", "bold"]},
                "height": {"required": False, "type": "str"},
                "line_height": {"required": False, "type": "str"},
                "margin_bottom": {"required": False, "type": "str"},
                "margin_left": {"required": False, "type": "str"},
                "margin_right": {"required": False, "type": "str"},
                "margin_top": {"required": False, "type": "str"},
                "name": {"required": True, "type": "str"},
                "options": {"required": False, "type": "str",
                            "choices": ["font", "text", "color",
                                        "align", "size", "margin",
                                        "border", "padding", "column"]},
                "padding_bottom": {"required": False, "type": "str"},
                "padding_left": {"required": False, "type": "str"},
                "padding_right": {"required": False, "type": "str"},
                "padding_top": {"required": False, "type": "str"},
                "width": {"required": False, "type": "str"}

}
        }
    }

module = AnsibleModule(argument_spec=fields,
                           supports_check_mode=False)

# legacy_mode refers to using fortiosapi instead of HTTPAPI
    legacy_mode = 'host' in module.params and module.params['host'] is not None and \
                  'username' in module.params and module.params['username'] is not None and \
                  'password' in module.params and module.params['password'] is not None

if not legacy_mode:
        if module._socket_path:
            connection = Connection(module._socket_path)
            fos = FortiOSHandler(connection)

is_error, has_changed, result = fortios_report(module.params, fos)
        else:
            module.fail_json(**FAIL_SOCKET_MSG)
    else:
        try:
            from fortiosapi import FortiOSAPI
        except ImportError:
            module.fail_json(msg="fortiosapi module is required")

fos = FortiOSAPI()

login(module.params, fos)
        is_error, has_changed, result = fortios_report(module.params, fos)
        fos.logout()

if not is_error:
        module.exit_json(changed=has_changed, meta=result)
    else:
        module.fail_json(msg="Error in repo", meta=result)

if __name__ == '__main__':
    main()