ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-26 14:41:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Fortinet FortiManager Device Add Module (#45954)

Browse source 
* fmgr_device PR candidate

* fmgr_device PR candidate

* fmgr_device PR candidate

* fmgr_device PR candidate

* fmgr_device PR candidate

* fmgr_device PR candidate

* fmgr_fwobj_address PR candidate

* Grammar

* grammar changes

* pylint changes

* Fixing Authors
This commit is contained in:
ftntcorecse 2018-11-20 23:35:33 -07:00 • committed by Nilashish Chakraborty
commit fb7b6f9521
3 changed files with 1140 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

526
test/units/modules/network/fortimanager/fixtures/test_fmgr_device.json Normal file
View file

@ -0,0 +1,526 @@
{
"add_device": [
{
"url": "/dvm/cmd/add/device/",
"raw_response": {
"device": {
"adm_pass": "fortinet",
"ip": "10.7.220.151",
"mgmt.__data[6]": 1,
"vm_mem": 2005,
"maxvdom": 10,
"conn_mode": 1,
"vm_cpu_limit": 1,
"vm_cpu": 1,
"branch_pt": 163,
"hostname": "FGVM010000122995",
"source": 1,
"mgmt_id": 312304802,
"version": 600,
"build": 163,
"mgmt_mode": 3,
"adm_usr": "admin",
"av_ver": "61.00026(2018-07-27 11:28)",
"oid": 378,
"conn_status": 1,
"beta": -1,
"dev_status": 1,
"platform_str": "FortiGate-VM64",
"last_checked": 1537410598,
"patch": 2,
"vm_mem_limit": 2048,
"mgmt.__data[0]": 3870643,
"name": "FGT1",
"tab_status": "<unknown>",
"mgmt.__data[4]": 2103046144,
"platform_id": 111,
"vm_status": 3,
"ips_ver": "6.00741(2015-12-01 02:30)",
"flags": 2097169,
"sn": "FGVM010000122995",
"mr": 0,
"os_type": 0,
"os_ver": 6
}
},
"paramgram_used": {
"device_username": "admin",
"adom": "ansible",
"device_ip": "10.7.220.151",
"state": "present",
"device_unique_name": "FGT1",
"device_serial": null,
"device_password": "fortinet"
},
"post_method": "execute"
},
{
"url": "/dvm/cmd/add/device/",
"raw_response": {
"device": {
"adm_pass": "fortinet",
"ip": "10.7.220.152",
"mgmt.__data[6]": 1,
"vm_mem": 2005,
"maxvdom": 10,
"conn_mode": 1,
"vm_cpu_limit": 1,
"vm_cpu": 1,
"branch_pt": 163,
"hostname": "FGVM010000123005",
"source": 1,
"mgmt_id": 2084190718,
"version": 600,
"build": 163,
"mgmt_mode": 3,
"adm_usr": "admin",
"av_ver": "61.00026(2018-07-27 11:28)",
"oid": 390,
"conn_status": 1,
"beta": -1,
"dev_status": 1,
"platform_str": "FortiGate-VM64",
"last_checked": 1537410631,
"patch": 2,
"vm_mem_limit": 2048,
"mgmt.__data[0]": 3870643,
"name": "FGT2",
"tab_status": "<unknown>",
"mgmt.__data[4]": 2103046144,
"platform_id": 111,
"vm_status": 3,
"ips_ver": "6.00741(2015-12-01 02:30)",
"flags": 2097169,
"sn": "FGVM010000123005",
"mr": 0,
"os_type": 0,
"os_ver": 6
}
},
"paramgram_used": {
"device_username": "admin",
"adom": "ansible",
"device_ip": "10.7.220.152",
"state": "present",
"device_unique_name": "FGT2",
"device_serial": null,
"device_password": "fortinet"
},
"post_method": "execute"
},
{
"paramgram_used": {
"device_username": "admin",
"adom": "ansible",
"device_ip": "10.7.220.151",
"state": "present",
"device_unique_name": "FGT1",
"device_serial": null,
"device_password": "fortinet"
},
"raw_response": {
"status": {
"message": "Serial number already in use",
"code": -20010
},
"url": "/dvm/cmd/add/device/"
},
"post_method": "execute"
},
{
"paramgram_used": {
"device_username": "admin",
"adom": "ansible",
"device_ip": "10.7.220.152",
"state": "present",
"device_unique_name": "FGT2",
"device_serial": null,
"device_password": "fortinet"
},
"raw_response": {
"status": {
"message": "Serial number already in use",
"code": -20010
},
"url": "/dvm/cmd/add/device/"
},
"post_method": "execute"
},
{
"url": "/dvm/cmd/add/device/",
"paramgram_used": {
"device_username": "admin",
"adom": "ansible",
"device_ip": "10.7.220.153",
"state": "present",
"device_unique_name": "FGT3",
"device_serial": null,
"device_password": "fortinet"
},
"raw_response": {
"device": {
"adm_pass": "fortinet",
"os_ver": 6,
"ip": "10.7.220.153",
"mgmt.__data[6]": 1,
"vm_mem": 2005,
"maxvdom": 10,
"conn_mode": 1,
"platform_id": 111,
"branch_pt": 163,
"hostname": "FGVM010000123017",
"source": 1,
"mgmt_id": 501253209,
"version": 600,
"build": 163,
"mgmt_mode": 3,
"adm_usr": "admin",
"av_ver": "62.00278(2018-09-17 13:28)",
"mgmt.__data[4]": 2103046144,
"oid": 402,
"conn_status": 1,
"beta": -1,
"dev_status": 1,
"platform_str": "FortiGate-VM64",
"last_checked": 1537410728,
"vm_mem_limit": 2048,
"mgmt.__data[0]": 3870643,
"name": "FGT3",
"tab_status": "<unknown>",
"patch": 2,
"vm_cpu_limit": 1,
"vm_status": 3,
"ips_ver": "6.00741(2015-12-01 02:30)",
"flags": 2097169,
"sn": "FGVM010000123017",
"mr": 0,
"os_type": 0,
"vm_cpu": 1
}
},
"post_method": "execute"
}
],
"discover_device": [
{
"url": "/dvm/cmd/discover/device/",
"paramgram_used": {
"device_username": "admin",
"adom": "ansible",
"device_ip": "10.7.220.151",
"state": "present",
"device_unique_name": "FGT1",
"device_serial": null,
"device_password": "fortinet"
},
"raw_response": {
"device": {
"adm_pass": "fortinet",
"os_ver": 6,
"ip": "10.7.220.151",
"vm_mem": 2005,
"maxvdom": 10,
"conn_mode": 1,
"platform_id": 111,
"branch_pt": 163,
"hostname": "FGVM010000122995",
"source": 1,
"version": 600,
"build": 163,
"adm_usr": "admin",
"av_ver": "61.00026(2018-07-27 11:28)",
"conn_status": 1,
"beta": -1,
"dev_status": 1,
"platform_str": "FortiGate-VM64",
"last_checked": 1537410595,
"vm_mem_limit": 2048,
"name": "FGVM010000122995",
"tab_status": "<unknown>",
"patch": 2,
"vm_cpu_limit": 1,
"vm_status": 3,
"ips_ver": "6.00741(2015-12-01 02:30)",
"flags": 2097153,
"sn": "FGVM010000122995",
"mr": 0,
"os_type": 0,
"vm_cpu": 1
}
},
"post_method": "execute"
},
{
"url": "/dvm/cmd/discover/device/",
"paramgram_used": {
"device_username": "admin",
"adom": "ansible",
"device_ip": "10.7.220.152",
"state": "present",
"device_unique_name": "FGT2",
"device_serial": null,
"device_password": "fortinet"
},
"raw_response": {
"device": {
"adm_pass": "fortinet",
"os_ver": 6,
"ip": "10.7.220.152",
"vm_mem": 2005,
"maxvdom": 10,
"conn_mode": 1,
"platform_id": 111,
"branch_pt": 163,
"hostname": "FGVM010000123005",
"source": 1,
"version": 600,
"build": 163,
"adm_usr": "admin",
"av_ver": "61.00026(2018-07-27 11:28)",
"conn_status": 1,
"beta": -1,
"dev_status": 1,
"platform_str": "FortiGate-VM64",
"last_checked": 1537410627,
"vm_mem_limit": 2048,
"name": "FGVM010000123005",
"tab_status": "<unknown>",
"patch": 2,
"vm_cpu_limit": 1,
"vm_status": 3,
"ips_ver": "6.00741(2015-12-01 02:30)",
"flags": 2097153,
"sn": "FGVM010000123005",
"mr": 0,
"os_type": 0,
"vm_cpu": 1
}
},
"post_method": "execute"
},
{
"paramgram_used": {
"device_username": "admin",
"adom": "ansible",
"device_ip": "10.7.220.153",
"state": "present",
"device_unique_name": "FGT3",
"device_serial": null,
"device_password": "fortinet"
},
"raw_response": {
"status": {
"message": "Probe failed: network",
"code": -20042
},
"url": "/dvm/cmd/discover/device/"
},
"post_method": "execute"
},
{
"url": "/dvm/cmd/discover/device/",
"raw_response": {
"device": {
"adm_pass": "fortinet",
"ip": "10.7.220.151",
"vm_mem": 2005,
"maxvdom": 10,
"conn_mode": 1,
"vm_cpu_limit": 1,
"vm_cpu": 1,
"branch_pt": 163,
"hostname": "FGVM010000122995",
"source": 1,
"version": 600,
"build": 163,
"managed_sn": "FMG-VM0A17004505",
"adm_usr": "admin",
"av_ver": "61.00026(2018-07-27 11:28)",
"conn_status": 1,
"beta": -1,
"dev_status": 1,
"platform_str": "FortiGate-VM64",
"last_checked": 1537410707,
"vm_mem_limit": 2048,
"name": "FGVM010000122995",
"tab_status": "<unknown>",
"patch": 2,
"platform_id": 111,
"vm_status": 3,
"ips_ver": "6.00741(2015-12-01 02:30)",
"flags": 2097153,
"sn": "FGVM010000122995",
"mr": 0,
"os_type": 0,
"os_ver": 6
}
},
"paramgram_used": {
"device_username": "admin",
"adom": "ansible",
"device_ip": "10.7.220.151",
"state": "present",
"device_unique_name": "FGT1",
"device_serial": null,
"device_password": "fortinet"
},
"post_method": "execute"
},
{
"url": "/dvm/cmd/discover/device/",
"raw_response": {
"device": {
"adm_pass": "fortinet",
"ip": "10.7.220.152",
"vm_mem": 2005,
"maxvdom": 10,
"conn_mode": 1,
"vm_cpu_limit": 1,
"vm_cpu": 1,
"branch_pt": 163,
"hostname": "FGVM010000123005",
"source": 1,
"version": 600,
"build": 163,
"managed_sn": "FMG-VM0A17004505",
"adm_usr": "admin",
"av_ver": "61.00026(2018-07-27 11:28)",
"conn_status": 1,
"beta": -1,
"dev_status": 1,
"platform_str": "FortiGate-VM64",
"last_checked": 1537410713,
"vm_mem_limit": 2048,
"name": "FGVM010000123005",
"tab_status": "<unknown>",
"patch": 2,
"platform_id": 111,
"vm_status": 3,
"ips_ver": "6.00741(2015-12-01 02:30)",
"flags": 2097153,
"sn": "FGVM010000123005",
"mr": 0,
"os_type": 0,
"os_ver": 6
}
},
"paramgram_used": {
"device_username": "admin",
"adom": "ansible",
"device_ip": "10.7.220.152",
"state": "present",
"device_unique_name": "FGT2",
"device_serial": null,
"device_password": "fortinet"
},
"post_method": "execute"
},
{
"url": "/dvm/cmd/discover/device/",
"raw_response": {
"device": {
"adm_pass": "fortinet",
"ip": "10.7.220.153",
"vm_mem": 2005,
"maxvdom": 10,
"conn_mode": 1,
"vm_cpu_limit": 1,
"vm_cpu": 1,
"branch_pt": 163,
"hostname": "FGVM010000123017",
"source": 1,
"version": 600,
"build": 163,
"adm_usr": "admin",
"av_ver": "62.00278(2018-09-17 13:28)",
"conn_status": 1,
"beta": -1,
"dev_status": 1,
"platform_str": "FortiGate-VM64",
"last_checked": 1537410723,
"vm_mem_limit": 2048,
"name": "FGVM010000123017",
"tab_status": "<unknown>",
"patch": 2,
"platform_id": 111,
"vm_status": 3,
"ips_ver": "6.00741(2015-12-01 02:30)",
"flags": 2097153,
"sn": "FGVM010000123017",
"mr": 0,
"os_type": 0,
"os_ver": 6
}
},
"paramgram_used": {
"device_username": "admin",
"adom": "ansible",
"device_ip": "10.7.220.153",
"state": "present",
"device_unique_name": "FGT3",
"device_serial": null,
"device_password": "fortinet"
},
"post_method": "execute"
}
],
"delete_device": [
{
"raw_response": {
"status": {
"message": "OK",
"code": 0
},
"url": "/dvm/cmd/del/device/"
},
"paramgram_used": {
"device_username": "admin",
"adom": "ansible",
"device_ip": "10.7.220.151",
"state": "absent",
"device_unique_name": "FGT1",
"device_serial": null,
"device_password": "fortinet"
},
"post_method": "execute"
},
{
"paramgram_used": {
"device_username": "admin",
"adom": "ansible",
"device_ip": "10.7.220.152",
"state": "absent",
"device_unique_name": "FGT2",
"device_serial": null,
"device_password": "fortinet"
},
"raw_response": {
"status": {
"message": "OK",
"code": 0
},
"url": "/dvm/cmd/del/device/"
},
"post_method": "execute"
},
{
"raw_response": {
"status": {
"message": "OK",
"code": 0
},
"url": "/dvm/cmd/del/device/"
},
"paramgram_used": {
"device_username": "admin",
"adom": "ansible",
"device_ip": "10.7.220.153",
"state": "absent",
"device_unique_name": "FGT3",
"device_serial": null,
"device_password": "fortinet"
},
"post_method": "execute"
}
]
}

321
test/units/modules/network/fortimanager/test_fmgr_device.py Normal file
View file

@ -0,0 +1,321 @@
# (c) 2016 Red Hat Inc.
#
# This file is part of Ansible
#
# Ansible 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.
#
# Ansible 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 <http://www.gnu.org/licenses/>.
# Make coding more python3-ish
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
import os
import json
from pyFMG.fortimgr import FortiManager
import pytest
try:
from ansible.modules.network.fortimanager import fmgr_device
except ImportError:
pytest.skip(
"Could not load required modules for testing",
allow_module_level=True)
fmg_instance = FortiManager("1.1.1.1", "admin", "")
def load_fixtures():
fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures') + "/{filename}.json".format(
filename=os.path.splitext(os.path.basename(__file__))[0])
try:
with open(fixture_path, "r") as fixture_file:
fixture_data = json.load(fixture_file)
except IOError:
return []
return [fixture_data]
@pytest.fixture(scope="function", params=load_fixtures())
def fixture_data(request):
func_name = request.function.__name__.replace("test_", "")
return request.param.get(func_name, None)
def test_discover_device(fixture_data, mocker):
mocker.patch(
"pyFMG.fortimgr.FortiManager._post_request",
side_effect=fixture_data)
paramgram_used = {
'device_username': 'admin', 'adom': 'ansible',
'device_ip': '10.7.220.151', 'state': 'present',
'device_unique_name': 'FGT1', 'device_serial':
None, 'device_password': 'fortinet',
'mode': 'execute'}
output = fmgr_device.discover_device(fmg_instance, paramgram_used)
#
# device_username: admin
# adom: ansible
# device_ip: 10.7.220.151
# state: present
# device_unique_name: FGT1
# device_serial: None
# device_password: fortinet
# mode: execute
#
assert isinstance(output['raw_response'], dict) is True
paramgram_used = {
'device_username': 'admin', 'adom': 'ansible',
'device_ip': '10.7.220.152', 'state': 'present',
'device_unique_name': 'FGT2', 'device_serial':
None, 'device_password': 'fortinet',
'mode': 'execute'}
output = fmgr_device.discover_device(fmg_instance, paramgram_used)
#
# device_username: admin
# adom: ansible
# device_ip: 10.7.220.152
# state: present
# device_unique_name: FGT2
# device_serial: None
# device_password: fortinet
# mode: execute
#
assert isinstance(output['raw_response'], dict) is True
paramgram_used = {
'device_username': 'admin', 'adom': 'ansible',
'device_ip': '10.7.220.153', 'state': 'present',
'device_unique_name': 'FGT3', 'device_serial':
None, 'device_password': 'fortinet',
'mode': 'execute'}
output = fmgr_device.discover_device(fmg_instance, paramgram_used)
#
# device_username: admin
# adom: ansible
# device_ip: 10.7.220.153
# state: present
# device_unique_name: FGT3
# device_serial: None
# device_password: fortinet
# mode: execute
#
assert output['raw_response']['status']['code'] == -20042
paramgram_used = {
'device_username': 'admin', 'adom': 'ansible',
'device_ip': '10.7.220.151', 'state': 'present',
'device_unique_name': 'FGT1', 'device_serial':
None, 'device_password': 'fortinet',
'mode': 'execute'}
output = fmgr_device.discover_device(fmg_instance, paramgram_used)
#
# device_username: admin
# adom: ansible
# device_ip: 10.7.220.151
# state: present
# device_unique_name: FGT1
# device_serial: None
# device_password: fortinet
# mode: execute
#
assert isinstance(output['raw_response'], dict) is True
paramgram_used = {
'device_username': 'admin', 'adom': 'ansible',
'device_ip': '10.7.220.152', 'state': 'present',
'device_unique_name': 'FGT2', 'device_serial':
None, 'device_password': 'fortinet',
'mode': 'execute'}
output = fmgr_device.discover_device(fmg_instance, paramgram_used)
#
# device_username: admin
# adom: ansible
# device_ip: 10.7.220.152
# state: present
# device_unique_name: FGT2
# device_serial: None
# device_password: fortinet
# mode: execute
#
assert isinstance(output['raw_response'], dict) is True
paramgram_used = {
'device_username': 'admin', 'adom': 'ansible',
'device_ip': '10.7.220.153', 'state': 'present',
'device_unique_name': 'FGT3', 'device_serial':
None, 'device_password': 'fortinet',
'mode': 'execute'}
output = fmgr_device.discover_device(fmg_instance, paramgram_used)
#
# device_username: admin
# adom: ansible
# device_ip: 10.7.220.153
# state: present
# device_unique_name: FGT3
# device_serial: None
# device_password: fortinet
# mode: execute
#
assert isinstance(output['raw_response'], dict) is True
def test_add_device(fixture_data, mocker):
mocker.patch(
"pyFMG.fortimgr.FortiManager._post_request",
side_effect=fixture_data)
paramgram_used = {
'device_username': 'admin', 'adom': 'ansible',
'device_ip': '10.7.220.151', 'state': 'present',
'device_unique_name': 'FGT1', 'device_serial':
None, 'device_password': 'fortinet',
'mode': 'execute'}
output = fmgr_device.add_device(fmg_instance, paramgram_used)
#
# device_username: admin
# adom: ansible
# device_ip: 10.7.220.151
# state: present
# device_unique_name: FGT1
# device_serial: None
# device_password: fortinet
# mode: execute
#
assert isinstance(output['raw_response'], dict) is True
paramgram_used = {
'device_username': 'admin', 'adom': 'ansible',
'device_ip': '10.7.220.152', 'state': 'present',
'device_unique_name': 'FGT2', 'device_serial':
None, 'device_password': 'fortinet',
'mode': 'execute'}
output = fmgr_device.add_device(fmg_instance, paramgram_used)
#
# device_username: admin
# adom: ansible
# device_ip: 10.7.220.152
# state: present
# device_unique_name: FGT2
# device_serial: None
# device_password: fortinet
# mode: execute
#
assert isinstance(output['raw_response'], dict) is True
paramgram_used = {
'device_username': 'admin', 'adom': 'ansible',
'device_ip': '10.7.220.151', 'state': 'present',
'device_unique_name': 'FGT1', 'device_serial':
None, 'device_password': 'fortinet',
'mode': 'execute'}
output = fmgr_device.add_device(fmg_instance, paramgram_used)
#
# device_username: admin
# adom: ansible
# device_ip: 10.7.220.151
# state: present
# device_unique_name: FGT1
# device_serial: None
# device_password: fortinet
# mode: execute
#
assert output['raw_response']['status']['code'] == -20010
paramgram_used = {
'device_username': 'admin', 'adom': 'ansible',
'device_ip': '10.7.220.152', 'state': 'present',
'device_unique_name': 'FGT2', 'device_serial':
None, 'device_password': 'fortinet',
'mode': 'execute'}
output = fmgr_device.add_device(fmg_instance, paramgram_used)
#
# device_username: admin
# adom: ansible
# device_ip: 10.7.220.152
# state: present
# device_unique_name: FGT2
# device_serial: None
# device_password: fortinet
# mode: execute
#
assert output['raw_response']['status']['code'] == -20010
paramgram_used = {
'device_username': 'admin', 'adom': 'ansible',
'device_ip': '10.7.220.153', 'state': 'present',
'device_unique_name': 'FGT3', 'device_serial':
None, 'device_password': 'fortinet',
'mode': 'execute'}
output = fmgr_device.add_device(fmg_instance, paramgram_used)
#
# device_username: admin
# adom: ansible
# device_ip: 10.7.220.153
# state: present
# device_unique_name: FGT3
# device_serial: None
# device_password: fortinet
# mode: execute
#
assert isinstance(output['raw_response'], dict) is True
def test_delete_device(fixture_data, mocker):
mocker.patch(
"pyFMG.fortimgr.FortiManager._post_request",
side_effect=fixture_data)
paramgram_used = {
'device_username': 'admin', 'adom': 'ansible',
'device_ip': '10.7.220.151', 'state': 'absent',
'device_unique_name': 'FGT1', 'device_serial':
None, 'device_password': 'fortinet',
'mode': 'execute'}
output = fmgr_device.delete_device(fmg_instance, paramgram_used)
#
# device_username: admin
# adom: ansible
# device_ip: 10.7.220.151
# state: absent
# device_unique_name: FGT1
# device_serial: None
# device_password: fortinet
# mode: execute
#
assert output['raw_response']['status']['code'] == 0
paramgram_used = {
'device_username': 'admin', 'adom': 'ansible',
'device_ip': '10.7.220.152', 'state': 'absent',
'device_unique_name': 'FGT2', 'device_serial':
None, 'device_password': 'fortinet',
'mode': 'execute'}
output = fmgr_device.delete_device(fmg_instance, paramgram_used)
#
# device_username: admin
# adom: ansible
# device_ip: 10.7.220.152
# state: absent
# device_unique_name: FGT2
# device_serial: None
# device_password: fortinet
# mode: execute
#
assert output['raw_response']['status']['code'] == 0
paramgram_used = {
'device_username': 'admin', 'adom': 'ansible',
'device_ip': '10.7.220.153', 'state': 'absent',
'device_unique_name': 'FGT3', 'device_serial':
None, 'device_password': 'fortinet',
'mode': 'execute'}
output = fmgr_device.delete_device(fmg_instance, paramgram_used)
#
# device_username: admin
# adom: ansible
# device_ip: 10.7.220.153
# state: absent
# device_unique_name: FGT3
# device_serial: None
# device_password: fortinet
# mode: execute
#
assert output['raw_response']['status']['code'] == 0