Skip to content

Commit 00dfa0c

Browse files
committed
Apply fixes for issue #13
- Replace tabs with whitespace - Correct some resulting indentation issues - Write unittests (~34% coverage) - apply tox, coverage, flake8
1 parent b0c356f commit 00dfa0c

32 files changed

+2351
-2
lines changed

.gitignore

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# https://raw.githubusercontent.com/github/gitignore/master/Python.gitignore
2+
# Byte-compiled / optimized / DLL files
3+
__pycache__/
4+
*.py[cod]
5+
*$py.class
6+
7+
# C extensions
8+
*.so
9+
10+
# Distribution / packaging
11+
.Python
12+
env/
13+
build/
14+
develop-eggs/
15+
dist/
16+
downloads/
17+
eggs/
18+
.eggs/
19+
lib/
20+
lib64/
21+
parts/
22+
sdist/
23+
var/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
28+
# PyInstaller
29+
# Usually these files are written by a python script from a template
30+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
31+
*.manifest
32+
*.spec
33+
34+
# Installer logs
35+
pip-log.txt
36+
pip-delete-this-directory.txt
37+
38+
# Unit test / coverage reports
39+
htmlcov/
40+
.tox/
41+
.coverage
42+
.coverage.*
43+
.cache
44+
nosetests.xml
45+
coverage.xml
46+
*,cover
47+
.hypothesis/
48+
49+
# Translations
50+
*.mo
51+
*.pot
52+
53+
# Django stuff:
54+
*.log
55+
56+
# Sphinx documentation
57+
docs/_build/
58+
59+
# PyBuilder
60+
target/
61+
test_results/

MANIFEST.in

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
include README.md

README.md

+307
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,310 @@ except Exception as e:
5555
print e
5656
5757
```
58+
59+
# infoblox.infoblox Module
60+
61+
62+
## infoblox.infoblox.Infoblox Objects
63+
64+
65+
66+
##### `__init__(self, iba_ipaddr, iba_user, iba_password, iba_wapi_version, iba_dns_view, iba_network_view, iba_verify_ssl=False)`
67+
68+
> Class initialization method
69+
> :param iba_ipaddr: IBA IP address of management interface
70+
> :param iba_user: IBA user name
71+
> :param iba_password: IBA user password
72+
> :param iba_wapi_version: IBA WAPI version (example: 1.0)
73+
> :param iba_dns_view: IBA default view
74+
> :param iba_network_view: IBA default network view
75+
> :param iba_verify_ssl: IBA SSL certificate validation (example: False)
76+
77+
78+
79+
##### `add_host_alias(self, host_fqdn, alias_fqdn)`
80+
81+
> Implements IBA REST API call to add an alias to IBA host record
82+
> :param host_fqdn: host record name in FQDN
83+
> :param alias_fqdn: host record name in FQDN
84+
85+
86+
87+
##### `create_cname_record(self, canonical, name)`
88+
89+
> Implements IBA REST API call to create IBA cname record
90+
> :param canonical: canonical name in FQDN format
91+
> :param name: the name for a CNAME record in FQDN format
92+
93+
94+
95+
##### `create_dhcp_range(self, start_ip_v4, end_ip_v4)`
96+
97+
> Implements IBA REST API call to add DHCP range for given
98+
> start and end addresses
99+
> :param start_ip_v4: IP v4 address
100+
> :param end_ip_v4: IP v4 address
101+
102+
103+
104+
##### `create_host_record(self, address, fqdn)`
105+
106+
> Implements IBA REST API call to create IBA host record
107+
> Returns IP v4 address assigned to the host
108+
> :param address: IP v4 address or NET v4 address in CIDR format to get
109+
> next_available_ip from
110+
> :param fqdn: hostname in FQDN
111+
112+
113+
114+
##### `create_network(self, network)`
115+
116+
> Implements IBA REST API call to create DHCP network object
117+
> :param network: network in CIDR format
118+
119+
120+
121+
##### `create_networkcontainer(self, networkcontainer)`
122+
123+
> Implements IBA REST API call to create DHCP network containert object
124+
> :param networkcontainer: network container in CIDR format
125+
126+
127+
128+
##### `create_txt_record(self, text, fqdn)`
129+
130+
> Implements IBA REST API call to create IBA txt record
131+
> Returns IP v4 address assigned to the host
132+
> :param text: free text to be added to the record
133+
> :param fqdn: hostname in FQDN
134+
135+
136+
137+
##### `delete_cname_record(self, fqdn)`
138+
139+
> Implements IBA REST API call to delete IBA cname record
140+
> :param fqdn: cname in FQDN
141+
142+
143+
144+
##### `delete_dhcp_range(self, start_ip_v4, end_ip_v4)`
145+
146+
> Implements IBA REST API call to delete DHCP range for given
147+
> start and end addresses
148+
> :param start_ip_v4: IP v4 address
149+
> :param end_ip_v4: IP v4 address
150+
151+
152+
153+
##### `delete_host_alias(self, host_fqdn, alias_fqdn)`
154+
155+
> Implements IBA REST API call to add an alias to IBA host record
156+
> :param host_fqdn: host record name in FQDN
157+
> :param alias_fqdn: host record name in FQDN
158+
159+
160+
161+
##### `delete_host_record(self, fqdn)`
162+
163+
> Implements IBA REST API call to delete IBA host record
164+
> :param fqdn: hostname in FQDN
165+
166+
167+
168+
##### `delete_network(self, network)`
169+
170+
> Implements IBA REST API call to delete DHCP network object
171+
> :param network: network in CIDR format
172+
173+
174+
175+
##### `delete_network_extattrs(self, network, attributes)`
176+
177+
> Implements IBA REST API call to delete network extensible attributes
178+
> :param network: network in CIDR format
179+
> :param attributes: array of extensible attribute names
180+
181+
182+
183+
##### `delete_networkcontainer(self, networkcontainer)`
184+
185+
> Implements IBA REST API call to delete DHCP network container object
186+
> :param networkcontainer: network container in CIDR format
187+
188+
189+
190+
##### `delete_txt_record(self, fqdn)`
191+
192+
> Implements IBA REST API call to delete IBA TXT record
193+
> :param fqdn: hostname in FQDN
194+
195+
196+
197+
##### `get_host(self, fqdn, fields=None)`
198+
199+
> Implements IBA REST API call to retrieve host record fields
200+
> Returns hash table of fields with field name as a hash key
201+
> :param fqdn: hostname in FQDN
202+
> :param fields: comma-separated list of field names (optional)
203+
204+
205+
206+
##### `get_host_by_extattrs(self, attributes)`
207+
208+
> Implements IBA REST API call to find host by it's extensible attributes
209+
> Returns array of hosts in FQDN
210+
> :param attributes: comma-separated list of attrubutes name/value
211+
> pairs in the format:
212+
> attr_name=attr_value - exact match for attribute value
213+
> attr_name:=attr_value - case insensitive match for attribute value
214+
> attr_name~=regular_expression - match attribute value by regular
215+
> expression
216+
> attr_name>=attr_value - search by number greater than value
217+
> attr_name<=attr_value - search by number less than value
218+
> attr_name!=attr_value - search by number not equal of value
219+
220+
221+
222+
##### `get_host_by_ip(self, ip_v4)`
223+
224+
> Implements IBA REST API call to find hostname by IP address
225+
> Returns array of host names in FQDN associated with given IP address
226+
> :param ip_v4: IP v4 address
227+
228+
229+
230+
##### `get_host_by_regexp(self, fqdn)`
231+
232+
> Implements IBA REST API call to retrieve host records by fqdn regexp filter
233+
> Returns array of host names in FQDN matched to given regexp filter
234+
> :param fqdn: hostname in FQDN or FQDN regexp filter
235+
236+
237+
238+
##### `get_host_extattrs(self, fqdn, attributes=None)`
239+
240+
> Implements IBA REST API call to retrieve host extensible attributes
241+
> Returns hash table of attributes with attribute name as a hash key
242+
> :param fqdn: hostname in FQDN
243+
> :param attributes: array of extensible attribute names (optional)
244+
245+
246+
247+
##### `get_ip_by_host(self, fqdn)`
248+
249+
> Implements IBA REST API call to find IP addresses by hostname
250+
> Returns array of IP v4 addresses associated with given hostname
251+
> :param fqdn: hostname in FQDN
252+
253+
254+
255+
##### `get_network(self, network, fields=None)`
256+
257+
> Implements IBA REST API call to retrieve network object fields
258+
> Returns hash table of fields with field name as a hash key
259+
> :param network: network in CIDR format
260+
> :param fields: comma-separated list of field names
261+
> (optional, returns network in CIDR format and netmask if
262+
> not specified)
263+
264+
265+
266+
##### `get_network_by_extattrs(self, attributes)`
267+
268+
> Implements IBA REST API call to find a network by it's
269+
> extensible attributes
270+
> Returns array of networks in CIDR format
271+
> :param attributes: comma-separated list of attrubutes name/value
272+
> pairs in the format:
273+
> attr_name=attr_value - exact match for attribute value
274+
> attr_name:=attr_value - case insensitive match for attribute value
275+
> attr_name~=regular_expression - match attribute value by regular
276+
> expression
277+
> attr_name>=attr_value - search by number greater than value
278+
> attr_name<=attr_value - search by number less than value
279+
> attr_name!=attr_value - search by number not equal of value
280+
281+
282+
283+
##### `get_network_by_ip(self, ip_v4)`
284+
285+
> Implements IBA REST API call to find network by IP address which
286+
> belongs to this network
287+
> Returns network in CIDR format
288+
> :param ip_v4: IP v4 address
289+
290+
291+
292+
##### `get_network_extattrs(self, network, attributes=None)`
293+
294+
> Implements IBA REST API call to retrieve network extensible attributes
295+
> Returns hash table of attributes with attribute name as a hash key
296+
> :param network: network in CIDR format
297+
> :param attributes: array of extensible attribute names (optional)
298+
299+
300+
301+
##### `get_next_available_ip(self, network)`
302+
303+
> Implements IBA next_available_ip REST API call
304+
> Returns IP v4 address
305+
> :param network: network in CIDR format
306+
307+
308+
309+
##### `get_next_available_network(self, networkcontainer, cidr)`
310+
311+
> Implements IBA REST API call to retrieve next available network
312+
> of network container
313+
> Returns network address in CIDR format
314+
> :param networkcontainer: network container address in CIDR format
315+
> :param cidr: requested network length (from 0 to 32)
316+
317+
318+
319+
##### `get_txt_by_regexp(self, fqdn)`
320+
321+
> Implements IBA REST API call to retrieve TXT records by fqdn
322+
> regexp filter
323+
> Returns dictonary of host names in FQDN matched to given regexp
324+
> filter with the TXT value
325+
> :param fqdn: hostname in FQDN or FQDN regexp filter
326+
327+
328+
329+
##### `update_cname_record(self, canonical, name)`
330+
331+
> Implements IBA REST API call to update or repoint IBA cname record
332+
> :param canonical: canonical name in FQDN format
333+
> :param name: the name for the new CNAME record in FQDN format
334+
335+
336+
337+
##### `update_network_extattrs(self, network, attributes)`
338+
339+
> Implements IBA REST API call to add or update network extensible attributes
340+
> :param network: network in CIDR format
341+
> :param attributes: hash table of extensible attributes with attribute
342+
> name as a hash key
343+
344+
345+
346+
## infoblox.infoblox.InfobloxBadInputParameter Objects
347+
348+
349+
350+
## infoblox.infoblox.InfobloxGeneralException Objects
351+
352+
353+
354+
## infoblox.infoblox.InfobloxNoIPavailableException Objects
355+
356+
357+
358+
## infoblox.infoblox.InfobloxNoNetworkAvailableException Objects
359+
360+
361+
362+
## infoblox.infoblox.InfobloxNotFoundException Objects
363+
364+

infoblox/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)