-
Notifications
You must be signed in to change notification settings - Fork 23.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fortinet's FortiOS Firewall IpMacBinding Table (#51948)
- Loading branch information
Showing
1 changed file
with
287 additions
and
0 deletions.
There are no files selected for viewing
287 changes: 287 additions & 0 deletions
287
lib/ansible/modules/network/fortios/fortios_firewall_ipmacbinding_table.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,287 @@ | ||
#!/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_firewall_ipmacbinding_table | ||
short_description: Configure IP to MAC address pairs in the IP/MAC binding table in Fortinet's FortiOS and FortiGate. | ||
description: | ||
- This module is able to configure a FortiGate or FortiOS by | ||
allowing the user to configure firewall_ipmacbinding feature and table category. | ||
Examples includes all options and 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 adress. | ||
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: false | ||
firewall_ipmacbinding_table: | ||
description: | ||
- Configure IP to MAC address pairs in the IP/MAC binding table. | ||
default: null | ||
suboptions: | ||
state: | ||
description: | ||
- Indicates whether to create or remove the object | ||
choices: | ||
- present | ||
- absent | ||
ip: | ||
description: | ||
- "IPv4 address portion of the pair (format: xxx.xxx.xxx.xxx)." | ||
mac: | ||
description: | ||
- "MAC address portion of the pair (format: xx:xx:xx:xx:xx:xx in hexidecimal)." | ||
name: | ||
description: | ||
- Name of the pair (optional, default = no name). | ||
seq-num: | ||
description: | ||
- Entry number. | ||
required: true | ||
status: | ||
description: | ||
- Enable/disable this IP-mac binding pair. | ||
choices: | ||
- enable | ||
- disable | ||
''' | ||
|
||
EXAMPLES = ''' | ||
- hosts: localhost | ||
vars: | ||
host: "192.168.122.40" | ||
username: "admin" | ||
password: "" | ||
vdom: "root" | ||
tasks: | ||
- name: Configure IP to MAC address pairs in the IP/MAC binding table. | ||
fortios_firewall_ipmacbinding_table: | ||
host: "{{ host }}" | ||
username: "{{ username }}" | ||
password: "{{ password }}" | ||
vdom: "{{ vdom }}" | ||
firewall_ipmacbinding_table: | ||
state: "present" | ||
ip: "<your_own_value>" | ||
mac: "<your_own_value>" | ||
name: "default_name_5" | ||
seq-num: "6" | ||
status: "enable" | ||
''' | ||
|
||
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_firewall_ipmacbinding_table_data(json): | ||
option_list = ['ip', 'mac', 'name', | ||
'seq-num', 'status'] | ||
dictionary = {} | ||
|
||
for attribute in option_list: | ||
if attribute in json and json[attribute] is not None: | ||
dictionary[attribute] = json[attribute] | ||
|
||
return dictionary | ||
|
||
|
||
def firewall_ipmacbinding_table(data, fos): | ||
vdom = data['vdom'] | ||
firewall_ipmacbinding_table_data = data['firewall_ipmacbinding_table'] | ||
filtered_data = filter_firewall_ipmacbinding_table_data(firewall_ipmacbinding_table_data) | ||
if firewall_ipmacbinding_table_data['state'] == "present": | ||
return fos.set('firewall.ipmacbinding', | ||
'table', | ||
data=filtered_data, | ||
vdom=vdom) | ||
|
||
elif firewall_ipmacbinding_table_data['state'] == "absent": | ||
return fos.delete('firewall.ipmacbinding', | ||
'table', | ||
mkey=filtered_data['seq-num'], | ||
vdom=vdom) | ||
|
||
|
||
def fortios_firewall_ipmacbinding(data, fos): | ||
login(data) | ||
|
||
methodlist = ['firewall_ipmacbinding_table'] | ||
for method in methodlist: | ||
if data[method]: | ||
resp = eval(method)(data, fos) | ||
break | ||
|
||
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": "False"}, | ||
"firewall_ipmacbinding_table": { | ||
"required": False, "type": "dict", | ||
"options": { | ||
"state": {"required": True, "type": "str", | ||
"choices": ["present", "absent"]}, | ||
"ip": {"required": False, "type": "str"}, | ||
"mac": {"required": False, "type": "str"}, | ||
"name": {"required": False, "type": "str"}, | ||
"seq-num": {"required": True, "type": "int"}, | ||
"status": {"required": False, "type": "str", | ||
"choices": ["enable", "disable"]} | ||
|
||
} | ||
} | ||
} | ||
|
||
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_firewall_ipmacbinding(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() |