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 7 and ownward.
Install
Install 'SOLIDserverRest' using pip in your virtualenv:
pip install SOLIDserverRest
Usage
Using the SOLIDserverRest advanced object (recommended)
All commands and object manipulation are going through a SOLIDserver main object, handling the connection to the manager and pushing API calls. The creation of a SOLIDserver object is done like that:
from SOLIDserverRest import *
from SOLIDserverRest import adv as sdsadv
SDS_HOST = "192.168.254.254"
SDS_LOGIN = "foo"
SDS_PWD = "bar"
sds = sdsadv.SDS(ip_address=SDS_HOST,
user=SDS_LOGIN,
pwd=SDS_PWD)
try:
sds.connect(method="native")
except SDSError as e:
logging.error(e)
exit(1)
print(adv)
More examples in the example directory.
Using the SOLIDserverRest object
The raw API is mapped using the SOLIDserverRest object which handle the connection, prepare the formating and handle some errors. It can be usefull twhen the advanced library is not yet implementing an object that you require in your code.
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)
- DNS servers, views, zones, RR, acl, key
- application manager
- DHCP server, scope, shared net, range, static, group, options
- device manager
- VLAN manager
More information about supported methods in the specific document
Tests
Last set of tests run on 19/Feb/2024 using:
- SOLIDserver release 8.3.2
- python libs:
- chardet 5.2.0
- urllib3 1.26.18
- idna 3.6
- requests 2.31.0
- PySocks 1.7.1
- pyOpenSSL 24.0.0
- packaging 23.2
coverage results
---------- coverage: platform win32, python 3.11.3-final-0 -----------
Name Stmts Miss Cover
---------------------------------------------------------
SOLIDserverRest\Exception.py 25 4 84%
SOLIDserverRest\SOLIDserverRest.py 137 17 88%
SOLIDserverRest\__init__.py 5 0 100%
SOLIDserverRest\adv\__init__.py 13 0 100%
SOLIDserverRest\adv\base.py 117 12 90%
SOLIDserverRest\adv\class_params.py 82 3 96%
SOLIDserverRest\adv\device.py 87 72 17%
SOLIDserverRest\adv\device_tools.py 128 113 12%
SOLIDserverRest\adv\devif.py 122 99 19%
SOLIDserverRest\adv\dns.py 150 5 97%
SOLIDserverRest\adv\dns_record.py 336 105 69%
SOLIDserverRest\adv\dns_zone.py 124 15 88%
SOLIDserverRest\adv\ipaddress.py 128 0 100%
SOLIDserverRest\adv\network.py 185 1 99%
SOLIDserverRest\adv\sds.py 118 3 97%
SOLIDserverRest\adv\space.py 56 1 98%
SOLIDserverRest\adv\validators.py 28 6 79%
SOLIDserverRest\mapper.py 22 0 100%
---------------------------------------------------------
TOTAL 1863 456 76%
2 maintainers
Metadata
2 maintainers
Release files for SOLIDserverRest 2.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| SOLIDserverRest-2.4.0.tar.gz | 39.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| SOLIDserverRest-2.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 84.3 kB
Release files / SOLIDserverRest-2.4.0.tar.gz
| Download URL | SOLIDserverRest-2.4.0.tar.gz |
|---|---|
| Size | 39.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
904be05b33654a0f4982e1d3271ed7e29e0329c4043c12e0253f0242d17c51fa
|
|
BLAKE2b-256 checksum How to use checksums |
658fd9f0bfd55cda48efe909ed0765c12102ad9fa545927cbde8ec0b2ebf229b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.11.3
|
Release files / SOLIDserverRest-2.4.0-py3-none-any.whl
| Download URL | SOLIDserverRest-2.4.0-py3-none-any.whl |
|---|---|
| Size | 44.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
663276c4866599595b7bd3d8facdc92346c35232ea7266df5c6ccffff926c770
|
|
BLAKE2b-256 checksum How to use checksums |
980d8e5c54d62da0138c31f3b933bf0ff1d5b17d47a12ef55e3b6095f2c21a2f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.11.3
|
