mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Fortinet's FortiOS wireless controller setting (#52845)
* Fortinet's FortiOS wireless controller setting * Avoid using global
This commit is contained in:
Miguel Angel Muñoz González
John R Barker
parent
92398f6106
commit
c9a79f12b4
1 changed files with 449 additions and 0 deletions
|
|
@ -0,0 +1,449 @@
|
|||
#!/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_wireless_controller_setting
|
||||
short_description: VDOM wireless controller 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 wireless_controller feature and setting 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
|
||||
wireless_controller_setting:
|
||||
description:
|
||||
- VDOM wireless controller configuration.
|
||||
default: null
|
||||
suboptions:
|
||||
account-id:
|
||||
description:
|
||||
- FortiCloud customer account ID.
|
||||
country:
|
||||
description:
|
||||
- Country or region in which the FortiGate is located. The country determines the 802.11 bands and channels that are available.
|
||||
choices:
|
||||
- NA
|
||||
- AL
|
||||
- DZ
|
||||
- AO
|
||||
- AR
|
||||
- AM
|
||||
- AU
|
||||
- AT
|
||||
- AZ
|
||||
- BH
|
||||
- BD
|
||||
- BB
|
||||
- BY
|
||||
- BE
|
||||
- BZ
|
||||
- BO
|
||||
- BA
|
||||
- BR
|
||||
- BN
|
||||
- BG
|
||||
- KH
|
||||
- CL
|
||||
- CN
|
||||
- CO
|
||||
- CR
|
||||
- HR
|
||||
- CY
|
||||
- CZ
|
||||
- DK
|
||||
- DO
|
||||
- EC
|
||||
- EG
|
||||
- SV
|
||||
- EE
|
||||
- FI
|
||||
- FR
|
||||
- GE
|
||||
- DE
|
||||
- GR
|
||||
- GL
|
||||
- GD
|
||||
- GU
|
||||
- GT
|
||||
- HT
|
||||
- HN
|
||||
- HK
|
||||
- HU
|
||||
- IS
|
||||
- IN
|
||||
- ID
|
||||
- IR
|
||||
- IE
|
||||
- IL
|
||||
- IT
|
||||
- JM
|
||||
- JO
|
||||
- KZ
|
||||
- KE
|
||||
- KP
|
||||
- KR
|
||||
- KW
|
||||
- LV
|
||||
- LB
|
||||
- LI
|
||||
- LT
|
||||
- LU
|
||||
- MO
|
||||
- MK
|
||||
- MY
|
||||
- MT
|
||||
- MX
|
||||
- MC
|
||||
- MA
|
||||
- MZ
|
||||
- MM
|
||||
- NP
|
||||
- NL
|
||||
- AN
|
||||
- AW
|
||||
- NZ
|
||||
- NO
|
||||
- OM
|
||||
- PK
|
||||
- PA
|
||||
- PG
|
||||
- PY
|
||||
- PE
|
||||
- PH
|
||||
- PL
|
||||
- PT
|
||||
- PR
|
||||
- QA
|
||||
- RO
|
||||
- RU
|
||||
- RW
|
||||
- SA
|
||||
- RS
|
||||
- ME
|
||||
- SG
|
||||
- SK
|
||||
- SI
|
||||
- ZA
|
||||
- ES
|
||||
- LK
|
||||
- SE
|
||||
- SD
|
||||
- CH
|
||||
- SY
|
||||
- TW
|
||||
- TZ
|
||||
- TH
|
||||
- TT
|
||||
- TN
|
||||
- TR
|
||||
- AE
|
||||
- UA
|
||||
- GB
|
||||
- US
|
||||
- PS
|
||||
- UY
|
||||
- UZ
|
||||
- VE
|
||||
- VN
|
||||
- YE
|
||||
- ZB
|
||||
- ZW
|
||||
- JP
|
||||
- CA
|
||||
duplicate-ssid:
|
||||
description:
|
||||
- Enable/disable allowing Virtual Access Points (VAPs) to use the same SSID name in the same VDOM.
|
||||
choices:
|
||||
- enable
|
||||
- disable
|
||||
fapc-compatibility:
|
||||
description:
|
||||
- Enable/disable FAP-C series compatibility.
|
||||
choices:
|
||||
- enable
|
||||
- disable
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- hosts: localhost
|
||||
vars:
|
||||
host: "192.168.122.40"
|
||||
username: "admin"
|
||||
password: ""
|
||||
vdom: "root"
|
||||
tasks:
|
||||
- name: VDOM wireless controller configuration.
|
||||
fortios_wireless_controller_setting:
|
||||
host: "{{ host }}"
|
||||
username: "{{ username }}"
|
||||
password: "{{ password }}"
|
||||
vdom: "{{ vdom }}"
|
||||
https: "False"
|
||||
wireless_controller_setting:
|
||||
account-id: "<your_own_value>"
|
||||
country: "NA"
|
||||
duplicate-ssid: "enable"
|
||||
fapc-compatibility: "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
|
||||
|
||||
|
||||
def login(data, fos):
|
||||
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_wireless_controller_setting_data(json):
|
||||
option_list = ['account-id', 'country', 'duplicate-ssid',
|
||||
'fapc-compatibility']
|
||||
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 wireless_controller_setting(data, fos):
|
||||
vdom = data['vdom']
|
||||
wireless_controller_setting_data = data['wireless_controller_setting']
|
||||
flattened_data = flatten_multilists_attributes(wireless_controller_setting_data)
|
||||
filtered_data = filter_wireless_controller_setting_data(flattened_data)
|
||||
return fos.set('wireless-controller',
|
||||
'setting',
|
||||
data=filtered_data,
|
||||
vdom=vdom)
|
||||
|
||||
|
||||
def fortios_wireless_controller(data, fos):
|
||||
login(data, fos)
|
||||
|
||||
if data['wireless_controller_setting']:
|
||||
resp = wireless_controller_setting(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},
|
||||
"wireless_controller_setting": {
|
||||
"required": False, "type": "dict",
|
||||
"options": {
|
||||
"account-id": {"required": False, "type": "str"},
|
||||
"country": {"required": False, "type": "str",
|
||||
"choices": ["NA", "AL", "DZ",
|
||||
"AO", "AR", "AM",
|
||||
"AU", "AT", "AZ",
|
||||
"BH", "BD", "BB",
|
||||
"BY", "BE", "BZ",
|
||||
"BO", "BA", "BR",
|
||||
"BN", "BG", "KH",
|
||||
"CL", "CN", "CO",
|
||||
"CR", "HR", "CY",
|
||||
"CZ", "DK", "DO",
|
||||
"EC", "EG", "SV",
|
||||
"EE", "FI", "FR",
|
||||
"GE", "DE", "GR",
|
||||
"GL", "GD", "GU",
|
||||
"GT", "HT", "HN",
|
||||
"HK", "HU", "IS",
|
||||
"IN", "ID", "IR",
|
||||
"IE", "IL", "IT",
|
||||
"JM", "JO", "KZ",
|
||||
"KE", "KP", "KR",
|
||||
"KW", "LV", "LB",
|
||||
"LI", "LT", "LU",
|
||||
"MO", "MK", "MY",
|
||||
"MT", "MX", "MC",
|
||||
"MA", "MZ", "MM",
|
||||
"NP", "NL", "AN",
|
||||
"AW", "NZ", "NO",
|
||||
"OM", "PK", "PA",
|
||||
"PG", "PY", "PE",
|
||||
"PH", "PL", "PT",
|
||||
"PR", "QA", "RO",
|
||||
"RU", "RW", "SA",
|
||||
"RS", "ME", "SG",
|
||||
"SK", "SI", "ZA",
|
||||
"ES", "LK", "SE",
|
||||
"SD", "CH", "SY",
|
||||
"TW", "TZ", "TH",
|
||||
"TT", "TN", "TR",
|
||||
"AE", "UA", "GB",
|
||||
"US", "PS", "UY",
|
||||
"UZ", "VE", "VN",
|
||||
"YE", "ZB", "ZW",
|
||||
"JP", "CA"]},
|
||||
"duplicate-ssid": {"required": False, "type": "str",
|
||||
"choices": ["enable", "disable"]},
|
||||
"fapc-compatibility": {"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")
|
||||
|
||||
fos = FortiOSAPI()
|
||||
|
||||
is_error, has_changed, result = fortios_wireless_controller(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