Fortinet's new module for fortios_wireless_controller_hotspot20_anqp_nai_realm (#61089)

* Fortinet's new module for fortios_wireless_controller_hotspot20_anqp_nai_realm

* Update fortios_wireless_controller_hotspot20_anqp_nai_realm.py

* Update fortios_wireless_controller_hotspot20_anqp_nai_realm.py
pull/61212/head
frankshen01 5 years ago committed by Rohit
parent eb2e0dcc51
commit ec348bb2ac

@ -0,0 +1,455 @@
#!/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_hotspot20_anqp_nai_realm
short_description: Configure network access identifier (NAI) realm in Fortinet's FortiOS and FortiGate.
description:
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the
user to set and modify wireless_controller_hotspot20 feature and anqp_nai_realm category.
Examples include all parameters and values need to be adjusted to datasources before usage.
Tested with FOS v6.0.4
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
required: true
choices:
- present
- absent
wireless_controller_hotspot20_anqp_nai_realm:
description:
- Configure network access identifier (NAI) realm.
default: null
type: dict
suboptions:
nai_list:
description:
- NAI list.
type: list
suboptions:
eap_method:
description:
- EAP Methods.
type: list
suboptions:
auth_param:
description:
- EAP auth param.
type: str
suboptions:
id:
description:
- ID of authentication parameter.
type: str
choices:
- non-eap-inner-auth
- inner-auth-eap
- credential
- tunneled-credential
index:
description:
- Param index.
required: true
type: int
val:
description:
- Value of authentication parameter.
type: str
choices:
- eap-identity
- eap-md5
- eap-tls
- eap-ttls
- eap-peap
- eap-sim
- eap-aka
- eap-aka-prime
- non-eap-pap
- non-eap-chap
- non-eap-mschap
- non-eap-mschapv2
- cred-sim
- cred-usim
- cred-nfc
- cred-hardware-token
- cred-softoken
- cred-certificate
- cred-user-pwd
- cred-none
- cred-vendor-specific
- tun-cred-sim
- tun-cred-usim
- tun-cred-nfc
- tun-cred-hardware-token
- tun-cred-softoken
- tun-cred-certificate
- tun-cred-user-pwd
- tun-cred-anonymous
- tun-cred-vendor-specific
index:
description:
- EAP method index.
required: true
type: int
method:
description:
- EAP method type.
type: str
choices:
- eap-identity
- eap-md5
- eap-tls
- eap-ttls
- eap-peap
- eap-sim
- eap-aka
- eap-aka-prime
encoding:
description:
- Enable/disable format in accordance with IETF RFC 4282.
type: str
choices:
- disable
- enable
nai_realm:
description:
- Configure NAI realms (delimited by a semi-colon character).
type: str
name:
description:
- NAI realm name.
required: true
type: str
name:
description:
- NAI realm list name.
required: true
type: str
'''
EXAMPLES = '''
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure network access identifier (NAI) realm.
fortios_wireless_controller_hotspot20_anqp_nai_realm:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
state: "present"
wireless_controller_hotspot20_anqp_nai_realm:
nai_list:
-
eap_method:
-
auth_param:
-
id: "6"
index: "7"
val: "eap-identity"
index: "9"
method: "eap-identity"
encoding: "disable"
nai_realm: "<your_own_value>"
name: "default_name_13"
name: "default_name_14"
'''
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_wireless_controller_hotspot20_anqp_nai_realm_data(json):
option_list = ['nai_list', 'name']
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 wireless_controller_hotspot20_anqp_nai_realm(data, fos):
vdom = data['vdom']
state = data['state']
wireless_controller_hotspot20_anqp_nai_realm_data = data['wireless_controller_hotspot20_anqp_nai_realm']
filtered_data = underscore_to_hyphen(filter_wireless_controller_hotspot20_anqp_nai_realm_data(wireless_controller_hotspot20_anqp_nai_realm_data))
if state == "present":
return fos.set('wireless-controller.hotspot20',
'anqp-nai-realm',
data=filtered_data,
vdom=vdom)
elif state == "absent":
return fos.delete('wireless-controller.hotspot20',
'anqp-nai-realm',
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_wireless_controller_hotspot20(data, fos):
if data['wireless_controller_hotspot20_anqp_nai_realm']:
resp = wireless_controller_hotspot20_anqp_nai_realm(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", "default": "", "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"]},
"wireless_controller_hotspot20_anqp_nai_realm": {
"required": False, "type": "dict", "default": None,
"options": {
"nai_list": {"required": False, "type": "list",
"options": {
"eap_method": {"required": False, "type": "list",
"options": {
"auth_param": {"required": False, "type": "str",
"options": {
"id": {"required": False, "type": "str",
"choices": ["non-eap-inner-auth", "inner-auth-eap", "credential",
"tunneled-credential"]},
"index": {"required": True, "type": "int"},
"val": {"required": False, "type": "str",
"choices": ["eap-identity", "eap-md5", "eap-tls",
"eap-ttls", "eap-peap", "eap-sim",
"eap-aka", "eap-aka-prime", "non-eap-pap",
"non-eap-chap", "non-eap-mschap", "non-eap-mschapv2",
"cred-sim", "cred-usim", "cred-nfc",
"cred-hardware-token", "cred-softoken", "cred-certificate",
"cred-user-pwd", "cred-none", "cred-vendor-specific",
"tun-cred-sim", "tun-cred-usim", "tun-cred-nfc",
"tun-cred-hardware-token", "tun-cred-softoken",
"tun-cred-certificate", "tun-cred-user-pwd",
"tun-cred-anonymous", "tun-cred-vendor-specific"]}
}},
"index": {"required": True, "type": "int"},
"method": {"required": False, "type": "str",
"choices": ["eap-identity", "eap-md5", "eap-tls",
"eap-ttls", "eap-peap", "eap-sim",
"eap-aka", "eap-aka-prime"]}
}},
"encoding": {"required": False, "type": "str",
"choices": ["disable", "enable"]},
"nai_realm": {"required": False, "type": "str"},
"name": {"required": True, "type": "str"}
}},
"name": {"required": True, "type": "str"}
}
}
}
module = AnsibleModule(argument_spec=fields,
supports_check_mode=False)
# legacy_mode refers to using fortiosapi instead of HTTPAPI
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_wireless_controller_hotspot20(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_wireless_controller_hotspot20(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()

@ -0,0 +1,189 @@
# 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_wireless_controller_hotspot20_anqp_nai_realm
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_wireless_controller_hotspot20_anqp_nai_realm.Connection')
return connection_class_mock
fos_instance = FortiOSHandler(connection_mock)
def test_wireless_controller_hotspot20_anqp_nai_realm_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',
'wireless_controller_hotspot20_anqp_nai_realm': {'name': 'default_name_3'
},
'vdom': 'root'}
is_error, changed, response = fortios_wireless_controller_hotspot20_anqp_nai_realm.fortios_wireless_controller_hotspot20(input_data, fos_instance)
expected_data = {'name': 'default_name_3'
}
set_method_mock.assert_called_with('wireless-controller.hotspot20', 'anqp-nai-realm', 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_wireless_controller_hotspot20_anqp_nai_realm_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',
'wireless_controller_hotspot20_anqp_nai_realm': {'name': 'default_name_3'
},
'vdom': 'root'}
is_error, changed, response = fortios_wireless_controller_hotspot20_anqp_nai_realm.fortios_wireless_controller_hotspot20(input_data, fos_instance)
expected_data = {'name': 'default_name_3'
}
set_method_mock.assert_called_with('wireless-controller.hotspot20', 'anqp-nai-realm', 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_wireless_controller_hotspot20_anqp_nai_realm_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',
'wireless_controller_hotspot20_anqp_nai_realm': {'name': 'default_name_3'
},
'vdom': 'root'}
is_error, changed, response = fortios_wireless_controller_hotspot20_anqp_nai_realm.fortios_wireless_controller_hotspot20(input_data, fos_instance)
delete_method_mock.assert_called_with('wireless-controller.hotspot20', 'anqp-nai-realm', 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_wireless_controller_hotspot20_anqp_nai_realm_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',
'wireless_controller_hotspot20_anqp_nai_realm': {'name': 'default_name_3'
},
'vdom': 'root'}
is_error, changed, response = fortios_wireless_controller_hotspot20_anqp_nai_realm.fortios_wireless_controller_hotspot20(input_data, fos_instance)
delete_method_mock.assert_called_with('wireless-controller.hotspot20', 'anqp-nai-realm', 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_wireless_controller_hotspot20_anqp_nai_realm_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',
'wireless_controller_hotspot20_anqp_nai_realm': {'name': 'default_name_3'
},
'vdom': 'root'}
is_error, changed, response = fortios_wireless_controller_hotspot20_anqp_nai_realm.fortios_wireless_controller_hotspot20(input_data, fos_instance)
expected_data = {'name': 'default_name_3'
}
set_method_mock.assert_called_with('wireless-controller.hotspot20', 'anqp-nai-realm', 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_wireless_controller_hotspot20_anqp_nai_realm_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',
'wireless_controller_hotspot20_anqp_nai_realm': {
'random_attribute_not_valid': 'tag', 'name': 'default_name_3'
},
'vdom': 'root'}
is_error, changed, response = fortios_wireless_controller_hotspot20_anqp_nai_realm.fortios_wireless_controller_hotspot20(input_data, fos_instance)
expected_data = {'name': 'default_name_3'
}
set_method_mock.assert_called_with('wireless-controller.hotspot20', 'anqp-nai-realm', 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
Loading…
Cancel
Save