Skip to main content

The SOLIDserverRest is a library to drive EfficientIP API

Project description

Build status License Updates Python 3 Codecov branch PyPI - Python Version Documentation Status

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")
  1. Specify connection method Only native connection is supported for this version, using SSD default method and providing 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_ssd(user="apiuser", password="apipwd")
  1. Request to SOLIDserver API

You need parameters:

  • method = choose your method in the list below
  • parameters = Python dico with parameters you want to use
  • ssl_verify = this option permits to check your server SSL certificate. To check the certificate, you must set ssl_verify=True
	rest_answer = con.query("method", "parameters", ssl_verify=True)
  1. 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 SSD modules in methods are:

-ip (IPAM - IP Address Management)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for SOLIDserverRest, version 1.5.1
Filename, size File type Python version Upload date Hashes
Filename, size SOLIDserverRest-1.5.1.tar.gz (5.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page