Skip to main content

The SOLIDserverRest is a library to drive EfficientIP API

Project description

License

Python 3 Updates pipeline status coverage report 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")

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


Download files

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

Source Distribution

SOLIDserverRest-2.1.5.tar.gz (22.2 kB view details)

Uploaded Source

Built Distribution

SOLIDserverRest-2.1.5-py3-none-any.whl (32.4 kB view details)

Uploaded Python 3

File details

Details for the file SOLIDserverRest-2.1.5.tar.gz.

File metadata

  • Download URL: SOLIDserverRest-2.1.5.tar.gz
  • Upload date:
  • Size: 22.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.25.0 setuptools/46.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.8

File hashes

Hashes for SOLIDserverRest-2.1.5.tar.gz
Algorithm Hash digest
SHA256 98e7419957d45f2198322c3be30955e2dd0538c74a4728462943c070e59376f8
MD5 4048ec8f765e99b5b3488dfa393bda95
BLAKE2b-256 91fd710c841b309ae88d97ef76a9a7d195e9fedb018d23fcf419558af2d879f8

See more details on using hashes here.

File details

Details for the file SOLIDserverRest-2.1.5-py3-none-any.whl.

File metadata

  • Download URL: SOLIDserverRest-2.1.5-py3-none-any.whl
  • Upload date:
  • Size: 32.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.25.0 setuptools/46.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.8

File hashes

Hashes for SOLIDserverRest-2.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 30167225b4d566f4955ead676879623688f2ce202c4bb38761ae6680e8998dc6
MD5 c67c82715b9d80329b7fcab7740a97e3
BLAKE2b-256 e51b83e42eb915e22e212ce9ddc4030f79b543f5c10cd3d22574ce977fd223c0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page