aboutsummaryrefslogtreecommitdiff
path: root/phpipam/__init__.py
diff options
context:
space:
mode:
authorGravatar Jonas Gunz <himself@jonasgunz.de> 2020-12-11 01:08:37 +0100
committerGravatar Jonas Gunz <himself@jonasgunz.de> 2020-12-11 01:08:37 +0100
commit75204dcd93a06699669e51f6e34487aacbcde6a7 (patch)
tree9baca3c9b86c3d8563ef67fd87245447707e9243 /phpipam/__init__.py
parent17bd5b60a6d1445d208c1486c5b937c7f7881154 (diff)
downloadpython-phpipam-75204dcd93a06699669e51f6e34487aacbcde6a7.tar.gz
error handling, doc
Diffstat (limited to 'phpipam/__init__.py')
-rwxr-xr-xphpipam/__init__.py21
1 files changed, 20 insertions, 1 deletions
diff --git a/phpipam/__init__.py b/phpipam/__init__.py
index 89d8280..caf217e 100755
--- a/phpipam/__init__.py
+++ b/phpipam/__init__.py
@@ -4,12 +4,31 @@ from .resources import phpipamResource
class phpipam:
"""
phpIPAM API Implementation
- ReadOnly because I don't need the writing bit
+
+ Attributes
+ ----------
+ sections
+ subnets
+ addresses
+ devices
https://phpipam.net/api-documentation/
"""
def __init__(self, api_url, app_id, api_user, api_password):
+ """
+ Parameters
+ ----------
+ api_url : str
+ URL of phpIPAM instance. Example: https://phpipam.example.com/
+ app_id : str
+ AppID configrued in API settings
+ api_user : str
+ username, leave empty to use static token authentification
+ api_password : str
+ password or static authentification token
+ """
+
self._backend = phpipamBackend(api_url, app_id, api_user, api_password)
def __getattr__(self, item):