Skip to content

Examples

This page provides for examples of how to use pynautobot from the community. What are some of the common use cases? Well here are just a few, including the support of additional applications to be installed on top of Nautobot.

In [1]: import pynautobot

In [2]: nautobot = pynautobot.api("https://demo.nautobot.com", token=nautobot_api_token)

In [3]: jobs_results = getattr(nautobot.extras, "job-results")

In [4]: jobs_results
Out[4]: <pynautobot.core.endpoint.Endpoint at 0x1047929a0>

In [5]: jobs_results.all()
Out[5]:
[plugins/nautobot_golden_config.jobs/AllGoldenConfig,
plugins/nautobot_golden_config.jobs/AllGoldenConfig,
DeviceConnectionsReport,
VerifyPrimaryIP,
VerifyPlatform,
VerifyHostnames,
VerifyHasRack,
VerifyCircuitTermination,
device lifecycle,
device lifecycle,
templates,
templates,
data,
data,
configs,
configs,
backups,
backups,
colo,
colo,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
pops,
devicetypes,
devicetypes,
circuits,
manufacturers,
regions,
users]

This demonstrates accessing the Device Lifecycle Management endpoints.

import pynautobot

nautobot = pynautobot.api(
    url="http://localhost:8000",
    token="d6f4e314a5b5fefd164995169f28ae32d987704f",
)

test = getattr(nautobot.plugins, "nautobot-device-lifecycle-mgmt")

cves = test.cve.all()

This is how to assign an IP address to an interface. We need to provide the id of the objects as parameters.

import pynautobot

nautobot = pynautobot.api(
    url="http://localhost:8000/",
    token="d6f4e314a5b5fefd164995169f28ae32d987704f",
)

# Get the IP address object
ip_address = nb.ipam.ip_addresses.get(address="192.0.2.1")

# Get the interface object
nb_interface = nb.dcim.interfaces.get(name="GigabitEthernet0/0", device=nb.dcim.devices.get(name="sample-rtr-01").id)

# Assign IP to Interface
ip_to_interface = nb.ipam.ip_address_to_interface.create(
    ip_address = ip_address.id,
    interface = nb_interface.id
)

In this example we will gather config context data from the Demo instance of Nautobot.

import pynautobot

nautobot = pynautobot.api(url="https://demo.nautobot.com/", token=40*"a")

context_data = nautobot.dcim.devices.get(name="ams01-asw-01", include="config_context").config_context

print(context_data)
Example output of context data 
{'cdp': True,
'ntp': [{'ip': '10.1.1.1', 'prefer': False},
{'ip': '10.2.2.2', 'prefer': True}],
'lldp': True,
'snmp': {'host': [{'ip': '10.1.1.1',
    'version': '2c',
    'community': 'networktocode'}],
'contact': 'John Smith',
'location': 'Network to Code - NYC | NY',
'community': [{'name': 'ntc-public', 'role': 'RO'},
{'name': 'ntc-private', 'role': 'RW'},
{'name': 'networktocode', 'role': 'RO'},
{'name': 'secure', 'role': 'RW'}]},
'aaa-new-model': False}

When you instantiate the Api object, you can set include_default to a comma-separated list of fields that you want to include by default in all retrieve operations (e.g., all(), filter(), get()). This allows you to automatically include fields that are not included in the default response.

Examples include:

  • Config Context
  • Computed Fields
  • Relationships
import pynautobot

nautobot = pynautobot.api(url="https://demo.nautobot.com/", token=40*"a", include_default="config_context,computed_fields")

You can also use the include parameter in individual all(), filter(), or get() method calls to override the default setting.

import pynautobot

nautobot = pynautobot.api(url="https://demo.nautobot.com/", token=40*"a")

# Retrieve all devices with config context and computed fields included
devices = nautobot.dcim.devices.all(include="config_context,computed_fields")

# Retrieve a single device with computed fields included
device = nautobot.dcim.devices.get(name="sample-rtr-01", include="computed_fields")

# Retrieve devices with relationships included
devices = nautobot.dcim.devices.filter(include="relationships")

When you instantiate the Api object, you can set exclude_m2m to either True or False to automatically include the parameter for all subsequent retrieve operations (e.g., all(), filter(), get()).

import pynautobot

nautobot = pynautobot.api(url="https://demo.nautobot.com/", token=40*"a", exclude_m2m=False)

You can also include the exclude_m2m parameter in individual all(), filter(), or get() method calls to override the default setting.

import pynautobot

nautobot = pynautobot.api(url="https://demo.nautobot.com/", token=40*"a", exclude_m2m=True)

# Retrieve all devices with many-to-many fields included
devices = nautobot.dcim.devices.all(exclude_m2m=False)

# Retrieve a single device with many-to-many fields included
device = nautobot.dcim.devices.get(name="sample-rtr-01", exclude_m2m=False)