The SOLIDserverRest is a library to drive EfficientIP API
Project description
SOLIDserverRest
This 'SOLIDserverRest' allows to easily interact with SOLIDserver's REST API. It allows managing all IPAM objects through CRUD operations.
- Free software: BSD2 License
This 'SOLIDserverRest' is compatible with SOLIDserver version 6.0.1P3 and higher.
Install
Install 'SOLIDserverRest' using pip in your virtualenv:
pip install SOLIDserverRest
Usage
Using the SOLIDserverRest object
1. Declare endpoint API point
Set the API endpoint you want to talk with through API. Could use an IP address (v4 or v6) or a host name
- host = IP address of the SOLIDserver server
con = SOLIDserverRest("fqdn_host.org")
2. Specify connection method
You can use native connection mode using SOLIDserver default method which provide authentication through headers in the requests with information encoded in base64
- user = user who want to use
- password = password of the user
con.use_native_sds(user="apiuser", password="apipwd")
You can also use the basic authentication method for connecting the SOLIDserver.
- user = user who want to use
- password = password of the user
con.use_basicauth_sds(user="apiuser", password="apipwd")
3. Set TLS security
SSL certificate chain is validated by default, to disable it, use the set_ssl_verify method
con.set_ssl_verify(False) # True by default
rest_answer = con.query("method", "parameters")
Otherwise, you have to provide the certificate file:
con = SOLIDserverRest(SERVER)
If the certificate file is not valide, an exception SDSInitError
is raised.
4. Request to SOLIDserver API
You need parameters:
- method = choose your method in the list below
- parameters = Python dictionary with parameters you want to use
rest_answer = con.query("method", "parameters")
5. Analyze answer
- rest_answer => object name
- rest_answer.status_code => current http answer code set in the object
- rest_answer.content => Answer core from SOLIDserver API set in the object
Example:
print(rest_answer)
print(rest_answer.status_code)
print(rest_answer.content)
Methods that could be used
Methods are organized to match the ontology used in SOLIDServer, you will find:
- Sites - address spaces
- Subnets (v4 and v6)
- Pools (v4 and v6)
- Addresses (v4 and v6)
- Aliases (v4 and v6)
More information about supported methods in the specific document
Supported SOLIDserver modules in methods are:
- ip (IPAM - IP Address Management)
- app (Application and GSLB management) - starting with release 7.1 of SOLIDserver
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 SOLIDserverRest-2.1.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1a3ab56823c55fc687900ec1762f69561937be56afebb72b61af2a23521993f |
|
MD5 | 0b302408b26da0326938cef3e263a6ce |
|
BLAKE2b-256 | fb03d95330f29e651cf45eedcfd472af7706946b2faa2beb229aa815512cda39 |