b1ztp Class¶
-
class
bloxone.b1ztp(cfg_file='config.ini')[source]¶ Class to simplify access to the BloxOne Platform APIs
-
create(objpath, body='')[source]¶ Generic create object wrapper for platform objects
Parameters: - objpath (str) – Swagger object path
- body (str) – JSON formatted data payload
Returns: Requests response object
Return type: response object
-
delete(objpath, id='')[source]¶ Generic delete object wrapper for platform objects
Parameters: - objpath (str) – Swagger object path
- id (str) – Object id to delete
Returns: Requests response object
Return type: response object
-
get(objpath, id='', action='', **params)[source]¶ Generic get object wrapper for platform calls
Parameters: - objpath (str) – Swagger object path
- id (str) – Optional Object ID
- action (str) – Optional object action, e.g. “nextavailableip”
Returns: Requests response object
Return type: response object
-
get_id(objpath, *, key='', value='', include_path=False)[source]¶ Get object id using key/value pair
Parameters: - objpath (str) – Swagger object path
- key (str) – name of key to match
- value (str) – value to match
- include_path (bool) – Include path to object id
Returns: object id or “”
Return type: id (str)
-