Fortinet's FortiOS report dataset (#52330)
This commit is contained in:
Miguel Angel Muñoz González
John R Barker
parent
4abdd37330
commit
f083cb5ebe
1 changed files with 360 additions and 0 deletions
360
lib/ansible/modules/network/fortios/fortios_report_dataset.py
Normal file
360
lib/ansible/modules/network/fortios/fortios_report_dataset.py
Normal file
|
|
@ -0,0 +1,360 @@
|
||||||
|
#!/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/>.
|
||||||
|
#
|
||||||
|
# the lib use python logging can get it if the following is set in your
|
||||||
|
# Ansible config.
|
||||||
|
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
ANSIBLE_METADATA = {'status': ['preview'],
|
||||||
|
'supported_by': 'community',
|
||||||
|
'metadata_version': '1.1'}
|
||||||
|
|
||||||
|
DOCUMENTATION = '''
|
||||||
|
---
|
||||||
|
module: fortios_report_dataset
|
||||||
|
short_description: Report dataset configuration in Fortinet's FortiOS and FortiGate.
|
||||||
|
description:
|
||||||
|
- This module is able to configure a FortiGate or FortiOS 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.2
|
||||||
|
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.
|
||||||
|
required: true
|
||||||
|
username:
|
||||||
|
description:
|
||||||
|
- FortiOS or FortiGate username.
|
||||||
|
required: true
|
||||||
|
password:
|
||||||
|
description:
|
||||||
|
- FortiOS or FortiGate password.
|
||||||
|
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.
|
||||||
|
default: root
|
||||||
|
https:
|
||||||
|
description:
|
||||||
|
- Indicates if the requests towards FortiGate must use HTTPS
|
||||||
|
protocol
|
||||||
|
type: bool
|
||||||
|
default: true
|
||||||
|
report_dataset:
|
||||||
|
description:
|
||||||
|
- Report dataset configuration.
|
||||||
|
default: null
|
||||||
|
suboptions:
|
||||||
|
state:
|
||||||
|
description:
|
||||||
|
- Indicates whether to create or remove the object
|
||||||
|
choices:
|
||||||
|
- present
|
||||||
|
- absent
|
||||||
|
field:
|
||||||
|
description:
|
||||||
|
- Fields.
|
||||||
|
suboptions:
|
||||||
|
displayname:
|
||||||
|
description:
|
||||||
|
- Display name.
|
||||||
|
id:
|
||||||
|
description:
|
||||||
|
- Field ID (1 to number of columns in SQL result).
|
||||||
|
required: true
|
||||||
|
name:
|
||||||
|
description:
|
||||||
|
- Name.
|
||||||
|
type:
|
||||||
|
description:
|
||||||
|
- Field type.
|
||||||
|
choices:
|
||||||
|
- text
|
||||||
|
- integer
|
||||||
|
- double
|
||||||
|
name:
|
||||||
|
description:
|
||||||
|
- Name.
|
||||||
|
required: true
|
||||||
|
parameters:
|
||||||
|
description:
|
||||||
|
- Parameters.
|
||||||
|
suboptions:
|
||||||
|
data-type:
|
||||||
|
description:
|
||||||
|
- Data type.
|
||||||
|
choices:
|
||||||
|
- text
|
||||||
|
- integer
|
||||||
|
- double
|
||||||
|
- long-integer
|
||||||
|
- date-time
|
||||||
|
display-name:
|
||||||
|
description:
|
||||||
|
- Display name.
|
||||||
|
field:
|
||||||
|
description:
|
||||||
|
- SQL field name.
|
||||||
|
id:
|
||||||
|
description:
|
||||||
|
- Parameter ID (1 to number of columns in SQL result).
|
||||||
|
required: true
|
||||||
|
policy:
|
||||||
|
description:
|
||||||
|
- Used by monitor policy.
|
||||||
|
query:
|
||||||
|
description:
|
||||||
|
- SQL query statement.
|
||||||
|
'''
|
||||||
|
|
||||||
|
EXAMPLES = '''
|
||||||
|
- hosts: localhost
|
||||||
|
vars:
|
||||||
|
host: "192.168.122.40"
|
||||||
|
username: "admin"
|
||||||
|
password: ""
|
||||||
|
vdom: "root"
|
||||||
|
tasks:
|
||||||
|
- name: Report dataset configuration.
|
||||||
|
fortios_report_dataset:
|
||||||
|
host: "{{ host }}"
|
||||||
|
username: "{{ username }}"
|
||||||
|
password: "{{ password }}"
|
||||||
|
vdom: "{{ vdom }}"
|
||||||
|
https: "False"
|
||||||
|
report_dataset:
|
||||||
|
state: "present"
|
||||||
|
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: "14"
|
||||||
|
query: "<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
|
||||||
|
|
||||||
|
fos = None
|
||||||
|
|
||||||
|
|
||||||
|
def login(data):
|
||||||
|
host = data['host']
|
||||||
|
username = data['username']
|
||||||
|
password = data['password']
|
||||||
|
|
||||||
|
fos.debug('on')
|
||||||
|
if 'https' in data and not data['https']:
|
||||||
|
fos.https('off')
|
||||||
|
else:
|
||||||
|
fos.https('on')
|
||||||
|
|
||||||
|
fos.login(host, username, password)
|
||||||
|
|
||||||
|
|
||||||
|
def filter_report_dataset_data(json):
|
||||||
|
option_list = ['field', 'name', 'parameters',
|
||||||
|
'policy', 'query']
|
||||||
|
dictionary = {}
|
||||||
|
|
||||||
|
for attribute in option_list:
|
||||||
|
if attribute in json and json[attribute] is not None:
|
||||||
|
dictionary[attribute] = json[attribute]
|
||||||
|
|
||||||
|
return dictionary
|
||||||
|
|
||||||
|
|
||||||
|
def flatten_multilists_attributes(data):
|
||||||
|
multilist_attrs = []
|
||||||
|
|
||||||
|
for attr in multilist_attrs:
|
||||||
|
try:
|
||||||
|
path = "data['" + "']['".join(elem for elem in attr) + "']"
|
||||||
|
current_val = eval(path)
|
||||||
|
flattened_val = ' '.join(elem for elem in current_val)
|
||||||
|
exec(path + '= flattened_val')
|
||||||
|
except BaseException:
|
||||||
|
pass
|
||||||
|
|
||||||
|
return data
|
||||||
|
|
||||||
|
|
||||||
|
def report_dataset(data, fos):
|
||||||
|
vdom = data['vdom']
|
||||||
|
report_dataset_data = data['report_dataset']
|
||||||
|
flattened_data = flatten_multilists_attributes(report_dataset_data)
|
||||||
|
filtered_data = filter_report_dataset_data(flattened_data)
|
||||||
|
if report_dataset_data['state'] == "present":
|
||||||
|
return fos.set('report',
|
||||||
|
'dataset',
|
||||||
|
data=filtered_data,
|
||||||
|
vdom=vdom)
|
||||||
|
|
||||||
|
elif report_dataset_data['state'] == "absent":
|
||||||
|
return fos.delete('report',
|
||||||
|
'dataset',
|
||||||
|
mkey=filtered_data['name'],
|
||||||
|
vdom=vdom)
|
||||||
|
|
||||||
|
|
||||||
|
def fortios_report(data, fos):
|
||||||
|
login(data)
|
||||||
|
|
||||||
|
if data['report_dataset']:
|
||||||
|
resp = report_dataset(data, fos)
|
||||||
|
|
||||||
|
fos.logout()
|
||||||
|
return not resp['status'] == "success", resp['status'] == "success", resp
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
fields = {
|
||||||
|
"host": {"required": True, "type": "str"},
|
||||||
|
"username": {"required": True, "type": "str"},
|
||||||
|
"password": {"required": False, "type": "str", "no_log": True},
|
||||||
|
"vdom": {"required": False, "type": "str", "default": "root"},
|
||||||
|
"https": {"required": False, "type": "bool", "default": True},
|
||||||
|
"report_dataset": {
|
||||||
|
"required": False, "type": "dict",
|
||||||
|
"options": {
|
||||||
|
"state": {"required": True, "type": "str",
|
||||||
|
"choices": ["present", "absent"]},
|
||||||
|
"field": {"required": False, "type": "list",
|
||||||
|
"options": {
|
||||||
|
"displayname": {"required": False, "type": "str"},
|
||||||
|
"id": {"required": True, "type": "int"},
|
||||||
|
"name": {"required": False, "type": "str"},
|
||||||
|
"type": {"required": False, "type": "str",
|
||||||
|
"choices": ["text", "integer", "double"]}
|
||||||
|
}},
|
||||||
|
"name": {"required": True, "type": "str"},
|
||||||
|
"parameters": {"required": False, "type": "list",
|
||||||
|
"options": {
|
||||||
|
"data-type": {"required": False, "type": "str",
|
||||||
|
"choices": ["text", "integer", "double",
|
||||||
|
"long-integer", "date-time"]},
|
||||||
|
"display-name": {"required": False, "type": "str"},
|
||||||
|
"field": {"required": False, "type": "str"},
|
||||||
|
"id": {"required": True, "type": "int"}
|
||||||
|
}},
|
||||||
|
"policy": {"required": False, "type": "int"},
|
||||||
|
"query": {"required": False, "type": "str"}
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
module = AnsibleModule(argument_spec=fields,
|
||||||
|
supports_check_mode=False)
|
||||||
|
try:
|
||||||
|
from fortiosapi import FortiOSAPI
|
||||||
|
except ImportError:
|
||||||
|
module.fail_json(msg="fortiosapi module is required")
|
||||||
|
|
||||||
|
global fos
|
||||||
|
fos = FortiOSAPI()
|
||||||
|
|
||||||
|
is_error, has_changed, result = fortios_report(module.params, fos)
|
||||||
|
|
||||||
|
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()
|
||||||
Loading…
Reference in a new issue