wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fortinet's FortiOS system dns (#52392)

Browse source
This commit is contained in:
Miguel Angel Muñoz González 2019-02-21 20:52:00 +01:00 committed by John R Barker
parent 0359048edd
commit 8d341145e1
1 changed files with 305 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

305
lib/ansible/modules/network/fortios/fortios_system_dns.py Normal file
View file

@ -0,0 +1,305 @@
#!/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_system_dns
short_description: Configure DNS 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 system feature and dns 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
system_dns:
description:
- Configure DNS.
default: null
suboptions:
cache-notfound-responses:
description:
- Enable/disable response from the DNS server when a record is not in cache.
choices:
- disable
- enable
dns-cache-limit:
description:
- Maximum number of records in the DNS cache.
dns-cache-ttl:
description:
- Duration in seconds that the DNS cache retains information.
domain:
description:
- Domain name suffix for the IP addresses of the DNS server.
ip6-primary:
description:
- Primary DNS server IPv6 address.
ip6-secondary:
description:
- Secondary DNS server IPv6 address.
primary:
description:
- Primary DNS server IP address, default is FortiGuard server at 208.81.112.53.
secondary:
description:
- Secondary DNS server IP address, default is FortiGuard server at 208.81.112.52.
source-ip:
description:
- IP address used by the DNS server as its source IP.
'''
EXAMPLES = '''
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
tasks:
- name: Configure DNS.
fortios_system_dns:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
system_dns:
cache-notfound-responses: "disable"
dns-cache-limit: "4"
dns-cache-ttl: "5"
domain: "<your_own_value>"
ip6-primary: "<your_own_value>"
ip6-secondary: "<your_own_value>"
primary: "<your_own_value>"
secondary: "<your_own_value>"
source-ip: "84.230.14.43"
'''
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_system_dns_data(json):
option_list = ['cache-notfound-responses', 'dns-cache-limit', 'dns-cache-ttl',
'domain', 'ip6-primary', 'ip6-secondary',
'primary', 'secondary', 'source-ip']
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 system_dns(data, fos):
vdom = data['vdom']
system_dns_data = data['system_dns']
flattened_data = flatten_multilists_attributes(system_dns_data)
filtered_data = filter_system_dns_data(flattened_data)
return fos.set('system',
'dns',
data=filtered_data,
vdom=vdom)
def fortios_system(data, fos):
login(data)
if data['system_dns']:
resp = system_dns(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},
"system_dns": {
"required": False, "type": "dict",
"options": {
"cache-notfound-responses": {"required": False, "type": "str",
"choices": ["disable", "enable"]},
"dns-cache-limit": {"required": False, "type": "int"},
"dns-cache-ttl": {"required": False, "type": "int"},
"domain": {"required": False, "type": "str"},
"ip6-primary": {"required": False, "type": "str"},
"ip6-secondary": {"required": False, "type": "str"},
"primary": {"required": False, "type": "str"},
"secondary": {"required": False, "type": "str"},
"source-ip": {"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_system(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()