cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Fortinet's new module for fortios_system_automation_action (#60797)

Browse source
This commit is contained in:
Miguel Angel Muñoz González 2019-08-20 12:37:41 +02:00 committed by Nilashish Chakraborty
parent 2013f5e728
commit bef8a682d7
2 changed files with 828 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

469
lib/ansible/modules/network/fortios/fortios_system_automation_action.py Normal file
View file

@ -0,0 +1,469 @@
#!/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_system_automation_action
short_description: Action for automation stitches in Fortinet's FortiOS and FortiGate.
description:
- This module is able to configure a FortiGate or FortiOS device by allowing the
user to set and modify system feature and automation_action category.
Examples include all parameters and values need to be adjusted to datasources before usage.
Tested with FOS v6.0.5
version_added: "2.9"
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
state:
description:
- Indicates whether to create or remove the object.
type: str
choices:
- present
- absent
system_automation_action:
description:
- Action for automation stitches.
default: null
type: dict
suboptions:
action_type:
description:
- Action type.
type: str
choices:
- email
- ios-notification
- alert
- disable-ssid
- quarantine
- quarantine-forticlient
- ban-ip
- aws-lambda
- webhook
aws_api_id:
description:
- AWS API Gateway ID.
type: str
aws_api_key:
description:
- AWS API Gateway API key.
type: str
aws_api_path:
description:
- AWS API Gateway path.
type: str
aws_api_stage:
description:
- AWS API Gateway deployment stage name.
type: str
aws_domain:
description:
- AWS domain.
type: str
aws_region:
description:
- AWS region.
type: str
delay:
description:
- Delay before execution (in seconds).
type: int
email_subject:
description:
- Email subject.
type: str
email_to:
description:
- Email addresses.
type: list
suboptions:
name:
description:
- Email address.
required: true
type: str
headers:
description:
- Request headers.
type: list
suboptions:
header:
description:
- Request header.
required: true
type: str
http_body:
description:
- Request body (if necessary). Should be serialized json string.
type: str
method:
description:
- Request method (GET, POST or PUT).
type: str
choices:
- post
- put
- get
minimum_interval:
description:
- Limit execution to no more than once in this interval (in seconds).
type: int
name:
description:
- Name.
required: true
type: str
port:
description:
- Protocol port.
type: int
protocol:
description:
- Request protocol.
type: str
choices:
- http
- https
required:
description:
- Required in action chain.
type: str
choices:
- enable
- disable
uri:
description:
- Request API URI.
type: str
'''
EXAMPLES = '''
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Action for automation stitches.
fortios_system_automation_action:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
state: "present"
system_automation_action:
action_type: "email"
aws_api_id: "<your_own_value>"
aws_api_key: "<your_own_value>"
aws_api_path: "<your_own_value>"
aws_api_stage: "<your_own_value>"
aws_domain: "<your_own_value>"
aws_region: "<your_own_value>"
delay: "10"
email_subject: "<your_own_value>"
email_to:
-
name: "default_name_13"
headers:
-
header: "<your_own_value>"
http_body: "<your_own_value>"
method: "post"
minimum_interval: "18"
name: "default_name_19"
port: "20"
protocol: "http"
required: "enable"
uri: "<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_system_automation_action_data(json):
option_list = ['action_type', 'aws_api_id', 'aws_api_key',
'aws_api_path', 'aws_api_stage', 'aws_domain',
'aws_region', 'delay', 'email_subject',
'email_to', 'headers', 'http_body',
'method', 'minimum_interval', 'name',
'port', 'protocol', 'required',
'uri']
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 system_automation_action(data, fos):
vdom = data['vdom']
state = data['state']
system_automation_action_data = data['system_automation_action']
filtered_data = underscore_to_hyphen(filter_system_automation_action_data(system_automation_action_data))
if state == "present":
return fos.set('system',
'automation-action',
data=filtered_data,
vdom=vdom)
elif state == "absent":
return fos.delete('system',
'automation-action',
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_system(data, fos):
if data['system_automation_action']:
resp = system_automation_action(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", "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": True, "type": "str",
"choices": ["present", "absent"]},
"system_automation_action": {
"required": False, "type": "dict", "default": None,
"options": {
"action_type": {"required": False, "type": "str",
"choices": ["email", "ios-notification", "alert",
"disable-ssid", "quarantine", "quarantine-forticlient",
"ban-ip", "aws-lambda", "webhook"]},
"aws_api_id": {"required": False, "type": "str"},
"aws_api_key": {"required": False, "type": "str"},
"aws_api_path": {"required": False, "type": "str"},
"aws_api_stage": {"required": False, "type": "str"},
"aws_domain": {"required": False, "type": "str"},
"aws_region": {"required": False, "type": "str"},
"delay": {"required": False, "type": "int"},
"email_subject": {"required": False, "type": "str"},
"email_to": {"required": False, "type": "list",
"options": {
"name": {"required": True, "type": "str"}
}},
"headers": {"required": False, "type": "list",
"options": {
"header": {"required": True, "type": "str"}
}},
"http_body": {"required": False, "type": "str"},
"method": {"required": False, "type": "str",
"choices": ["post", "put", "get"]},
"minimum_interval": {"required": False, "type": "int"},
"name": {"required": True, "type": "str"},
"port": {"required": False, "type": "int"},
"protocol": {"required": False, "type": "str",
"choices": ["http", "https"]},
"required": {"required": False, "type": "str",
"choices": ["enable", "disable"]},
"uri": {"required": False, "type": "str"}
}
}
}
module = AnsibleModule(argument_spec=fields,
supports_check_mode=False)
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_system(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_system(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()

359
test/units/modules/network/fortios/test_fortios_system_automation_action.py Normal file
View file

@ -0,0 +1,359 @@
# 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 Ansible. If not, see <https://www.gnu.org/licenses/>.
# Make coding more python3-ish
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
import os
import json
import pytest
from mock import ANY
from ansible.module_utils.network.fortios.fortios import FortiOSHandler
try:
from ansible.modules.network.fortios import fortios_system_automation_action
except ImportError:
pytest.skip("Could not load required modules for testing", allow_module_level=True)
@pytest.fixture(autouse=True)
def connection_mock(mocker):
connection_class_mock = mocker.patch('ansible.modules.network.fortios.fortios_system_automation_action.Connection')
return connection_class_mock
fos_instance = FortiOSHandler(connection_mock)
def test_system_automation_action_creation(mocker):
schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema')
set_method_result = {'status': 'success', 'http_method': 'POST', 'http_status': 200}
set_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.set', return_value=set_method_result)
input_data = {
'username': 'admin',
'state': 'present',
'system_automation_action': {
'action_type': 'email',
'aws_api_id': 'test_value_4',
'aws_api_key': 'test_value_5',
'aws_api_path': 'test_value_6',
'aws_api_stage': 'test_value_7',
'aws_domain': 'test_value_8',
'aws_region': 'test_value_9',
'delay': '10',
'email_subject': 'test_value_11',
'http_body': 'test_value_12',
'method': 'post',
'minimum_interval': '14',
'name': 'default_name_15',
'port': '16',
'protocol': 'http',
'required': 'enable',
'uri': 'test_value_19'
},
'vdom': 'root'}
is_error, changed, response = fortios_system_automation_action.fortios_system(input_data, fos_instance)
expected_data = {
'action-type': 'email',
'aws-api-id': 'test_value_4',
'aws-api-key': 'test_value_5',
'aws-api-path': 'test_value_6',
'aws-api-stage': 'test_value_7',
'aws-domain': 'test_value_8',
'aws-region': 'test_value_9',
'delay': '10',
'email-subject': 'test_value_11',
'http-body': 'test_value_12',
'method': 'post',
'minimum-interval': '14',
'name': 'default_name_15',
'port': '16',
'protocol': 'http',
'required': 'enable',
'uri': 'test_value_19'
}
set_method_mock.assert_called_with('system', 'automation-action', data=expected_data, vdom='root')
schema_method_mock.assert_not_called()
assert not is_error
assert changed
assert response['status'] == 'success'
assert response['http_status'] == 200
def test_system_automation_action_creation_fails(mocker):
schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema')
set_method_result = {'status': 'error', 'http_method': 'POST', 'http_status': 500}
set_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.set', return_value=set_method_result)
input_data = {
'username': 'admin',
'state': 'present',
'system_automation_action': {
'action_type': 'email',
'aws_api_id': 'test_value_4',
'aws_api_key': 'test_value_5',
'aws_api_path': 'test_value_6',
'aws_api_stage': 'test_value_7',
'aws_domain': 'test_value_8',
'aws_region': 'test_value_9',
'delay': '10',
'email_subject': 'test_value_11',
'http_body': 'test_value_12',
'method': 'post',
'minimum_interval': '14',
'name': 'default_name_15',
'port': '16',
'protocol': 'http',
'required': 'enable',
'uri': 'test_value_19'
},
'vdom': 'root'}
is_error, changed, response = fortios_system_automation_action.fortios_system(input_data, fos_instance)
expected_data = {
'action-type': 'email',
'aws-api-id': 'test_value_4',
'aws-api-key': 'test_value_5',
'aws-api-path': 'test_value_6',
'aws-api-stage': 'test_value_7',
'aws-domain': 'test_value_8',
'aws-region': 'test_value_9',
'delay': '10',
'email-subject': 'test_value_11',
'http-body': 'test_value_12',
'method': 'post',
'minimum-interval': '14',
'name': 'default_name_15',
'port': '16',
'protocol': 'http',
'required': 'enable',
'uri': 'test_value_19'
}
set_method_mock.assert_called_with('system', 'automation-action', data=expected_data, vdom='root')
schema_method_mock.assert_not_called()
assert is_error
assert not changed
assert response['status'] == 'error'
assert response['http_status'] == 500
def test_system_automation_action_removal(mocker):
schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema')
delete_method_result = {'status': 'success', 'http_method': 'POST', 'http_status': 200}
delete_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.delete', return_value=delete_method_result)
input_data = {
'username': 'admin',
'state': 'absent',
'system_automation_action': {
'action_type': 'email',
'aws_api_id': 'test_value_4',
'aws_api_key': 'test_value_5',
'aws_api_path': 'test_value_6',
'aws_api_stage': 'test_value_7',
'aws_domain': 'test_value_8',
'aws_region': 'test_value_9',
'delay': '10',
'email_subject': 'test_value_11',
'http_body': 'test_value_12',
'method': 'post',
'minimum_interval': '14',
'name': 'default_name_15',
'port': '16',
'protocol': 'http',
'required': 'enable',
'uri': 'test_value_19'
},
'vdom': 'root'}
is_error, changed, response = fortios_system_automation_action.fortios_system(input_data, fos_instance)
delete_method_mock.assert_called_with('system', 'automation-action', mkey=ANY, vdom='root')
schema_method_mock.assert_not_called()
assert not is_error
assert changed
assert response['status'] == 'success'
assert response['http_status'] == 200
def test_system_automation_action_deletion_fails(mocker):
schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema')
delete_method_result = {'status': 'error', 'http_method': 'POST', 'http_status': 500}
delete_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.delete', return_value=delete_method_result)
input_data = {
'username': 'admin',
'state': 'absent',
'system_automation_action': {
'action_type': 'email',
'aws_api_id': 'test_value_4',
'aws_api_key': 'test_value_5',
'aws_api_path': 'test_value_6',
'aws_api_stage': 'test_value_7',
'aws_domain': 'test_value_8',
'aws_region': 'test_value_9',
'delay': '10',
'email_subject': 'test_value_11',
'http_body': 'test_value_12',
'method': 'post',
'minimum_interval': '14',
'name': 'default_name_15',
'port': '16',
'protocol': 'http',
'required': 'enable',
'uri': 'test_value_19'
},
'vdom': 'root'}
is_error, changed, response = fortios_system_automation_action.fortios_system(input_data, fos_instance)
delete_method_mock.assert_called_with('system', 'automation-action', mkey=ANY, vdom='root')
schema_method_mock.assert_not_called()
assert is_error
assert not changed
assert response['status'] == 'error'
assert response['http_status'] == 500
def test_system_automation_action_idempotent(mocker):
schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema')
set_method_result = {'status': 'error', 'http_method': 'DELETE', 'http_status': 404}
set_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.set', return_value=set_method_result)
input_data = {
'username': 'admin',
'state': 'present',
'system_automation_action': {
'action_type': 'email',
'aws_api_id': 'test_value_4',
'aws_api_key': 'test_value_5',
'aws_api_path': 'test_value_6',
'aws_api_stage': 'test_value_7',
'aws_domain': 'test_value_8',
'aws_region': 'test_value_9',
'delay': '10',
'email_subject': 'test_value_11',
'http_body': 'test_value_12',
'method': 'post',
'minimum_interval': '14',
'name': 'default_name_15',
'port': '16',
'protocol': 'http',
'required': 'enable',
'uri': 'test_value_19'
},
'vdom': 'root'}
is_error, changed, response = fortios_system_automation_action.fortios_system(input_data, fos_instance)
expected_data = {
'action-type': 'email',
'aws-api-id': 'test_value_4',
'aws-api-key': 'test_value_5',
'aws-api-path': 'test_value_6',
'aws-api-stage': 'test_value_7',
'aws-domain': 'test_value_8',
'aws-region': 'test_value_9',
'delay': '10',
'email-subject': 'test_value_11',
'http-body': 'test_value_12',
'method': 'post',
'minimum-interval': '14',
'name': 'default_name_15',
'port': '16',
'protocol': 'http',
'required': 'enable',
'uri': 'test_value_19'
}
set_method_mock.assert_called_with('system', 'automation-action', data=expected_data, vdom='root')
schema_method_mock.assert_not_called()
assert not is_error
assert not changed
assert response['status'] == 'error'
assert response['http_status'] == 404
def test_system_automation_action_filter_foreign_attributes(mocker):
schema_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.schema')
set_method_result = {'status': 'success', 'http_method': 'POST', 'http_status': 200}
set_method_mock = mocker.patch('ansible.module_utils.network.fortios.fortios.FortiOSHandler.set', return_value=set_method_result)
input_data = {
'username': 'admin',
'state': 'present',
'system_automation_action': {
'random_attribute_not_valid': 'tag',
'action_type': 'email',
'aws_api_id': 'test_value_4',
'aws_api_key': 'test_value_5',
'aws_api_path': 'test_value_6',
'aws_api_stage': 'test_value_7',
'aws_domain': 'test_value_8',
'aws_region': 'test_value_9',
'delay': '10',
'email_subject': 'test_value_11',
'http_body': 'test_value_12',
'method': 'post',
'minimum_interval': '14',
'name': 'default_name_15',
'port': '16',
'protocol': 'http',
'required': 'enable',
'uri': 'test_value_19'
},
'vdom': 'root'}
is_error, changed, response = fortios_system_automation_action.fortios_system(input_data, fos_instance)
expected_data = {
'action-type': 'email',
'aws-api-id': 'test_value_4',
'aws-api-key': 'test_value_5',
'aws-api-path': 'test_value_6',
'aws-api-stage': 'test_value_7',
'aws-domain': 'test_value_8',
'aws-region': 'test_value_9',
'delay': '10',
'email-subject': 'test_value_11',
'http-body': 'test_value_12',
'method': 'post',
'minimum-interval': '14',
'name': 'default_name_15',
'port': '16',
'protocol': 'http',
'required': 'enable',
'uri': 'test_value_19'
}
set_method_mock.assert_called_with('system', 'automation-action', data=expected_data, vdom='root')
schema_method_mock.assert_not_called()
assert not is_error
assert changed
assert response['status'] == 'success'
assert response['http_status'] == 200