phpIPAM API implementation
Project description
phpipam-api
An incomplete phpIPAM API implementation in python.
import phpipam_api
ipam = phpipam_api.PhpipamAPI("https://phpipam.example.com/", "myapp", "apiuser", "p4s5word")
Usage:
data = ipam.<controller>.<operation>(<arguments>)
All functions return a dictionary object or a list of dictionary objects. Refer to the API Doc for data layout. If an error is encountered, an exception is raised.
Controllers
Functions shared by all controllers:
get()
returns all obejcts in in controllerbyID(object_id=<object id>)
get specific obejct by IDcreate(object_id=<object id>, data=<data>)
edit(object_id=<object id>, data=<data>)
delete(object_id=<object id>)
sections
getSubnets(section_id=<section id>)
subnets
search(search=<query>)
search for subnet by CIDRgetIP(subnet_id=<subnet id>, ip=<ip>)
get address object from subnet by IPgetAddresses(subnet_id=<subnet id>)
get all addresses in subnet
addresses
getByIP(subnet_id=<subnet id>, ip=<ip>)
getByTag(tag_id=<tag id>)
search(ip=<ip>)
getFirstFree(subnet_id=<subnet id>)
getTags()
getTag(tag_id=<tag id>)
createFirstFree(subnet_id=<subnet id>)
vlan
l2domains
vrf
devices
getAddresses(device_id=<device id>)
getSubnets(device_id=<device id>)
prefix
requires
dateutil
requests
License: MIT
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
phpipam-api-1.1.0.tar.gz
(4.4 kB
view hashes)
Built Distribution
Close
Hashes for phpipam_api-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6854f6776d170f9c4137bfca6f92c5d1450052def797b1b0fdd29b0bebaebba |
|
MD5 | b5ecb8a56670f2db76430c379cafef8d |
|
BLAKE2b-256 | 0e134dbc333a264de4d78f7185abe1ee0729b1cd7fedb8fcdbacbf5df22db6ee |