b1ddi Class¶
-
class
bloxone.
b1ddi
(cfg_file='config.ini')[source]¶ BloxOne DDI API Wrapper Class
-
add_tag
(objpath, id, tagname='', tagvalue='')[source]¶ Method to add a tag to an existing object Note: PUT/update Not Implemented in API as yet
- Parameters
objpath (str) – Swagger object path
id (str) – Object ID
tagname (str) – Name of tag to add
tagvalue (str) – Value to associate with tag
- Returns
Requests response object
- Return type
response object
-
create
(objpath, body='')[source]¶ Generic create object wrapper for ddi 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 ddi objects
- Parameters
objpath (str) – Swagger object path
id (str) – Object id to delete
- Returns
Requests response object
- Return type
response object
-
delete_tag
(objpath, id='', tagname='')[source]¶ Method to delete a tag from an existing On Prem Host
- Parameters
objpath (str) – Swagger object path
tagname (str) – Name of tag to add
- Returns
Requests response object
- Return type
response object
-
get
(objpath, id='', action='', **params)[source]¶ Generic get object wrapper for ddi objects
- 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)
-
get_object_by_key
(objpath, *, key='', value='', include_path=False)[source]¶ Get object using key/value pair
- Parameters
objpath (str) – Swagger object path
key (str) – name of key to match
value (str) – value to match
- Returns
object id or “”
- Return type
id (str)
-
get_option_ids
(option_space='')[source]¶ Return a dictionary of DHCP Option IDs Based on idea/code from John Neerdael
- Parameters
option_space (str) – Optional Option Space ID
- Returns
Dictionary keyed on option number of ids
- Return type
option_ids (dict)
Get tags for an object id
- Parameters
objpath (str) – Swagger object path
id (str) – id of object
- Returns
- Dictionary of current tags
or empty dict if none
- Return type
tags (dict)
Todo
make generic, however, this requires the below
Lookup dictionary of ‘required fields’ per object type
-
get_zone_child
(parent='zone', name='', id='', fields='')[source]¶ Method to retrieve Zones in specified view
- Parameters
name (str) – BloxOne object id
id (str) – BloxOne object id
**params (dict) – Generic API parameters
- Returns
Requests response object
- Return type
response object
-
replace
(objpath, id='', body='')[source]¶ Generic create object wrapper for ddi objects
- Parameters
objpath (str) – Swagger object path
body (str) – JSON formatted data payload
- Returns
Requests response object
- Return type
response object
-
search_response
(response, key='', value='', include_path=False)[source]¶ Get object id using key/value pair by searching a Request response object.
- Parameters
object (response) – Request response obj
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)
-