DCIM Module

class pynautobot.models.dcim.Cables(values, api, endpoint)

Bases: Record

termination_a

alias of Termination

termination_b

alias of Termination

class pynautobot.models.dcim.ConnectedEndpoint(values, api, endpoint)

Bases: Record

device

alias of Devices

class pynautobot.models.dcim.ConsolePorts(values, api, endpoint)

Bases: TraceableRecord

device

alias of Devices

class pynautobot.models.dcim.ConsoleServerPorts(values, api, endpoint)

Bases: TraceableRecord

device

alias of Devices

class pynautobot.models.dcim.DeviceTypes(values, api, endpoint)

Bases: Record

class pynautobot.models.dcim.Devices(values, api, endpoint)

Bases: Record

Devices Object

Represents a device response from nautobot.

primary_ip, ip4, ip6

Tells __init__ in Record() to take the primary_ip field’s value from the API response and return an initialized list of IpAddress objects

Type:

list

device_type

Tells __init__ in Record() to take the device_type field’s value from the API response and return an initialized DeviceType object

Type:

obj

config_context

alias of JsonField

device_type

alias of DeviceTypes

has_details = True
local_context_data

alias of JsonField

property napalm

Represents the napalm detail endpoint.

Returns a DetailEndpoint object that is the interface for viewing response from the napalm endpoint.

Returns:

DetailEndpoint

Examples:

>>> device = nb.ipam.devices.get(123)
>>> device.napalm.list(method='get_facts')
{"get_facts": {"interface_list": ["ge-0/0/0"]}}
class pynautobot.models.dcim.FrontPorts(values, api, endpoint)

Bases: Record

device

alias of Devices

class pynautobot.models.dcim.InterfaceConnection(values, api, endpoint)

Bases: Record

class pynautobot.models.dcim.InterfaceConnections(values, api, endpoint)

Bases: Record

class pynautobot.models.dcim.Interfaces(values, api, endpoint)

Bases: TraceableRecord

connected_endpoint

alias of ConnectedEndpoint

interface_connection

alias of InterfaceConnection

class pynautobot.models.dcim.PowerOutlets(values, api, endpoint)

Bases: TraceableRecord

device

alias of Devices

class pynautobot.models.dcim.PowerPorts(values, api, endpoint)

Bases: TraceableRecord

device

alias of Devices

class pynautobot.models.dcim.RUs(values, api, endpoint)

Bases: Record

device

alias of Devices

class pynautobot.models.dcim.RackReservations(values, api, endpoint)

Bases: Record

class pynautobot.models.dcim.Racks(values, api, endpoint)

Bases: Record

property elevation

Represents the elevation detail endpoint.

Returns a DetailEndpoint object that is the interface for viewing response from the elevation endpoint updated in Nautobot version 2.8.

Returns:

DetailEndpoint

Examples:

>>> rack = nb.dcim.racks.get(123)
>>> rack.elevation.list()
{"get_facts": {"interface_list": ["ge-0/0/0"]}}
property units

Represents the units detail endpoint.

Returns a DetailEndpoint object that is the interface for viewing response from the units endpoint.

Returns:

DetailEndpoint

Examples:

>>> rack = nb.dcim.racks.get(123)
>>> rack.units.list()
{"get_facts": {"interface_list": ["ge-0/0/0"]}}
class pynautobot.models.dcim.RearPorts(values, api, endpoint)

Bases: Record

device

alias of Devices

class pynautobot.models.dcim.Termination(values, api, endpoint)

Bases: Record

circuit

alias of Circuits

device

alias of Devices

class pynautobot.models.dcim.TraceableRecord(values, api, endpoint)

Bases: Record

trace()
class pynautobot.models.dcim.VirtualChassis(values, api, endpoint)

Bases: Record