Generic REST API Driver

We implement a generic REST APi driver, to be used by other drivers. This RestConnector() class is defined in switches/connect/restconnector.py.

This implements generic HTTP GET, PUT, POST and DELETE functions.

API login, and setting tokens, cookies, etc. for subsequent request should be performed by the driver classes, as these differ by REST server implementation.

We provide the ‘standard’ query parameters, cookie header, and post data options as are defined in the Python Request package. See https://requests.readthedocs.io/en/latest/ for more.

In general:

• GET is used to read device data

• PUT is used to update device settings, eg. interface status, PoE status, etc.

• POST is used to create new settings, e.g. create a new vlan

• DELETE is used to remove settings, e.g. remote a vlan, or in some cases remove an attribute from an interface.

This class is used at time of writing by: * Aruba AOS-S REST api driver * HPE Comware REST api driver