GitLocker: The Coding Marketplace

Description:

pfsensefauxapi 20200718.2

PfsenseFauxapi - Python Interface

Python client for pfSense-FauxAPI - https://github.com/ndejong/pfsense_fauxapi
Install
via PyPi
pip3 install pfsense-fauxapi

Install via Source
# obtain the source material
git clone https://github.com/ndejong/pfsense_fauxapi_client_python.git
cd pfsense_fauxapi_client_python
python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt
python3 setup.py clean
python3 setup.py test
python3 setup.py install

Code Examples
Three Python code samples are provided that demonstrate interface usage

function-iterate.py - iterates (almost) all the FauxAPI functions to confirm operation.
update-aws-aliases.py - downloads the latest AWS ip-ranges.json and populates the pfsense alias table(s).
usergroup-management.py - demonstrates the ability to manage users and groups programmatically.

Command Line
Additionally this pip-package provides a command-line interface to work with FauxAPI
usage: fauxapi [-h] [--host [host]] [--apikey [key]] [--apisecret [secret]]
[--verified-ssl] [--debug]
[function] [[function] ...] [[function-args]]

FauxAPI

optional arguments:
-h, --help show this help message and exit

Call:
--host [host] Host address of the target pfSense host with the
PfsenseFauxapi package installed.
--apikey [key] FauxAPI apikey value - alternatively via the
FAUXAPI_APIKEY environment variable.
--apisecret [secret] FauxAPI apisecret value - alternatively via the
FAUXAPI_APIKEY environment variable.
--verified-ssl Enable SSL certificate checks - default does NOT check
SSL certificates.
--debug Enable debug response from the remote FauxAPI -
helpful in tracking down issues.
[function] The FauxAPI function being called
[function-args] Arguments to the function, space separated

Command line example, using environment variables to pass the FAUXAPI_APIKEY
and FAUXAPI_APIKEY credentials.
$ fauxapi --host 192.168.1.200 gateway_status | jq .
{
"callid": "5c8d0f7361cba",
"action": "gateway_status",
"message": "ok",
"data": {
"gateway_status": {
"10.11.12.1": {
"monitorip": "10.10.10.1",
"srcip": "10.10.10.200",
"name": "WAN_DHCP",
"delay": "0.422ms",
"stddev": "0.073ms",
"loss": "0.0%",
"status": "none"
}
}
}
}