Classes Documentation

class bloxone.b1(cfg_file='config.ini')[source]

Parent Class to simplify access to the BloxOne APIs for subclasses

class bloxone.b1platform(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 (obj)

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 (obj)

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 (obj)

get_tags(objpath, id='')[source]

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

on_prem_hosts(**params)[source]

Method to retrieve On Prem Hosts (undocumented)

Parameters

**params (dict) – Generic API parameters

Returns

Requests response object

Return type

response (obj)

oph_add_tag(id='', tagname='', tagvalue='')[source]

Method to add a tag to an existing On Prem Host

Parameters
  • objpath (str) – Swagger object path

  • tagname (str) – Name of tag to add

  • tagvalue (str) – Value to associate

Returns

Requests response object

Return type

response (obj)

oph_delete_tag(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 (obj)

update(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 (obj)

class bloxone.b1ddi(cfg_file='config.ini')[source]
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 (obj)

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 (obj)

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 (obj)

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

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_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 (obj)

update(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 (obj)