Central data models of NAV’s management subsystems

Deleted at

property device

Property to access the former device-field

Returns the first chassis device if any

discovered

Discovered

entities

Type: Reverse ForeignKey from NetboxEntity

All entities of this ip device (related name of netbox)

events

Type: Reverse ForeignKey from EventQueue

All events of this ip device (related name of netbox)

from_adjancency_candidates

Type: Reverse ForeignKey from AdjacencyCandidate

All from adjancency candidates of this ip device (related name of netbox)

gateway_peer_sessions

Type: Reverse ForeignKey from GatewayPeerSession

All gateway peer sessions of this ip device (related name of netbox)

get_absolute_url()

get_availability(): Calculates and returns an availability data structure.

get_chassis(): Returns a QuerySet of chassis devices seen on this netbox

get_environment_sensors(): Returns the sensors to be displayed on the Environment Sensor tab

get_fans()

get_filtered_prefix(): Returns the netbox’ prefix address only when the prefix is not a scope, private or reserved prefix.

get_function(): Returns the function description of this netbox.

get_gwport_count(): Returns the number of all interfaces that have IP addresses.

get_gwports(): Returns all interfaces that have IP addresses.

get_gwports_sorted(): Returns gwports naturally sorted by interface name

get_last_jobs(): Returns the last log entry for all jobs

get_next_by_discovered(*, field=<django.db.models.DateTimeField: discovered>, is_next=True, **kwargs): Finds next instance based on discovered. See get_next_by_FOO() for more information.

get_next_by_up_since(*, field=<django.db.models.DateTimeField: up_since>, is_next=True, **kwargs): Finds next instance based on up_since. See get_next_by_FOO() for more information.

get_physical_ports(): Return all ports that are present.

get_physical_ports_sorted(): Return all ports that are present sorted by interface name.

get_powersupplies()

get_preferred_snmp_management_profile(require_write=False) → Optional[ManagementProfile]

Returns the snmp management profile with the highest available SNMP version.

Parameters:: require_write – If True, only write-enabled profiles will be considered. If false, read-only profiles will be preferred, unless a write-enabled profile is the only available alternative.

get_prefix(): Returns the prefix address for this netbox’ IP address.

get_previous_by_discovered(*, field=<django.db.models.DateTimeField: discovered>, is_next=False, **kwargs): Finds previous instance based on discovered. See get_previous_by_FOO() for more information.

get_previous_by_up_since(*, field=<django.db.models.DateTimeField: up_since>, is_next=False, **kwargs): Finds previous instance based on up_since. See get_previous_by_FOO() for more information.

get_sensors(): Returns sensors associated with this netbox

get_short_sysname(): Returns sysname without the domain suffix if specified in the DOMAIN_SUFFIX setting in nav.conf

get_swport_count(): Returns the number of all interfaces that are switch ports.

get_swports(): Returns all interfaces that are switch ports.

get_swports_sorted(): Returns swports naturally sorted by interface name

get_system_metrics()

Gets a list of available Graphite metrics related to this Netbox, except for ports and sensors, which are seen as separate.

Returns:

A list of dicts describing the metrics, e.g.: {id:”nav.devices.some-gw.cpu.cpu1.loadavg1min”,

group=”cpu”, suffix=”cpu1.loadavg1min”}

get_unresolved_alerts(kind=None): Returns a queryset of unresolved alert states

get_up_display(*, field=<django.db.models.CharField: up>): Shows the label of the up. See get_FOO_display() for more information.

get_uplinks(): Returns a list of uplinks on this netbox. Requires valid vlan.

get_uplinks_regarding_of_vlan()

get_week_availability(): Gets the availability for this netbox for the last week

groups

Type: ManyToManyField to NetboxGroup

Groups (related name: netboxes)

has_unignored_unrecognized_neighbors(): Returns true if this netbox has unignored unrecognized neighbors

id

Type: AutoField

Primary key: Id

info_set

Type: Reverse ForeignKey from NetboxInfo

All info set of this ip device (related name of netbox)

instances

Type: Reverse ForeignKey from Netbox

All instances of this ip device (related name of master)

interfaces

Type: Reverse ForeignKey from Interface

All interfaces of this ip device (related name of netbox)

ip

Type: GenericIPAddressField

Ip

is_on_maintenance(): Returns True if this netbox is currently on maintenance

is_snmp_down(): Returns True if this netbox has any unresolved snmp agent state alerts

is_up(): Returns True if the Netbox isn’t known to be down or in shadow

job_log

Type: Reverse ForeignKey from IpdevpollJobLog

All job log of this ip device (related name of netbox)

last_downtime_ended()

Returns the end_time of the last known boxState alert.

Returns:: A datetime object if a serviceState alert was found, otherwise None

last_updated(job='inventory'): Returns the last updated timestamp of a particular job as a datetime object.

property mac_addresses: Set[str]: Returns a set of collected chassis MAC addresses for this Netbox

master

Type: ForeignKey to Netbox

Master (related name: instances)

master_id: Internal field, use master instead.

memory_set

Type: Reverse ForeignKey from Memory

All memory set of this ip device (related name of netbox)

modules

Type: Reverse ForeignKey from Module

All modules of this ip device (related name of netbox)

netbox_vtp_vlans

Type: Reverse ForeignKey from NetboxVtpVlan

All netbox vtp vlans of this ip device (related name of netbox)

netboxcategory_set

Type: Reverse ForeignKey from NetboxCategory

All netbox categorys of this ip device (related name of netbox)

netboxprefix

Type: Reverse OneToOneField from NetboxPrefix

The netbox prefix of this ip device (related name of netbox)

netboxprofile_set

Type: Reverse ForeignKey from NetboxProfile

All netbox profiles of this ip device (related name of netbox)

node_positions

Type: Reverse ForeignKey from NetmapViewNodePosition

All node positions of this ip device (related name of netbox)

objects = <django.db.models.manager.ManagerFromNetboxQuerySet object>

organization

Type: ForeignKey to Organization

Organization (related name: netboxes)

organization_id: Internal field, use organization instead.

poe_groups

Type: Reverse ForeignKey from POEGroup

All poe groups of this ip device (related name of netbox)

poe_ports

Type: Reverse ForeignKey from POEPort

All poe ports of this ip device (related name of netbox)

power_supplies_or_fans

Type: Reverse ForeignKey from PowerSupplyOrFan

All power supplies or fans of this ip device (related name of netbox)

profiles

Type: ManyToManyField to ManagementProfile

Profiles (related name: netboxes)

room

Type: ForeignKey to Room

Room (related name: netboxes)

room_id: Internal field, use room instead.

sensors

Type: Reverse ForeignKey from Sensor

All sensors of this ip device (related name of netbox)

services

Type: Reverse ForeignKey from Service

All services of this ip device (related name of netbox)

sysname

Type: VarcharField

Sysname

to_adjacency_candidates

Type: Reverse ForeignKey from AdjacencyCandidate

All to adjacency candidates of this ip device (related name of to_netbox)

type

Type: ForeignKey to NetboxType

Type (related name: netboxes)

type_id: Internal field, use type instead.

unrecognized_neighbors

Type: Reverse ForeignKey from UnrecognizedNeighbor

All unrecognized neighbors of this ip device (related name of netbox)

up

Type: CharField

Up

Choices:

y
n
s

up_since

Up since

up_to_date

Up to date

ups_objects = <nav.models.manage.UpsManager object>

vlans

Type: Reverse ForeignKey from Vlan

All vlans of this ip device (related name of netbox)

NetboxType

class nav.models.manage.NetboxType(*args, **kwargs)

From NAV Wiki: The type table defines the type of a netbox, the sysobjectid being the unique identifier.

Parameters:

id (AutoField) – Primary key: Id
name (VarcharField) – Type name
sysobjectid (VarcharField) – Sysobjectid
description (VarcharField) – Description

Relationship fields:

Parameters:: vendor (ForeignKey to Vendor) – Vendor (related name: netbox_types)

Reverse relationships:

Parameters:: netboxes (Reverse ForeignKey from Netbox) – All netboxes of this netbox type (related name of type)

exception DoesNotExist

exception MultipleObjectsReturned

description

Type: VarcharField

Description

get_enterprise_id()

Returns the type’s enterprise ID as an integer.

The type’s sysobjectid should always start with SNMPv2-SMI::enterprises (1.3.6.1.4.1). The next OID element will be an enterprise ID, while the remaining elements will describe the type specific to the vendor.

id

Type: AutoField

Primary key: Id

name

Type: VarcharField

Type name

netboxes

Type: Reverse ForeignKey from Netbox

All netboxes of this netbox type (related name of type)

objects = <django.db.models.Manager object>

sysobjectid

Type: VarcharField

Sysobjectid

vendor

Type: ForeignKey to Vendor

Vendor (related name: netbox_types)

vendor_id: Internal field, use vendor instead.

Category

class nav.models.manage.Category(*args, **kwargs)

From NAV Wiki: The cat table defines the categories of a netbox (GW,GSW,SW,EDGE,WLAN,SRV,OTHER).

Parameters:

id (CharField) – Primary key: Id
description (VarcharField) – Description
req_mgmt (BooleanField) – Req mgmt

Reverse relationships:

Parameters:

netboxes (Reverse ForeignKey from Netbox) – All netboxes of this category (related name of category)
netmap_views (Reverse ManyToManyField from NetmapView) – All netmap views of this category (related name of categories)
netmap_view_categories (Reverse ForeignKey from NetmapViewCategories) – All netmap view categories of this category (related name of category)

exception DoesNotExist

exception MultipleObjectsReturned

description

Type: VarcharField

Description

id

Type: CharField

Primary key: Id

is_edge(): Is this an edge switch?

is_gsw(): Is this a routing switch?

is_gw(): Is this a router?

is_other(): Is this an uncategorized device?

is_srv(): Is this a server?

is_sw(): Is this a core switch?

netboxes

Type: Reverse ForeignKey from Netbox

All netboxes of this category (related name of category)

netmap_view_categories

Type: Reverse ForeignKey from NetmapViewCategories

All netmap view categories of this category (related name of category)

netmap_views

Type: Reverse ManyToManyField from NetmapView

All netmap views of this category (related name of categories)

objects = <django.db.models.Manager object>

req_mgmt

Req mgmt

Interface

class nav.models.manage.Interface(*args, **kwargs)

The network interfaces, both physical and virtual, of a Netbox.

Parameters:

id (AutoField) – Primary key: Id
ifindex (IntegerField) – Ifindex
ifname (VarcharField) – Ifname
ifdescr (VarcharField) – Ifdescr
iftype (IntegerField) – Iftype
speed (FloatField) – Speed
ifphysaddress (CharField) – Ifphysaddress
ifadminstatus (IntegerField) – Ifadminstatus
ifoperstatus (IntegerField) – Ifoperstatus
iflastchange (IntegerField) – Iflastchange
ifconnectorpresent (BooleanField) – Ifconnectorpresent
ifpromiscuousmode (BooleanField) – Ifpromiscuousmode
ifalias (VarcharField) – Ifalias
baseport (IntegerField) – Baseport
media (VarcharField) – Media
vlan (IntegerField) – Vlan
trunk (BooleanField) – Trunk
duplex (CharField) – Duplex
gone_since (DateTimeField) – Gone since

Relationship fields:

Parameters:

netbox (ForeignKey to Netbox) – Netbox (related name: interfaces)
module (ForeignKey to Module) – Module (related name: interfaces)
to_netbox (ForeignKey to Netbox) – To netbox (related name: connected_to_interface)
to_interface (ForeignKey to Interface) – To interface (related name: connected_to_interface)

Reverse relationships:

Parameters:

gwport_prefixes (Reverse ForeignKey from GwPortPrefix) – All gwport prefixes of this interface (related name of interface)
swport_vlans (Reverse ForeignKey from SwPortVlan) – All swport vlans of this interface (related name of interface)
swport_allowed_vlan (Reverse OneToOneField from SwPortAllowedVlan) – The swport allowed vlan of this interface (related name of interface)
blocked_swports (Reverse ForeignKey from SwPortBlocked) – All blocked swports of this interface (related name of interface)
from_adjancency_candidates (Reverse ForeignKey from AdjacencyCandidate) – All from adjancency candidates of this interface (related name of interface)
to_adjacency_candidates (Reverse ForeignKey from AdjacencyCandidate) – All to adjacency candidates of this interface (related name of to_interface)
connected_to_interface (Reverse ForeignKey from Interface) – All connected to interface of this interface (related name of to_interface)
higher_layer (Reverse ForeignKey from InterfaceStack) – All higher layer of this interface (related name of higher)
lower_layer (Reverse ForeignKey from InterfaceStack) – All lower layer of this interface (related name of lower)
aggregators (Reverse ForeignKey from InterfaceAggregate) – All aggregators of this interface (related name of aggregator)
bundled (Reverse ForeignKey from InterfaceAggregate) – All bundled of this interface (related name of interface)
routing_protocol_attributes (Reverse ForeignKey from RoutingProtocolAttribute) – All routing protocol attributes of this interface (related name of interface)
sensors (Reverse ForeignKey from Sensor) – All sensors of this interface (related name of interface)
unrecognized_neighbors (Reverse ForeignKey from UnrecognizedNeighbor) – All unrecognized neighbors of this interface (related name of interface)
poe_ports (Reverse ForeignKey from POEPort) – All poe ports of this interface (related name of interface)
arnold_identities (Reverse ForeignKey from Identity) – All arnold identities of this interface (related name of interface)
patches (Reverse ForeignKey from Patch) – All patches of this interface (related name of interface)

ADM_DOWN = 2

ADM_STATUS_CHOICES = ((1, 'up'), (2, 'down'), (3, 'testing'))

ADM_TESTING = 3

ADM_UP = 1

DUPLEX_CHOICES = (('f', 'full duplex'), ('h', 'half duplex'))

DUPLEX_FULL = 'f'

DUPLEX_HALF = 'h'

exception DoesNotExist

ETHERNET_INTERFACE_TYPES = (6, 62, 69, 117)

exception MultipleObjectsReturned

OPER_DORMANT = 5

OPER_DOWN = 2

OPER_LOWERLAYERDOWN = 7

OPER_NOTPRESENT = 6

OPER_STATUS_CHOICES = ((1, 'up'), (2, 'down'), (3, 'testing'), (4, 'unknown'), (5, 'dormant'), (6, 'not present'), (7, 'lower layer down'))

OPER_TESTING = 3

OPER_UNKNOWN = 4

OPER_UP = 1

__init__(*args, **kwargs)

above_me(): Returns interfaces stacked with this one on a layer above

aggregators

Type: Reverse ForeignKey from InterfaceAggregate

All aggregators of this interface (related name of aggregator)

arnold_identities

Type: Reverse ForeignKey from Identity

All arnold identities of this interface (related name of interface)

property audit_logname

baseport

Baseport

below_me(): Returns interfaces stacked with this one on a layer below

blocked_swports

Type: Reverse ForeignKey from SwPortBlocked

All blocked swports of this interface (related name of interface)

bundled

Type: Reverse ForeignKey from InterfaceAggregate

All bundled of this interface (related name of interface)

connected_to_interface

Type: Reverse ForeignKey from Interface

All connected to interface of this interface (related name of to_interface)

duplex

Type: CharField

Duplex

Choices:

f
h

from_adjancency_candidates

Type: Reverse ForeignKey from AdjacencyCandidate

All from adjancency candidates of this interface (related name of interface)

get_absolute_url()

get_active_time(interval=600)

Time since last CAM activity on port, looking at CAM entries for the last interval days.

Returns None if no activity is found, else number of days since last activity as a datetime.timedelta object.

get_aggregator()

Returns the interface that is selected as an aggregator for me.

Naively selects the aggregator with the lowest ifIndex in cases where there are multiple aggregators (may happen on e.g. Juniper devices, due to stacking of logical units)

get_allowed_vlan_ranges()

Returns the set of allowed vlans as a list of ranges

Return type:: nav.util.NumberRange

get_bundled_interfaces(): Returns the interfaces that are bundled on this interface

get_duplex_display(*, field=<django.db.models.CharField: duplex>): Shows the label of the duplex. See get_FOO_display() for more information.

get_ifadminstatus_display(*, field=<django.db.models.IntegerField: ifadminstatus>): Shows the label of the ifadminstatus. See get_FOO_display() for more information.

get_ifoperstatus_display(*, field=<django.db.models.IntegerField: ifoperstatus>): Shows the label of the ifoperstatus. See get_FOO_display() for more information.

get_last_cam_record(): Returns the newest cam record gotten from this switch port.

get_link_display(): Returns a display value for this interface’s link status.

get_next_by_gone_since(*, field=<django.db.models.DateTimeField: gone_since>, is_next=True, **kwargs): Finds next instance based on gone_since. See get_next_by_FOO() for more information.

get_port_metrics()

Gets a list of available Graphite metrics related to this Interface.

Returns:

A list of dicts describing the metrics, e.g.: {id:”nav.devices.some-gw.ports.gi1_1.ifInOctets”,

suffix:”ifInOctets”}

get_previous_by_gone_since(*, field=<django.db.models.DateTimeField: gone_since>, is_next=False, **kwargs): Finds previous instance based on gone_since. See get_previous_by_FOO() for more information.

get_sorted_vlans(): Returns a queryset of sorted swportvlans

get_trunkvlans_as_range(): Converts the list of allowed vlans on trunk to a string of ranges. Ex: [1, 2, 3, 4, 7, 8, 10] -> “1-4,7-8,10”

get_vlan_numbers(): List of VLAN numbers related to the port

gone_since

Gone since

gwport_prefixes

Type: Reverse ForeignKey from GwPortPrefix

All gwport prefixes of this interface (related name of interface)

has_unignored_unrecognized_neighbors(): Returns True if this interface has unrecognized neighbors that are not ignored

higher_layer

Type: Reverse ForeignKey from InterfaceStack

All higher layer of this interface (related name of higher)

id

Type: AutoField

Primary key: Id

ifadminstatus

Ifadminstatus

Choices:

1
2
3

ifalias

Type: VarcharField

Ifalias

ifconnectorpresent

Ifconnectorpresent

ifdescr

Type: VarcharField

Ifdescr

ifindex

Ifindex

iflastchange

Iflastchange

ifname

Type: VarcharField

Ifname

ifoperstatus

Ifoperstatus

Choices:

1
2
3
4
5
6
7

ifphysaddress

Type: CharField

Ifphysaddress

ifpromiscuousmode

Ifpromiscuousmode

iftype

Iftype

is_admin_up(): Returns True if interface is administratively up

is_degraded(): Returns True if this aggregator has been degraded, False if it has not, None if this interface is not a known aggregator.

is_gwport()

Returns True if the interface has an IP address.

NOTE: This doesn’t necessarily mean the port forwards packets for other hosts.

is_on_maintenace(): Returns True if the owning Netbox is on maintenance

is_oper_up(): Returns True if interface is operationally up

is_physical_port(): Returns true if this interface has a physical connector present

is_swport(): Returns True if the interface is configured as a switch-port

lower_layer

Type: Reverse ForeignKey from InterfaceStack

All lower layer of this interface (related name of lower)

media

Type: VarcharField

Media

module

Type: ForeignKey to Module

Module (related name: interfaces)

module_id: Internal field, use module instead.

netbox

Type: ForeignKey to Netbox

Netbox (related name: interfaces)

netbox_id: Internal field, use netbox instead.

objects = <django.db.models.Manager object>

patches

Type: Reverse ForeignKey from Patch

All patches of this interface (related name of interface)

poe_ports

Type: Reverse ForeignKey from POEPort

All poe ports of this interface (related name of interface)

routing_protocol_attributes

Type: Reverse ForeignKey from RoutingProtocolAttribute

All routing protocol attributes of this interface (related name of interface)

sensors

Type: Reverse ForeignKey from Sensor

All sensors of this interface (related name of interface)

classmethod sort_ports_by_ifname(ports)

speed

Type: FloatField

Speed

swport_allowed_vlan

Type: Reverse OneToOneField from SwPortAllowedVlan

The swport allowed vlan of this interface (related name of interface)

swport_vlans

Type: Reverse ForeignKey from SwPortVlan

All swport vlans of this interface (related name of interface)

to_adjacency_candidates

Type: Reverse ForeignKey from AdjacencyCandidate

All to adjacency candidates of this interface (related name of to_interface)

to_interface

Type: ForeignKey to Interface

To interface (related name: connected_to_interface)

to_interface_id: Internal field, use to_interface instead.

to_netbox

Type: ForeignKey to Netbox

To netbox (related name: connected_to_interface)

to_netbox_id: Internal field, use to_netbox instead.

trunk

Trunk

unrecognized_neighbors

Type: Reverse ForeignKey from UnrecognizedNeighbor

All unrecognized neighbors of this interface (related name of interface)

vlan