infoblox-client 0.4.22

===============================
Infoblox Client
===============================

.. image:: https://travis-ci.org/infobloxopen/infoblox-client.svg?branch=master
:target: https://travis-ci.org/infobloxopen/infoblox-client

.. image:: https://img.shields.io/pypi/v/infoblox-client.svg
:target: https://pypi-hypernode.com/pypi/infoblox-client

.. image:: https://codecov.io/github/infobloxopen/infoblox-client/coverage.svg?branch=master
:target: https://codecov.io/github/infobloxopen/infoblox-client?branch=master

.. image:: https://readthedocs.org/projects/infoblox-client/badge/?version=latest
:target: http://infoblox-client.readthedocs.org/en/latest/?badge=latest

Client for interacting with Infoblox NIOS over WAPI.

* Free software: Apache license
* Documentation: https://infoblox-client.readthedocs.org.

Installation
------------

Install infoblox-client using pip:

::

pip install infoblox-client

Usage
-----

Configure logger prior to loading infoblox_client to get all debug messages in console:

.. code:: python

import logging
logging.basicConfig(level=logging.DEBUG)

Low level API, using connector module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Retrieve list of network views from NIOS:

.. code:: python

from infoblox_client import connector

opts = {'host': '192.168.1.10', 'username': 'admin', 'password': 'admin'}
conn = connector.Connector(opts)
# get all network_views
network_views = conn.get_object('networkview')
# search network by cidr in specific network view
network = conn.get_object('network', {'network': '100.0.0.0/8', 'network_view': 'default'})


For these request data is returned as list of dicts:

.. code:: python

network_views:
[{u'_ref': u'networkview/ZG5zLm5ldHdvcmtfdmlldyQw:default/true',
u'is_default': True,
u'name': u'default'}]

network:
[{u'_ref': u'network/ZG5zLm5ldHdvcmskMTAwLjAuMC4wLzgvMA:100.0.0.0/8/default',
u'network': u'100.0.0.0/8',
u'network_view': u'default'}]

High level API, using objects
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Example of creating Network View, Network, DNS View, DNSZone and HostRecord using NIOS objects:

.. code:: python

from infoblox_client import connector
from infoblox_client import objects

opts = {'host': '192.168.1.10', 'username': 'admin', 'password': 'admin'}
conn = connector.Connector(opts)

Create a network view, and network:

.. code:: python

nview = objects.NetworkView.create(conn, name='my_view')
network = objects.Network.create(conn, network_view='my_view', cidr='192.168.1.0/24')

Create a DNS view and zone:

.. code:: python

view = objects.DNSView.create(conn, network_view='my_view', name='my_dns_view')
zone = objects.DNSZone.create(conn, view='my_dns_view', fqdn='my_zone.com')

Create a host record:

.. code:: python

my_ip = objects.IP.create(ip='192.168.1.25', mac='aa:bb:cc:11:22:33')
hr = objects.HostRecord.create(conn, view='my_dns_view',
name='my_host_record.my_zone.com', ip=my_ip)

Create host record with Extensible Attributes (EA):

.. code:: python

ea = objects.EA({'Tenant ID': tenantid, 'CMP Type': cmptype,
'Cloud API Owned': True})
host = objects.HostRecord.create(conn, name='new_host', ip=my_ip, extattrs=ea)

Set the TTL to 30 minutes:

.. code:: python

hr = objects.HostRecord.create(conn, view='my_dns_view',
name='my_host_record.my_zone.com', ip=my_ip,
ttl = 1800)

Create a new host record, from the next available IP in a CIDR, with a MAC address, and DHCP enabled:

.. code:: python

next = objects.IPAllocation.next_available_ip_from_cidr('default', '10.0.0.0/24')
my_ip = objects.IP.create(ip=next, mac='aa:bb:cc:11:22:33', configure_for_dhcp=True)
host = objects.HostRecord.create(conn, name='some.valid.fqdn', view='Internal', ip=my_ip)

Reply from NIOS is parsed back into objects and contains next data:

.. code:: python

In [22]: hr
Out[22]: HostRecordV4: _ref=record:host/ZG5zLmhvc3QkLjQuY29tLm15X3pvbmUubXlfaG9zdF9yZWNvcmQ:my_host_record.my_zone.com/my_dns_view, name=my_host_record.my_zone.com, ipv4addrs=[<infoblox_client.objects.IPv4 object at 0x7f7d6b0fe9d0>], view=my_dns_view

High level API, using InfobloxObjectManager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Create a new fixed address, selecting it from the next available IP in a CIDR:

.. code:: python

from infoblox_client.object_manager import InfobloxObjectManager

new_address = InfobloxObjectManager(conn).create_fixed_address_from_cidr(netview='default', mac='aa:bb:cc:11:22:33', cidr='10.0.0.0/24', extattrs=[])

What you get back is a ``FixedAddressV4`` object.

Objects Interface
-----------------

All top level objects support interface for CRUD operations. List of supported objects is defined in next section.

- ``create(cls, connector, check_if_exists=True, update_if_exists=False, **kwargs)``
Creates object on NIOS side.
Requires connector passed as the first argument, ``check_if_exists`` and ``update_if_exists`` are optional.
Object related fields are passed in as kwargs: ``field=value``, ``field2=value2``.

- ``search(cls, connector, return_fields=None, search_extattrs=None, force_proxy=False, **kwargs)``
Search single object on NIOS side, returns first object that match search criteria.
Requires connector passed as the first argument.
``return_fields`` can be set to retrieve particular fields from NIOS,
for example ``return_fields=['view', 'name']``.
If ``return_fields`` is ``[]`` default ``return_fields`` are returned by NIOS side for current ``wapi_version``.
``search_extattrs`` is used to filter out results by extensible attributes.
``force_proxy`` forces search request to be processed on Grid Master (applies only in cloud environment)

- ``search_all(cls, connector, return_fields=None, search_extattrs=None, force_proxy=False, **kwargs)``
Search all objects on NIOS side that match search criteria. Returns a list of objects.
All other options are equal to ``search()``.

- ``update(self)``
Update the object on NIOS side by pushing changes done in the local object.

- ``delete(self)``
Deletes the object from NIOS side.

Supported NIOS objects
----------------------

* ``NetworkView`` for 'networkview'
* ``DNSView`` for 'view'
* ``DNSZone`` for 'zone_auth'
* ``Member`` for 'member'
* ``Network`` (V4 and V6)

* ``NetworkV4`` for 'network'
* ``NetworkV6`` for 'ipv6network'

* ``IPRange`` (V4 and V6)

* ``IPRangeV4`` for 'range'
* ``IPRangeV6`` for 'ipv6range'

* ``HostRecord`` (V4 and V6)

* ``HostRecordV4`` for 'record:host'
* ``HostRecordV6`` for 'record:host'

* ``FixedAddress`` (V4 and V6)

* ``FixedAddressV4`` for 'fixedaddress'
* ``FixedAddressV6`` for 'ipv6fixedaddress'

* ``IPAddress`` (V4 and V6)

* ``IPv4Address`` for 'ipv4address'
* ``IPv6Address`` for 'ipv6address'

* ``ARecordBase``

* ``ARecord`` for 'record:a'
* ``AAAARecord`` for 'record:aaaa'

* ``PtrRecord`` (V4 and V6)

* ``PtrRecordV4`` for 'record:ptr'
* ``PtrRecordV6`` for 'record:ptr'

* ``EADefinition`` for 'extensibleattributedef'
* ``CNAMERecord`` for 'record:cname'


Search by regular expression
----------------------------

Search for partial match is supported only by low-level API for now.
Use '~' with field name to search by regular expressions. Not all
fields support search by regular expression. Refer to wapidoc to find
out complete list of fields that can be searched this way. Examples:

Find all networks that starts with '10.10.':

.. code:: python

conn = connector.Connector(opts)
nw = conn.get_object('network', {'network~': '10.10.'})


Find all host records that starts with '10.10.':

.. code:: python

conn = connector.Connector(opts)
hr = conn.get_object('record:host', {'ipv4addr~': '10.10.'})


More examples
-------------

Utilizing extensible attributes and searching on them can easily be done with the ``get_object`` function.
The ``default`` field in ``return_fields`` acts like the ``+`` does in WAPI.

> ``_return_fields+`` Specified list of fields (comma separated) will be returned in addition
to the basic fields of the object (documented for each object).

This enables you to always get the default values in return, in addition to what you specify whether
you search for a ``network`` or a ``networkcontainer``,
defined as ``place_to_check`` in the code below.


.. code:: python

from infoblox_client.connector import Connector


def default_infoblox_connection():
opts = {'host': '192.168.1.10', 'username': 'admin', 'password': 'admin'}
conn = Connector(opts)
return conn

def search_extensible_attribute(connection, place_to_check: str, extensible_attribute: str, value: str):
"""
Find extensible attributes.
:param connection: Infoblox connection
:param place_to_check: Can be `network`, `networkcontainer` or `record:host` and so on.
:param extensible_attribute: Which extensible attribute to search for. Can be `CustomerCode`, `Location`
and so on.
:param value: The value you want to search for.
:return: result
"""
extensible_args = [
place_to_check,
{
f"*{extensible_attribute}:~": value,
}
]
kwargs = {
'return_fields': [
'default',
'extattrs',
]
}
result = {"type": f"{place_to_check}", "objects": connection.get_object(*extensible_args, **kwargs)}
return result

connection = default_infoblox_connection()

search_network = search_extensible_attribute(connection, "network", "CustomerCode", "Infoblox")
# Print the output:
print(search_network)
{
"type": "network",
"objects": [
{
"_ref": "network/ZG5zLmhvc3QkLjQuY29tLm15X3pvbmUubXlfaG9zdF9yZWNvcmQ:192.168.1.1/28/default",
"comment": "Infoblox Network",
"extattrs": {
"CustomerCode": {
"value": "Infoblox"
}
},
"network": "192.168.1.0/28",
"network_view": "default"
}
]
}

search_host = search_extensible_attribute(connection, "record:host", "CustomerCode", "Infoblox")
# Print the output:
print(search_host)
{
"type": "record:host",
"objects": [
{
"_ref": "record:host/ZG5zLm5ldHdvcmtfdmlldyQw:InfobloxHost",
"extattrs": {
"CustomerCode": {
"value": "Infoblox"
}
},
"ipv4addrs": [
{
"_ref": "record:host_ipv4addr/ZG5zLm5ldHdvcmtfdmlldyQwdvcmtfdmlldyQw:192.168.1.1/InfobloxHost",
"configure_for_dhcp": false,
"host": "InfobloxHost",
"ipv4addr": "192.168.1.1"
}
],
"name": "InfobloxHost",
"view": " "
}
]
}

Features
--------

* TODO




History
-------

0.4.22 (2019-02-21)
___________________

* Supported returning default fileds plus user required fields reflecting WAPI
* Supporting 'aliases' parameter of HOST record for DNS

0.4.21 (2019-01-18)
___________________

* Supporting wapi version 2.10 or above

0.4.20 (2018-03-27)
___________________

* Updated default WAPI version from 1.4 to 2.1

0.4.19 (2018-02-06)
___________________

* Changed logging of failure on object search from Error to Warning

0.4.18 (2017-11-20)
___________________

* Fix bug related to temporary unavailable status code

0.4.17 (2017-11-09)
___________________

* Added pagination support for wapi calls

0.4.15 (2017-07-18)
___________________

* Changed logic of generate duid using only mac address

0.4.14 (2017-05-18)
___________________

* Add function to check object is created or reused

0.4.13 (2017-03-01)
___________________
* Add TTL field to HostRecordV*
* Add CNAME record support
* Specify return fields for an SRV record

0.4.12 (2016-12-08)
___________________
* Allow search all fields
* Remove ptrdname from PTR record search attributes

0.4.11 (2016-10-31)
___________________
* Add search HostRecords by MAC

0.4.10 (2016-10-24)
___________________
* Updated history and author

0.4.9 (2016-10-24)
__________________
* Add function to get fixed addresses by mac

0.4.8 (2016-10-10)
__________________
* Add ptrdname search option to PtrRecord objects

0.4.7 (2016-07-14)
__________________
* Add zones extensible attribute update support

0.4.6 (2016-07-01)
__________________
* Add network_view support for host records

0.4.5 (2016-06-13)
__________________
* Allow raising exception in create_ea_definition
* Add pep8 check to tox
* Add pep8 check to Travis CI
* Add examples of searching by regular expression

0.4.4 (2016-05-11)
__________________
* Pass only_ref option to update_from_dict
* Do not fail on processing unknown fields
* Fetch only object reference for service restart
* Update README with example of using EA

0.4.3 (2016-03-28)
__________________
* Add default fields for Member
* Update docstring for create_network
* Add fields to FixedAddressV4 and IPAddress

0.4.2 (2016-03-04)
__________________
* Add max_retries option to connector
* Log failure on get with Error log level

0.4.1 (2016-02-26)
__________________
* Add 'max_results' as connector option

0.4.0 (2016-02-19)
------------------
* Add max_results option to connector and objects
* Add Tenant object
* Update README.rst with more examples


0.3.9 (2016-02-18)
__________________
* Add 'configure_for_dns' field for HostRecord

0.3.8 (2016-02-17)
__________________
* Add 'extattrs' to DNSZone/DNSView return_fields

0.3.7 (2016-02-12)
__________________
* Add return_fields to NetworkView

0.3.6 (2016-01-28)
__________________
* Add support for list and tuple values to EA object
* Remove _value_to_bool

0.3.5 (2016-01-22)
__________________
* No changes

0.3.4 (2016-01-21)
__________________
* Do not override verify flag on request level

0.3.3 (2016-01-20)
__________________
* create_required_ea_definitions return created list
* Add 'start_addr', 'end_addr' to ip detection list
* Add request type to connector logger
* Flake8 fixes

0.3.2 (2016-01-19)
__________________
* Convert strings into booleans for ssl_verify
* Update AUTHORS.rst, add contributors
* Remove unused methods from utils.py

0.3.1 (2016-01-14)
__________________
* Add 'zone' to search fields of Host Record


0.3.0 (2016-01-14)
------------------
* Update development status from Pre-Alpha to Alpha
* Feature/tox testing (huge changes in testing env)
* Add 'network' to search fields of FixedAddress
* Allow domain-name-servers for ipv6
* Update existent EA for network instead of replace


0.2.3 (2016-01-06)
__________________
* Return None if search failed instead of exception
* Add ip_version as a public property for objects

0.2.2 (2015-12-23)
__________________
* Fix updating object from create method
* Rework delete_all_associated_objects logic
* Fix error handling in create_object
* Do not catch exception on create_dns_zone level
* Update feature version for member_ipv6_setting

0.2.1 (2015-12-18)
__________________
* Add InfobloxMemberAlreadyAssigned exception
* Update dns record if already exists
* Add 'log_api_calls_as_info' option for connector
* Check for empty values in EA

0.2.0 (2015-12-17)
------------------
* Deprecate network_exists method in object_manager
* Add _global_field_processing for objects
* Add parsing 'extattrs' into EA objects for all InfobloxObject childs
* Add docs badge to README.rst
* Reworked get_network in object_manager
* Move _eq_ to BaseObject
* Check if fixed address is found before delete


0.1.4 (2015-12-08)
__________________
* Field updates for Member object
* Log all api calls in connector on debug level

0.1.3 (2015-12-04)
__________________
* Add 'network' field to ip versioned fields
* Skip adding DHCP options for IPv6 network
* Do not search IPRange before creating

0.1.2 (2015-12-02)
__________________
* Do not fail if object is not found on delete
* Raise exception with details if reply is not json
* Add 'silent_ssl_warnings' option to connector

0.1.1 (2015-12-01)
__________________
* Fix unbind_name_from_record_a

0.1.0 (2015-12-01)
__________________
* Add new field type '_updateable_search_field' to objects and fix HostRecord search
* Fix 'make docs'
* Update README.rst (fixed formatting)

0.0.11 (2015-11-25)
___________________
* Fix adding second ip to HostRecord
* Fix failing in pdb
* Convert EA values into boolean if possible
* Added 'ips' allias for ip field in HostRecord

0.0.10 (2015-11-19)
___________________
* Add utility to determine supported feature
* Update README.rst with objects interface

0.0.9 (2015-11-13)
__________________
* Add allowed_object_types field for EA Definition
* Allow to return default fields for object
* Update README.rst with list of supported objects

0.0.8 (2015-11-12)
___________________
* Add Extensible Attributes Definition support
* Fixed options processing for create_network in object_manager
* Fixed missed DNSZone object in create_dns_zone

0.0.7 (2015-10-27)
____________________
* Added 'network' to IPRange search fields
* Modified `get` method of the EA class to allow return default values

0.0.6 (2015-10-26)
____________________
* Added initial support of Extensible Attributes as sub objects
* Added search by Extensible Attributes
* Improved validation in connector
* Added delete_object_by_ref to object manager

0.0.5 (2015-10-12)
____________________
* Fixed issues in working with objects
* Added missed _get_object_type_from_ref
* Added code coverage
* Updated links to point to infobloxopen repository

0.0.4 (2015-09-23)
____________________
* Added object abstraction for interacting with NIOS objects
* Added object_manager to simplify some operations on objects

0.0.3 (2015-09-15)
____________________
* Added dependencies to package.


0.0.2 (2015-09-11)
____________________
* Fixed using dashes in package directory names that prevented package import after install.


0.0.1 (2015-09-11)
---------------------
* Added connector to send wapi requests to NIOS, does not includes NIOS object model at this point.
* First release on PyPI.