dev
  • Contents
      • NAV documentation
        • Getting help
        • First steps
        • Digging deeper
      • Overview
        • What it is
        • What NAV does
        • A brief history of NAV
      • Installing NAV
        • Installing a pre-packaged version of NAV
        • Installing NAV from source code
      • Integrating Graphite with NAV
        • Configuring NAV
        • Configuring Graphite
      • Getting started with NAV
        • Minimal configuration
        • Starting NAV
        • Logging in to the web interface
        • Seeding your database
        • Further reading
      • Getting organized
        • Organizing your seed data
        • Organizing your collected data
      • Troubleshooting topology problems in NAV
        • Overview
        • Physical topology
      • Migrating data from one NAV installation to another
        • What data should I migrate?
        • Migrating seed data
        • Migrating all or parts of the database
      • Migrating RRD data to Graphite (from NAV 3 to NAV 4)
        • TL;DR
        • Conversion
        • Limitations
      • The NAV API
        • About
        • Tokens
        • Browsing the API
      • FAQ
        • Is vendor X / device Y supported?
        • Why are there gaps in my graphs?
        • Why does NAV list my device’s uplink as N/A?
        • Why doesn’t device X show as down in the status page when I know it’s down?
        • A device is down, I see it on the status page, my profile should cover the event, but I am not alerted. Why?
        • Why is my Cisco switch’ syslog full of SNMP-3-AUTHFAIL messages for requests from my NAV server?
        • I added a new IP Device using SeedDB, but nothing happens. Why?
        • How do I make NAV send SMS alerts?
        • How long are ARP and CAM records kept in the database?
      • Reference material
        • Management profiles
        • Arnold
        • Cabling and Patch
        • Event Engine
        • Event Templates
        • Event- and alert type hierarchy
        • Geomap
        • IPAM - IP Address Management
        • ipdevpoll
        • External authentication (LDAP, REMOTE_USER)
        • MailIn
        • navstats
        • PortAdmin
        • Radius
        • Setting up FreeRADIUS to log to NAV
        • smsd
        • snmptrapd
        • Backend processes in NAV
      • Network Administration Visualized release notes
        • NAV 5.7
        • NAV 5.6
        • NAV 5.5
        • NAV 5.4
        • NAV 5.3
        • NAV 5.2
        • NAV 5.1
        • NAV 5.0
        • NAV 4.9
        • NAV 4.8
        • NAV 4.7
        • NAV 4.6
        • NAV 4.5
        • NAV 4.4
        • NAV 4.3
        • NAV 4.2
        • NAV 4.1
        • NAV 4.0
        • NAV 3.15
        • NAV 3.14
        • NAV 3.13
        • NAV 3.12
        • NAV 3.11
        • NAV 3.10
        • NAV 3.9
        • NAV 3.8
      • Glossary
      • Hacking NAV
        • Hacker’s guide to NAV
        • Hacking with PyCharm
        • Using NAV with Docker for development
        • Javascript hacking
        • Checklist for releasing a new NAV version
        • Writing a new servicemon plugin
        • Adding support for a new environment probe device to NAV
        • The NAV API
        • Extending NAV locally
        • How to customize parts of NAV’s web interface
        • NAVbar search providers
        • Establishing SNMP tunnels using socat/SSH
  • Page
      • NAV documentation contents
        • For developers
        • Indices, glossary and tables
  • NAV documentation »
  • NAV documentation contents
    • For developers
    • Indices, glossary and tables
Source

NAV documentation contents¶

  • Overview
    • What it is
    • What NAV does
    • A brief history of NAV
  • Installing NAV
    • Installing a pre-packaged version of NAV
      • Installing NAV as a virtual appliance
      • Installing NAV from a Debian Package
      • Installing NAV using Docker Compose
    • Installing NAV from source code
  • Integrating Graphite with NAV
    • Configuring NAV
    • Configuring Graphite
  • Getting started with NAV
    • Minimal configuration
    • Starting NAV
    • Logging in to the web interface
    • Seeding your database
      • Adding your first management profile
      • Adding your first device to NAV
      • Verifying that collection is working
      • Selecting a device category
      • Importing multiple devices in bulk
    • Further reading
  • Getting organized
    • Organizing your seed data
    • Organizing your collected data
      • VLANs and subnets
      • Network prefixes and scopes
      • Vendors and device types
      • Cabling and patching
  • Troubleshooting topology problems in NAV
    • Overview
    • Physical topology
      • Two connected devices aren’t seen as connected by NAV
      • How NAV builds physical topology information
  • Migrating data from one NAV installation to another
    • What data should I migrate?
    • Migrating seed data
    • Migrating all or parts of the database
      • Intro
      • Dumping
      • Restoring
      • Full migration to a test server
  • Migrating RRD data to Graphite (from NAV 3 to NAV 4)
    • TL;DR
    • Conversion
      • Runtime considerations
      • Converting while NAV 4 is running
      • Migrating between different platforms
    • Limitations
      • Data archives
      • Aggregation methods
      • Network interface counter discontinuities
      • Environmental sensor precision changes
  • The NAV API
    • About
    • Tokens
      • How to get a token
      • How to use the token
    • Browsing the API
      • Available endpoints
      • Paging
      • Searching and filtering
      • Using POST, PUT, PATCH and DELETE
      • A specific scenario
  • FAQ
    • Is vendor X / device Y supported?
    • Why are there gaps in my graphs?
    • Why does NAV list my device’s uplink as N/A?
    • Why doesn’t device X show as down in the status page when I know it’s down?
    • A device is down, I see it on the status page, my profile should cover the event, but I am not alerted. Why?
    • Why is my Cisco switch’ syslog full of SNMP-3-AUTHFAIL messages for requests from my NAV server?
    • I added a new IP Device using SeedDB, but nothing happens. Why?
    • How do I make NAV send SMS alerts?
    • How long are ARP and CAM records kept in the database?
  • Reference material
    • Management profiles
      • Introduction
      • Supported profile types
    • Arnold
      • Introduction
      • What does Arnold do?
      • Using Arnold
      • Using the scripts
      • Configuring Arnold
      • Logging
      • FAQ
    • Cabling and Patch
      • Concepts
      • Cabling
      • Patch
      • Port Details
    • Event Engine
      • Introduction
      • Plugins
      • Configuration
      • Exporting alerts from NAV into other systems
    • Event Templates
      • Creating a template
    • Event- and alert type hierarchy
      • boxState events
      • serviceState events
      • moduleState events
      • thresholdState events
      • linkState events
      • boxRestart events
      • info events
      • notification events
      • deviceActive events
      • deviceState events
      • deviceNotice events
      • maintenanceState events
      • apState events
      • snmpAgentState events
      • chassisState events
      • aggregateLinkState events
      • psuState events
      • fanState events
      • bgpState events
    • Geomap
      • Technical documentation
    • IPAM - IP Address Management
      • Introduction
      • What can IPAM do?
      • Exploring your network
      • How to reserve prefixes
    • ipdevpoll
      • Usage
      • Configuring ipdevpoll
      • Multiprocess mode
    • External authentication (LDAP, REMOTE_USER)
      • Configuring NAV for LDAP authentication
      • External web authentication (REMOTE_USER)
    • MailIn
      • Configuring MailIn
    • navstats
      • Introduction
      • Usage
      • Example
    • PortAdmin
      • Introduction
      • What can PortAdmin do?
      • What the interface tells you
      • How to use the interface
      • The Config File
      • More about voice VLANs
    • Radius
      • Files
      • About
      • Installation
      • Usage
      • Making Changes
      • Known Issues
      • TODO
    • Setting up FreeRADIUS to log to NAV
      • Installing the accounting module
      • Installing the error log module
      • Setting up deletion of old entries
      • Configuring NAV
    • smsd
      • Usage
      • Message queues
      • Dispatchers
      • Extending
    • snmptrapd
      • What is the SNMP trap daemon?
      • Usage
      • Logging
      • Configuration
      • Trap handlers
    • Backend processes in NAV
      • The nav command
      • Other processes
  • Network Administration Visualized release notes
    • NAV 5.7
      • Dependency changes
      • Detection and alerting of Juniper chassis/system alarms
      • contains_address filter on prefix API endpoint
      • Even more flexible configuration of logging
    • NAV 5.6
      • Dependency changes
    • NAV 5.5
      • Dependency changes
      • API changes
      • Software upgrade history
      • Juniper BUILTIN devices
    • NAV 5.4
      • Dependency changes
    • NAV 5.3
      • Changes in governance and code ownership
      • Dependency changes
      • Backwards incompatible changes
    • NAV 5.2
      • Dependency changes
      • Backwards incompatible changes
      • Changes for developers
    • NAV 5.1
      • Dependency changes
      • Changed configuration files
      • Things to be aware of
      • New features
    • NAV 5.0
      • Dependency changes
      • Removed features
      • Backwards incompatible changes
      • New features
    • NAV 4.9
      • License changes
      • Dependency changes
      • Build system rewrite and source code directory layout
      • Backwards incompatible changes
      • News
    • NAV 4.8
      • Dependency changes
      • Other changes
      • News
    • NAV 4.7
      • Dependency changes
      • Support for monitoring BGP sessions
      • ipdevpoll multiprocess mode rewritten
      • Support for more infrastructure monitoring
      • Improved user interfaces for sensor/environment monitoring
      • Avoiding redundant SNMP polling for virtual device contexts
      • Changes to bulk import formats
      • Support for dashboard export/import
      • Audit logging
    • NAV 4.6
      • Dependency changes
      • IPAM (IP Address Management)
      • Static routes
      • Prefix information page and usage tags
      • Link aggregation support
      • Multi- and fullscreen dashboards
      • New dashboard widgets
      • Hierarchical locations
      • Business reports
      • Juniper EX switch series workaround
      • navuser command line
    • NAV 4.5
      • Dependency changes
      • Cabling and patches
      • navstats
      • API changes
    • NAV 4.4
      • Dependency changes
      • Interactive trend graphs
      • Slack dispatcher
      • Subnet matrix improvements
      • checkService.py has been renamed
    • NAV 4.3
      • Dependency changes
      • Data model changes (chassis, serial numbers, virtual devices, etc.)
      • The new chassisState family of alerts
      • Deleting out of service modules and chassis
      • Link, module and chassis status verification
    • NAV 4.2
      • Dependency changes
      • Rename some of your Whisper files to keep your statistics
      • Multicast listener stats from IGMP snooping
      • Graphite storage schema changes
      • Rewritten Status tool
      • Netmap redesign
      • SeedDB IP device form redesign
      • Custom attributes on IP devices and locations
      • New command line utilities
      • Files to remove
    • NAV 4.1
      • Dependency changes
      • Schema changes and hstore
      • Watchdog
      • New REST API
    • NAV 4.0
      • Dependency changes
      • Major changes to statistics collection
      • Migrating existing data
      • Files to remove
    • NAV 3.15
      • Dependency changes
      • Database schema changes
      • Configuration changes
      • mod_python vs. mod_wsgi
      • REST API
      • Write privileges for room image uploads
      • Files to remove
    • NAV 3.14
      • Dependency changes
      • Manual upgrade steps required
      • IPv6
      • Files to remove
    • NAV 3.13
      • Dependency changes
      • New eventengine
      • New alert message template system
      • VLANs
      • Arnold
      • Files to remove
    • NAV 3.12
      • Dependency changes
      • Cricket configuration
      • Room map
      • Toolbar search
      • Files to remove
    • NAV 3.11
      • Dependency changes
      • Topology source data
    • NAV 3.10
      • Cricket configuration changes
      • Topology detection
      • Link state monitoring
      • SNMP agent monitoring
      • Redundant power supply and fan state monitoring
      • IPv6 status monitoring
      • Files to remove
    • NAV 3.9
      • Dependency changes
    • NAV 3.8
      • Source code directory layout
      • Apache configuration
      • Database installation and migration
      • PortAdmin
      • Dependency changes
  • Glossary

For developers¶

  • Hacking NAV
    • Hacker’s guide to NAV
      • Contributing to NAV
      • Directory layout
      • Development languages and frameworks
      • Coding style
      • Database
      • Version Control
      • Testing and Continuous Integration
      • Tips and tricks
    • Hacking with PyCharm
      • Configuring PyCharm for use with NAV
    • Using NAV with Docker for development
      • Installing Docker and docker-compose
      • Building the Docker image
      • Using the container(s)
      • Controlling processes inside the nav container
      • Controlling log levels and configuration
      • Overriding the compose services
    • Javascript hacking
      • Avoiding caching
      • Javascript testing
      • Javascript hierarchy layout
    • Checklist for releasing a new NAV version
      • CI status check
      • Review milestone for next release on GitHub
      • Getting the code
      • Ensure generated docs are up to date
      • Updating changelog and release notes
      • Announcing the release
    • Writing a new servicemon plugin
      • A quick intro to the service monitor
      • The goal
      • Writing the plugin
      • In conclusion
    • Adding support for a new environment probe device to NAV
      • The goal
      • Sensors in NAV
      • Course of action
      • Dumping the MIB
      • Examining the MIB
      • Writing a MibRetriever
    • The NAV API
      • About
      • Tokens
      • Browsing the API
    • Extending NAV locally
      • Python search path modifications
      • Django local site settings
      • Overriding Django templates
    • How to customize parts of NAV’s web interface
      • How to add custom templates
      • Hooks
    • NAVbar search providers
      • A simple implementation example
      • The SearchProvider base class
      • The SearchResult namedtuple
    • Establishing SNMP tunnels using socat/SSH
      • Course of action - with docker
      • Troubleshooting - with docker
      • Course of action - without docker
      • Troubleshooting - without docker

Indices, glossary and tables¶

  • Index

  • Module Index

  • Glossary

Back to top

© Copyright 2012-2021 Uninett AS, 2022-2023 Sikt.
Created using Sphinx 4.4.0.