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
• 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
• Howtos
  • Command line utilities provided in NAV
    • nav
    • navcheckservice
    • navdf
    • navdump
    • naventity
    • navoidverify
    • navpgdump
    • navsnmp
    • navsyncdb
    • navsynctypes
    • navuser
  • Installing NAV from source code
    • Dependencies
    • Installing NAV
  • Install from source on Debian
    • 1. OS dependencies
    • 2. Get the source
    • 3. NAV/Python dependencies
    • 4. Install NAV itself
    • 5. Build the docs
    • 6. Initialize the database
    • 7. Create users and groups
    • 8. Ensure that a writeable uploads directory exists
    • 9. Install the static resources
    • 10. Configure Apache
    • 11. Installing and configuring Graphite
    • Start using NAV
  • Installing Graphite for use with NAV on Debian
    • Getting Graphite
    • Configuring Carbon
    • Configuring the Graphite web interface
  • Integrating Graphite with NAV
    • Configuring NAV
    • Configuring Graphite
  • Migrating RRD data to Graphite (from NAV 3 to NAV 4)
    • TL;DR
    • Conversion
    • Limitations
  • Troubleshooting topology problems in NAV
    • Overview
    • Physical topology
  • Robustifying e-mail
    • Single server installations
    • Multi server installations
  • Migrating data from one NAV installation to another
    • What data should I migrate?
    • Migrating seed data
    • Migrating all or parts of the database
  • Authenticating with the apache plugin mod_auth_openidc and Feide
    • Enabling the plugin on Debian
    • Feide Kundeportal configuration
    • Apache2 Configuration
    • NAV configuration
    • Gotchas
  • Authenticating with the apache plugin mod_auth_mellon and Feide
    • Enabling the plugin on Debian
    • Files needed
    • Feide Kundeportal configuration
    • Apache2 Configuration
    • NAV configuration
    • Gotchas
  • Controlling log output from NAV
    • Overview
    • Controlling log levels
    • Controlling which files logs are sent to
    • Using different logging config for individual programs
    • Rotating logs
    • Advanced logging configuration
  • The NAV API
    • About
    • Tokens
    • Browsing the API
  • NAV API Parameters
    • Searches
    • Filters
    • Detailed endpoint specifications
  • Securing NAV in production
    • Overview
    • SSL/TLS
• 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
    • juniperYellowAlarmState events
    • juniperRedAlarmState events
    • weathergoose_temperature events
    • weathergoose_humidity events
    • weathergoose_airflow events
    • weathergoose_light events
    • weathergoose_sound events
    • upsPowerState 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
  • Central data models of NAV’s event/alert subsystems
    • EventQueue
    • EventQueueVar
    • AlertQueue
    • AlertQueueVariable
    • AlertHistory
    • AlertHistoryVariable
    • AlertHistoryMessage
    • EventMixIn
    • EventType
    • AlertType
  • Central data models of NAV’s management subsystems
    • Netbox
    • NetboxType
    • Category
    • Interface
    • Room
    • Location
    • Organization
  • 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
  • Configuring JWT authentication
• Network Administration Visualized release notes
  • NAV 5.11
    • Dependency changes
    • More lifecycle events
    • Features in the making
  • NAV 5.10 (Unreleased)
    • Deprecation warnings
    • Dependency changes
    • Support for fetching ARP cache data from Palo Alto firewalls
    • Changed names of NAV command line programs
  • NAV 5.9
    • Changed names of NAV command line programs
    • Web security
  • NAV 5.8
    • Dependency changes
    • SNMPv3
    • Power-over-Ethernet configuration in PortAdmin
    • REMOTE_USER autocreate option
  • 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
    • Getting started with Docker Compose
    • 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