infoblox¶

An unofficial python library for interfacing with Infoblox NIOS. This library is not affiliated with Infoblox, Inc. in any way.

Requirements¶

Python 2.6, 2.7, 3.2, 3.3

External dependencies:

argparse (Python 2.6 only)
requests

Installation¶

infoblox is available on the Python Package Index and can be installed with easy_install or pip:

pip install infoblox

API Documentation¶

The following classes are available for interaction with the Infoblox NIOS device:

CLI Usage¶

usage: infoblox-host     usage: infoblox-host [-h] [--version] [--debug] [-u USERNAME] [-p PASSWORD]
          <Infoblox Address> {add,remove} <FQDN> [IPv4 Address] [COMMENT]

Add or remove a host from the Infoblox appliance

positional arguments:
  <Infoblox Address>    The Infoblox hostname
  {add,remove}          Specify if you are adding or removing a host
  <FQDN>                The FQDN for the host
  [IPv4 Address]        The IPv4 address for the host
  [COMMENT]             A comment set on the host when adding.

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --debug               Enable debug output
  -u USERNAME, --username USERNAME
                        The username to perform the work as. Default: admin
  -p PASSWORD, --password PASSWORD
                        The password to authenticate with. Default: infoblox

Contents¶

infoblox API¶

To interact with an Infoblox device, you must first create a Session object instance that will be passed to any object you create. The following example shows how to create a host.:

import infoblox

session = infoblox.Session('127.0.0.1', 'admin', 'infoblox')
host = infoblox.Host(session)
host.name = 'foo.bar.net'
host.add_ipv4addr('10.0.0.1')
if host.save():
    print('Host saved')

class infoblox.Session(host, username=None, password=None, https=True)[source]¶: Central object for managing HTTP requests to the Infoblox appliance.

class infoblox.Host(session, reference_id=None, name=None, **kwargs)[source]¶

Implements the host record type.

Example:

session = infoblox.Session(infoblox_host,
                           infoblox_user,
                           infoblox_password)
host = infoblox.Host(session, name='foo.bar.net')

add_ipv4addr(ipv4addr)[source]¶

Add an IPv4 address to the host.

Parameters:	ipv4addr (str) – The IP address to add.
Raises:	ValueError

add_ipv6addr(ipv6addr)[source]¶

Add an IPv6 address to the host.

Parameters:	ipv6addr (str) – The IP address to add.
Raises:	ValueError

as_dict()¶

Return this object as a dict value.

Return type:	dict

clear()¶: Clear all set attributes in the mapping.

delete()¶

Remove the item from the infoblox server.

Return type:	bool
Raises:	AssertionError
Raises:	ValueError
Raises:	infoblox.exceptions.ProtocolError

dirty¶

Indicate if the mapping has changes from it’s initial state

Return type:	bool

dumps()¶

Return a JSON serialized version of the mapping.

Return type:	str\|unicode

fetch()¶

Attempt to fetch the object from the Infoblox device. If successful the object will be updated and the method will return True.

Return type:	bool
Raises:	infoblox.exceptions.ProtocolError

from_dict(values)¶

Assign the values from the dict passed in. All items in the dict are assigned as attributes of the object.

Parameters:	values (dict) – The dictionary of values to assign to this mapping

get(key, default=None)¶

Get the value of key, passing in a default value if it is not set.

Parameters:	key (str) – The attribute to get default (mixed) – The default value
Return type:	mixed

items()¶

Return a list of attribute name and value tuples for this mapping.

Return type:	list

iteritems()¶

Iterate through a list of the attribute names and their values.

Return type:	listiterator

iterkeys()¶

Iterate through the attribute names for this mapping.

Return type:	listiterator

itervalues()¶

Iterate through a list of the attribute values for this mapping.

Return type:	listiterator

keys()¶

Return a list of attribute names for the mapping.

Return type:	list

loads(value)¶

Load in a serialized value, overwriting any previous values.

Parameters:	value (str\|unicode) – The serialized value

reference_id()¶: Return a read-only handle for the reference_id of this object.

remove_ipv4addr(ipv4addr)[source]¶

Remove an IPv4 address from the host.

Parameters:	ipv4addr (str) – The IP address to remove

remove_ipv6addr(ipv6addr)[source]¶

Remove an IPv6 address from the host.

Parameters:	ipv6addr (str) – The IP address to remove

save()¶

Update the infoblox with new values for the specified object, or add the values if it’s a new object all together.

Raises:	AssertionError
Raises:	infoblox.exceptions.ProtocolError

set(key, value)¶

Set the value of key.

Parameters:	key (str) – The attribute to set value (mixed) – The value to set
Raises:	KeyError

values()¶

Return a list of values for this mapping in attribute name order.

:rtype list

class infoblox.HostIPv4(session, reference_id=None, ipv4addr=None, **kwargs)[source]¶

Implements the host_ipv4addr record type.

as_dict()¶

Return this object as a dict value.

Return type:	dict

clear()¶: Clear all set attributes in the mapping.

delete()¶

Remove the item from the infoblox server.

Return type:	bool
Raises:	AssertionError
Raises:	ValueError
Raises:	infoblox.exceptions.ProtocolError

dirty¶

Indicate if the mapping has changes from it’s initial state

Return type:	bool

dumps()¶

Return a JSON serialized version of the mapping.

Return type:	str\|unicode

fetch()¶

Attempt to fetch the object from the Infoblox device. If successful the object will be updated and the method will return True.

Return type:	bool
Raises:	infoblox.exceptions.ProtocolError

from_dict(values)¶

Assign the values from the dict passed in. All items in the dict are assigned as attributes of the object.

Parameters:	values (dict) – The dictionary of values to assign to this mapping

get(key, default=None)¶

Get the value of key, passing in a default value if it is not set.

Parameters:	key (str) – The attribute to get default (mixed) – The default value
Return type:	mixed

items()¶

Return a list of attribute name and value tuples for this mapping.

Return type:	list

iteritems()¶

Iterate through a list of the attribute names and their values.

Return type:	listiterator

iterkeys()¶

Iterate through the attribute names for this mapping.

Return type:	listiterator

itervalues()¶

Iterate through a list of the attribute values for this mapping.

Return type:	listiterator

keys()¶

Return a list of attribute names for the mapping.

Return type:	list

loads(value)¶

Load in a serialized value, overwriting any previous values.

Parameters:	value (str\|unicode) – The serialized value

reference_id()¶: Return a read-only handle for the reference_id of this object.

save()¶

Update the infoblox with new values for the specified object, or add the values if it’s a new object all together.

Raises:	AssertionError
Raises:	infoblox.exceptions.ProtocolError

set(key, value)¶

Set the value of key.

Parameters:	key (str) – The attribute to set value (mixed) – The value to set
Raises:	KeyError

values()¶

Return a list of values for this mapping in attribute name order.

:rtype list

class infoblox.HostIPv6(session, reference_id=None, ipv6addr=None, ipv6bits=None, ipv6prefix_bits=None, **kwargs)[source]¶

Implements the host_ipv6addr record type.

as_dict()¶

Return this object as a dict value.

Return type:	dict

clear()¶: Clear all set attributes in the mapping.

delete()¶

Remove the item from the infoblox server.

Return type:	bool
Raises:	AssertionError
Raises:	ValueError
Raises:	infoblox.exceptions.ProtocolError

dirty¶

Indicate if the mapping has changes from it’s initial state

Return type:	bool

dumps()¶

Return a JSON serialized version of the mapping.

Return type:	str\|unicode

fetch()¶

Attempt to fetch the object from the Infoblox device. If successful the object will be updated and the method will return True.

Return type:	bool
Raises:	infoblox.exceptions.ProtocolError

from_dict(values)¶

Assign the values from the dict passed in. All items in the dict are assigned as attributes of the object.

Parameters:	values (dict) – The dictionary of values to assign to this mapping

get(key, default=None)¶

Get the value of key, passing in a default value if it is not set.

Parameters:	key (str) – The attribute to get default (mixed) – The default value
Return type:	mixed

items()¶

Return a list of attribute name and value tuples for this mapping.

Return type:	list

iteritems()¶

Iterate through a list of the attribute names and their values.

Return type:	listiterator

iterkeys()¶

Iterate through the attribute names for this mapping.

Return type:	listiterator

itervalues()¶

Iterate through a list of the attribute values for this mapping.

Return type:	listiterator

keys()¶

Return a list of attribute names for the mapping.

Return type:	list

loads(value)¶

Load in a serialized value, overwriting any previous values.

Parameters:	value (str\|unicode) – The serialized value

reference_id()¶: Return a read-only handle for the reference_id of this object.

save()¶

Update the infoblox with new values for the specified object, or add the values if it’s a new object all together.

Raises:	AssertionError
Raises:	infoblox.exceptions.ProtocolError

set(key, value)¶

Set the value of key.

Parameters:	key (str) – The attribute to set value (mixed) – The value to set
Raises:	KeyError

values()¶

Return a list of values for this mapping in attribute name order.

:rtype list

infoblox¶

Requirements¶

Installation¶

API Documentation¶

CLI Usage¶

Contents¶

infoblox API¶

Indices and tables¶