viniarck / phpipam-pyclient

:gem: REST client and CLI tool to interface with phpipam REST API

phpipam-pyclient

phpipam-pyclient is a REST-client CLI tool to interface with phpipam REST API. phpipam-pyclient leverages python fire and requests under the hood, some high level functions have been implemented to allow the user to quickly query certain information about the devices on phpipam. In addition, you can use this library to build your Ansible inventory by filtering a field/column of the devices on phpipam.

Installation

Currently, the only supported installation is directly via checking the code from GitHub. After completing the installation, you have to configure the parameters to authenticate your user on phpipam in the phpipam_pyclient/config.json file. You can find more information, examples and usage on ReadTheDocs.

via GitHub

git clone https://github.com/viniarck/phpipam-pyclient.git
cd phpipam-pyclient
virtualenv -p python3 .venv
source .venv/bin/activate
pip install -e .

Changelog

CHANGELOG.md

phpipam-pyclient's Issues

Release 0.1 on pypi

Class documentation typo "PPHIpam"

I happened to notice this typo while looking for a phpIPAM API client library.

phpipam-pyclient/phpipam_pyclient/phpipam_pyclient.py

Line 23 in e83e445

"""PPHIpam Python client

Add pypi badge

Update readme and clean up

question about list-vlans & add-vlan functions

hello, thanks for your phpipam-pyclient
try to add few functions like vrf/vlan adding
sooo
can't understand how to add vlans
example: if I take list-devices code-block
and change device to vlan I got list-vlans - that work fine

but if I try to do the same and switch from add-device to add-vlan that did not work, can you help me with that or try to show me the way where I need to go?

thank you

Looking for a maintainer

Hi phpipam-pyclient users, I'm looking for a new maintainer, since I'ts been a few years since I was using phpipam constantly. The last 1.4 release https://phpipam.net/news/phpipam-v1-4-released/ is still being supported and it's cool that there are a few new features such as encryption of the payload in the API and other minor things. I won't be able to keep maintaining this project. Thank you all for using it, I hope it's been useful for the past years.

Cheers.

Support phpipam version 1.4

In the next weeks, I'll check the support for the current version 1.4 of phpipam