Skip to content

IPAM

pynautobot.models.ipam

pynautobot.models.ipam.Prefixes

Bases: Record

available_ips property

Represents the available-ips detail endpoint.

Returns a DetailEndpoint object that is the interface for viewing and creating IP addresses inside a prefix.

:returns: :py:class:.DetailEndpoint

:Examples:

prefix = nb.ipam.prefixes.get(24) prefix.available_ips.list() [{u'vrf': None, u'family': 4, u'address': u'10.1.1.49/30'}...]

To create a single IP:

prefix = nb.ipam.prefixes.get(24) prefix.available_ips.create()

To create multiple IPs:

prefix = nb.ipam.prefixes.get(24) create = prefix.available_ips.create([{} for i in range(2)]) len(create) 2

available_prefixes property

Represents the available-prefixes detail endpoint.

Returns a DetailEndpoint object that is the interface for viewing and creating prefixes inside a parent prefix.

Very similar to :py:meth:~pynautobot.ipam.Prefixes.available_ips , except that dict (or list of dicts) passed to .create() needs to have a prefix_length key/value specifed.

:returns: :py:class:.DetailEndpoint

:Examples:

prefix.available_prefixes.list() [{u'prefix': u'10.1.1.44/30', u'vrf': None, u'family': 4}]

Creating a single child prefix:

prefix = nb.ipam.prefixes.get(1) new_prefix = prefix.available_prefixes.create( ... {'prefix_length': 29} ...) new_prefix['prefix'] u'10.1.1.56/29'