Fortinet's FortiOS router policy (#52405)
This commit is contained in:
Miguel Angel Muñoz González
John R Barker
parent
241857c11f
commit
c2c595d6b0
1 changed files with 443 additions and 0 deletions
443
lib/ansible/modules/network/fortios/fortios_router_policy.py
Normal file
443
lib/ansible/modules/network/fortios/fortios_router_policy.py
Normal file
|
|
@ -0,0 +1,443 @@
|
|||
#!/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_router_policy
|
||||
short_description: Configure IPv4 routing policies 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 router feature and policy 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
|
||||
router_policy:
|
||||
description:
|
||||
- Configure IPv4 routing policies.
|
||||
default: null
|
||||
suboptions:
|
||||
state:
|
||||
description:
|
||||
- Indicates whether to create or remove the object
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
action:
|
||||
description:
|
||||
- Action of the policy route.
|
||||
choices:
|
||||
- deny
|
||||
- permit
|
||||
comments:
|
||||
description:
|
||||
- Optional comments.
|
||||
dst:
|
||||
description:
|
||||
- Destination IP and mask (x.x.x.x/x).
|
||||
suboptions:
|
||||
subnet:
|
||||
description:
|
||||
- IP and mask.
|
||||
required: true
|
||||
dst-negate:
|
||||
description:
|
||||
- Enable/disable negating destination address match.
|
||||
choices:
|
||||
- enable
|
||||
- disable
|
||||
dstaddr:
|
||||
description:
|
||||
- Destination address name.
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
- Address/group name. Source firewall.address.name firewall.addrgrp.name.
|
||||
required: true
|
||||
end-port:
|
||||
description:
|
||||
- End destination port number (0 - 65535).
|
||||
end-source-port:
|
||||
description:
|
||||
- End source port number (0 - 65535).
|
||||
gateway:
|
||||
description:
|
||||
- IP address of the gateway.
|
||||
input-device:
|
||||
description:
|
||||
- Incoming interface name.
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
- Interface name. Source system.interface.name.
|
||||
required: true
|
||||
output-device:
|
||||
description:
|
||||
- Outgoing interface name. Source system.interface.name.
|
||||
protocol:
|
||||
description:
|
||||
- Protocol number (0 - 255).
|
||||
seq-num:
|
||||
description:
|
||||
- Sequence number.
|
||||
required: true
|
||||
src:
|
||||
description:
|
||||
- Source IP and mask (x.x.x.x/x).
|
||||
suboptions:
|
||||
subnet:
|
||||
description:
|
||||
- IP and mask.
|
||||
required: true
|
||||
src-negate:
|
||||
description:
|
||||
- Enable/disable negating source address match.
|
||||
choices:
|
||||
- enable
|
||||
- disable
|
||||
srcaddr:
|
||||
description:
|
||||
- Source address name.
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
- Address/group name. Source firewall.address.name firewall.addrgrp.name.
|
||||
required: true
|
||||
start-port:
|
||||
description:
|
||||
- Start destination port number (0 - 65535).
|
||||
start-source-port:
|
||||
description:
|
||||
- Start source port number (0 - 65535).
|
||||
status:
|
||||
description:
|
||||
- Enable/disable this policy route.
|
||||
choices:
|
||||
- enable
|
||||
- disable
|
||||
tos:
|
||||
description:
|
||||
- Type of service bit pattern.
|
||||
tos-mask:
|
||||
description:
|
||||
- Type of service evaluated bits.
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- hosts: localhost
|
||||
vars:
|
||||
host: "192.168.122.40"
|
||||
username: "admin"
|
||||
password: ""
|
||||
vdom: "root"
|
||||
tasks:
|
||||
- name: Configure IPv4 routing policies.
|
||||
fortios_router_policy:
|
||||
host: "{{ host }}"
|
||||
username: "{{ username }}"
|
||||
password: "{{ password }}"
|
||||
vdom: "{{ vdom }}"
|
||||
https: "False"
|
||||
router_policy:
|
||||
state: "present"
|
||||
action: "deny"
|
||||
comments: "<your_own_value>"
|
||||
dst:
|
||||
-
|
||||
subnet: "<your_own_value>"
|
||||
dst-negate: "enable"
|
||||
dstaddr:
|
||||
-
|
||||
name: "default_name_9 (source firewall.address.name firewall.addrgrp.name)"
|
||||
end-port: "10"
|
||||
end-source-port: "11"
|
||||
gateway: "<your_own_value>"
|
||||
input-device:
|
||||
-
|
||||
name: "default_name_14 (source system.interface.name)"
|
||||
output-device: "<your_own_value> (source system.interface.name)"
|
||||
protocol: "16"
|
||||
seq-num: "17"
|
||||
src:
|
||||
-
|
||||
subnet: "<your_own_value>"
|
||||
src-negate: "enable"
|
||||
srcaddr:
|
||||
-
|
||||
name: "default_name_22 (source firewall.address.name firewall.addrgrp.name)"
|
||||
start-port: "23"
|
||||
start-source-port: "24"
|
||||
status: "enable"
|
||||
tos: "<your_own_value>"
|
||||
tos-mask: "<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_router_policy_data(json):
|
||||
option_list = ['action', 'comments', 'dst',
|
||||
'dst-negate', 'dstaddr', 'end-port',
|
||||
'end-source-port', 'gateway', 'input-device',
|
||||
'output-device', 'protocol', 'seq-num',
|
||||
'src', 'src-negate', 'srcaddr',
|
||||
'start-port', 'start-source-port', 'status',
|
||||
'tos', 'tos-mask']
|
||||
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 router_policy(data, fos):
|
||||
vdom = data['vdom']
|
||||
router_policy_data = data['router_policy']
|
||||
flattened_data = flatten_multilists_attributes(router_policy_data)
|
||||
filtered_data = filter_router_policy_data(flattened_data)
|
||||
if router_policy_data['state'] == "present":
|
||||
return fos.set('router',
|
||||
'policy',
|
||||
data=filtered_data,
|
||||
vdom=vdom)
|
||||
|
||||
elif router_policy_data['state'] == "absent":
|
||||
return fos.delete('router',
|
||||
'policy',
|
||||
mkey=filtered_data['seq-num'],
|
||||
vdom=vdom)
|
||||
|
||||
|
||||
def fortios_router(data, fos):
|
||||
login(data)
|
||||
|
||||
if data['router_policy']:
|
||||
resp = router_policy(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},
|
||||
"router_policy": {
|
||||
"required": False, "type": "dict",
|
||||
"options": {
|
||||
"state": {"required": True, "type": "str",
|
||||
"choices": ["present", "absent"]},
|
||||
"action": {"required": False, "type": "str",
|
||||
"choices": ["deny", "permit"]},
|
||||
"comments": {"required": False, "type": "str"},
|
||||
"dst": {"required": False, "type": "list",
|
||||
"options": {
|
||||
"subnet": {"required": True, "type": "str"}
|
||||
}},
|
||||
"dst-negate": {"required": False, "type": "str",
|
||||
"choices": ["enable", "disable"]},
|
||||
"dstaddr": {"required": False, "type": "list",
|
||||
"options": {
|
||||
"name": {"required": True, "type": "str"}
|
||||
}},
|
||||
"end-port": {"required": False, "type": "int"},
|
||||
"end-source-port": {"required": False, "type": "int"},
|
||||
"gateway": {"required": False, "type": "str"},
|
||||
"input-device": {"required": False, "type": "list",
|
||||
"options": {
|
||||
"name": {"required": True, "type": "str"}
|
||||
}},
|
||||
"output-device": {"required": False, "type": "str"},
|
||||
"protocol": {"required": False, "type": "int"},
|
||||
"seq-num": {"required": True, "type": "int"},
|
||||
"src": {"required": False, "type": "list",
|
||||
"options": {
|
||||
"subnet": {"required": True, "type": "str"}
|
||||
}},
|
||||
"src-negate": {"required": False, "type": "str",
|
||||
"choices": ["enable", "disable"]},
|
||||
"srcaddr": {"required": False, "type": "list",
|
||||
"options": {
|
||||
"name": {"required": True, "type": "str"}
|
||||
}},
|
||||
"start-port": {"required": False, "type": "int"},
|
||||
"start-source-port": {"required": False, "type": "int"},
|
||||
"status": {"required": False, "type": "str",
|
||||
"choices": ["enable", "disable"]},
|
||||
"tos": {"required": False, "type": "str"},
|
||||
"tos-mask": {"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_router(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