Python API client library for Fortinet's FortiAnalyzer.
Project description
pyfortianalyzer
Python API client library for Fortinet's FortiAnalyzer.
It does not provide all endpoints or functionality available. We encourage to make a pull request with needed missing endpoints.
Note: This library has been built and tested for FortiAnalyzer v7.0.x.
Installation
To install run pip install pyfortianalyzer
.
Alternatively, you can clone the repo and run python setup.py install
.
Login handling
As the FortiAnalyzer API does not provide an expiration date/time when logging in, we've made some workarounds to handle login sessions without hitting the maximum login session limit in FortiAnalyzer.
We do this by checking if our session is still valid by hitting an API endpoint, and if not we log out with our old token and log in again to retrieve a new token before executing the actual requested API endpoint.
Additionally, we also use the standard Python module atexit
to gracefully log out during a Python script executing.
It's therefore not needed to login and logout in your code, as this library handles that for you.
Quick Start
To begin, import pyfortianalyzer and instantiate the API.
We need to provide the IP or FQDN to the FortiAnalyzer instance and a user with access to the API.
Optionally, its possible to set adom
which defaults to root
and verify
which defaults to True
.
Code
import pyfortianalyzer
fortianalyzer = pyfortianalyzer.api(
host = "https://fortianalyzer.example.com",
username = "apiuser",
password = "secret",
)
Examples
List all FortiGates.
There is a ton of data for a single FortiGate. This code retrieves all of it, but only prints the name of the FortiGates.
Code
faz_fortigates = fortianalyzer.fortigates.all()
for faz_fortigate in faz_fortigates['data']:
print(faz_fortigate['name'])
Output
FortiGate-VM64-1
FortiGate-VM64-2
FortiGate-VM64-3
Status object.
You can use the status object to check if the request is a success or not, and retrieve the error message.
Code
faz_fortigate = fortianalyzer.fortigates.all(fortigate="FortiGate-VM64-4")
if faz_fortigate['status']['code'] == 0:
print(faz_fortigate['data']['name'])
else:
print(faz_fortigate['status'])
Output
"status": {
"code": -3,
"message": "Object does not exist"
}
Adding a FortiGate
This adds a FortiGate in the Device Manager with the minimum required fields.
Code
faz_fortigate_add = fortianalyzer.fortigates.add(
serial = "FGT60FTK1234ABCD"
)
print(faz_fortigate_add)
Output
{
"data": {
"device": {
"beta": -1,
"conn_mode": 1,
"dev_status": 1,
"flags": 67371008,
"hostname": "FGT60FTK1234ABCD",
"maxvdom": 10,
"mgmt_id": 965165689,
"mgmt_mode": 2,
"mr": -1,
"name": "FGT60FTK1234ABCD",
"oid": 3999,
"os_type": 0,
"os_ver": -1,
"patch": -1,
"platform_id": 19,
"platform_str": "FortiGate-60F",
"sn": "FGT60FTK1234ABCD",
"source": 1,
"tab_status": "<unknown>"
}
},
"status": {
"code": 0,
"message": "OK"
},
"url": "/dvm/cmd/add/device"
}
Updating a FortiGate
This updates a FortiGate in the Device Manager.
Code
faz_fortigate_update = fortianalyzer.fortigates.update(
fortigate = "FortiGate-VM64-1",
description = "Test FortiGate"
)
print(faz_fortigate_update)
Output
{
"data": {
"name": "FortiGate-VM64-1"
},
"status": {
"code": 0,
"message": "OK"
},
"url": "/dvmdb/adom/root/device/FortiGate-VM64-1"
}
Deleting a FortiGate
This deletes a FortiGate in the Device Manager.
Code
faz_fortigate_delete = fortianalyzer.fortigates.delete(
fortigate = "FortiGate-VM64-1"
)
print(faz_fortigate_delete)
Output
{
"status": {
"code": 0,
"message": "OK"
},
"url": "/dvm/cmd/del/device"
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pyfortianalyzer-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0def63359f694c717e09367c795f3a2cdee0a094e8a3c87eec0daf4cccf45912 |
|
MD5 | ed9b7053bf6dc389a781f0415cd7f0bd |
|
BLAKE2b-256 | 70c67ebfaeb92c4712b2a6c604a2eb8e6e86e4062bc8ecef04f102f234458bc4 |