NV3 Documentation

API Documentation (Redoc)

Initializing search

NV3 Documentation

Table of Contents
Table of Contents
- Homepage
- Getting Started
  Getting Started
  - About NV3
    
    About NV3
    
    Introduction to NV
    
    System Information
    
    Network architecture for Network Access Control
  - Deploying NACVIEW
    
    Deploying NACVIEW
    
    Overview
    
    Import into hypervisor
    
    Import into hypervisor
    
    Import to Proxmox VE
    
    Import to VMware ESXi
    
    Import to XCP-ng
    
    Installation
    
    License installation guide
    
    Multi-node operation
  - Upgrade process
    
    Upgrade process
    
    System upgrade (version 3.0.1)
    
    System upgrade (version 3.0.2 onwards)
    
    System upgrade (3.0.2 onwards) - system nodes
  - Additional configuration
    
    Additional configuration
    
    VRRP Configuration
- Configuration Guides
  Configuration Guides
  - Active Directory
    
    Active Directory
    
    WLAN | EAP-TLS | GPO – Active Directory
  - Configuration of endpoints
    
    Configuration of endpoints
    
    Windows 11
    
    Windows 11
    
    Windows 11 | LAN | EAP-TLS
    
    Windows 11 | LAN | EAP-PEAP & AD
    
    Windows 11 | LAN | EAP-PEAP
    
    Linux
    
    Linux
    
    Linux | Network Manager | LAN & WLAN
- Network devices
  Network devices
  - Glossary
  - Cisco System
    
    Cisco System
    
    Cisco Catalyst C1000
    
    IOS12
    
    IOS15
    
    Cisco SG350
  - Cambium Networks
    
    Cambium Networks
    
    cnMatrix (LAN)
    
    cnMaestro (WLAN)
  - 3com Networks
    
    3com Networks
    
    3Com 4500G
  - DC Yunke Networks (DCN)
    
    DC Yunke Networks (DCN)
    
    DCN S5750E
- Tutorials
  Tutorials
  - NACVIEW objects
    
    NACVIEW objects
    
    Identities
    
    Identities
    
    Adding a single Identity
    
    Import
    
    Voucher multi create
    
    Multi create
    
    Endpoints
    
    Endpoints
    
    Adding a single Endpoint
    
    Import
- Administrator’s Guide
  Administrator’s Guide
  - Administration
    
    Administration
    
    Administration group
    
    Administration group
    
    Introduction to Administration group
    
    Introduction to Administration group
    
    Access Groups
    
    Access Groups
    
    Administration groups Show
    
    Administration groups List
    
    Add access group / Edit access group Form
    
    Archive
    
    Archive
    
    Introduction to Archive
    
    Introduction to Archive
    
    Archive Management
    
    Archive Management
    
    Archive Show
    
    Archive List
    
    Indexes
    
    Indexes
    
    Introduction to Indexes
    
    Introduction to Indexes
    
    Indexes Show
    
    Indexes List
    
    Object group
    
    Object group
    
    Introduction to Object group
    
    Introduction to Object group
    
    Object Groups Show
    
    Object Groups List
    
    Edit object group Form
    
    Add object group Form
    
    Sector
    
    Sector
    
    Introduction to Sector
    
    Introduction to Sector
    
    Sectors Show
    
    Sectors List
    
    Edit sector Form
    
    Add sector Form
    
    User
    
    User
    
    Introduction to User
    
    Introduction to User
    
    Administration Accounts Show
    
    Administration Accounts List
    
    Edit administration account Form
    
    Add administration account Form
  - Services
    
    Services
    
    Authorization server
    
    Authorization server
    
    Introduction to Authorization server
    
    Introduction to Authorization server
    
    Authorization Servers Show
    
    Authorization Servers List
    
    Add access group external identifier / Edit access group external identifier Form
    
    Add Authorization Server / Edit Authorization Server Form
    
    Add object group external identifier / Edit object group external identifier Form
    
    Captive portal
    
    Captive portal
    
    Introduction to Captive portal
    
    Introduction to Captive portal
    
    Captive Portal Show
    
    Captive Portal List
    
    Edit captive portal Form
    
    Captive portal object group config
    
    Captive portal object group config
    
    Introduction to Captive portal object group config
    
    Introduction to Captive portal object group config
    
    Configure Captive Portal Object Groups Show
    
    Configure Captive Portal Object Groups List
    
    Add captive portal object group config.form.titleAdd / Edit captive portal object group config Form
    
    Captive portal registration form
    
    Captive portal registration form
    
    Introduction to Captive portal registration form
    
    Introduction to Captive portal registration form
    
    Captive Portal Registration Forms Show
    
    Captive Portal Registration Forms List
    
    Add captive portal registration form / Edit captive portal registration form Form
    
    Captive portal sponsor
    
    Captive portal sponsor
    
    Introduction to Captive portal sponsor
    
    Introduction to Captive portal sponsor
    
    Captive Portal Sponsors Show
    
    Captive Portal Sponsors List
    
    Add captive portal sponsor / Edit captive portal sponsor Form
    
    Event definition
    
    Event definition
    
    Introduction to Event definition
    
    Introduction to Event definition
    
    Events Management Show
    
    Events Management List
    
    Add event definition / Edit event definition Form
    
    pki
    
    Integration server
    
    Integration server
    
    Introduction to Integration server
    
    Introduction to Integration server
    
    Integration Servers Show
    
    Integration Servers List
    
    Edit Integration Server Form
    
    LDAP service
    
    LDAP service
    
    Introduction to LDAP service
    
    Introduction to LDAP service
    
    LDAP Services Show
    
    LDAP Services List
    
    Edit LDAP Service Form
    
    Add LDAP service referral / Edit LDAP service referral Form
    
    LDAP service system node parameter
    
    LDAP service system node parameter
    
    Introduction to LDAP service system node parameter
    
    Introduction to LDAP service system node parameter
    
    LDAP Service System Node Parameters Show
    
    LDAP Service System Node Parameters List
    
    Edit LDAP Service System Node Parameter Form
    
    Add LDAP Service System Node Parameter Form
    
    Nacview assistant
    
    Nacview assistant
    
    Introduction to Nacview assistant
    
    Introduction to Nacview assistant
    
    NACVIEW Assistant Show
    
    NACVIEW Assistant List
    
    Add Nacview assistant / Edit Nacview assistant Form
    
    TACACS server
    
    TACACS server
    
    Introduction to TACACS server
    
    Introduction to TACACS server
    
    TACACS servers Show
    
    TACACS servers List
    
    Add TACACS server / Edit TACACS server Form
    
    Add TACACS server custom parameter / Edit TACACS server custom parameter Form
    
    Add TACACS server setting / Edit TACACS server setting Form
    
    Profiling definition
    
    Profiling definition
    
    Introduction to Profiling definition
    
    Introduction to Profiling definition
    
    Profiling List
    
    Add profiling definition / Edit profiling definition Form
  - System configuration
    
    System configuration
    
    Color identifier
    
    Color identifier
    
    Introduction to Color identifier
    
    Introduction to Color identifier
    
    Color Identifiers Show
    
    Color Identifiers List
    
    Add Color Identifier / Edit Color Identifier Form
    
    Device credential
    
    Device credential
    
    Introduction to Device credential
    
    Introduction to Device credential
    
    Device credentials Show
    
    Device credentials List
    
    Edit device credentials Form
    
    Add device credentials Form
    
    Notification channel
    
    Notification channel
    
    Introduction to Notification channel
    
    Introduction to Notification channel
    
    Notification Channels Show
    
    Notification Channels List
    
    Add notification channel / Edit notification channel Form
    
    Notification template
    
    Notification template
    
    Introduction to Notification template
    
    Introduction to Notification template
    
    Notification Templates Show
    
    Notification Templates List
    
    Edit notification template Form
    
    Printable template
    
    Printable template
    
    Introduction to Printable template
    
    Introduction to Printable template
    
    Printout templates Show
    
    Printout templates List
    
    Add Printout template / Edit Printout template Form
    
    Reauth device credential
    
    Reauth device credential
    
    Introduction to Reauth device credential
    
    Introduction to Reauth device credential
    
    Reauth Device Credentials Show
    
    Reauth Device Credentials List
    
    Add reauth device credential / Edit reauth device credential Form
    
    System node firewall
    
    System node firewall
    
    Introduction to System node firewall
    
    Introduction to System node firewall
    
    System Node Firewalls Show
    
    System Node Firewalls List
    
    Add system node firewall / Edit system node firewall Form
    
    System node
    
    System node
    
    Introduction to System node
    
    Introduction to System node
    
    Add configuration system node / Edit configuration system node Form
    
    Edit system node Form
    
    Add system node Form
    
    Add system node interface / Edit system node interface Form
    
    System node routing
    
    System node routing
    
    Introduction to System node routing
    
    Introduction to System node routing
    
    System node routing Show
    
    System node routing List
    
    Add system node routing / Edit system node routing Form
    
    VRRP system node
    
    VRRP system node
    
    Introduction to VRRP system node
    
    Introduction to VRRP system node
    
    VRRP system node Show
    
    VRRP system node List
    
    Add VRRP system node / Edit VRRP system node Form
    
    config
    
    config
    
    Introduction to config
    
    Introduction to config
    
    Backup configurator Form
    
    Disaster recovery configurator Form
    
    Eduroam configurator Form
    
    Monitoring configurator Form
    
    Profiling configurator Form
    
    SMTP configurator Form
    
    Syslog configurator Form
    
    Configurator TACACS Form
    
    Identities configuration Form
    
    Log rotation configuration Form
    
    Password update configuration Form
    
    User security settings Form
  - Networks
    
    Networks
    
    DHCP option
    
    DHCP option
    
    Introduction to DHCP option
    
    Introduction to DHCP option
    
    DHCP option set Show
    
    DHCP option set List
    
    Add DHCP option / Edit DHCP option Form
    
    Add DHCP option item / Edit DHCP option item Form
    
    DHCP whitelist
    
    DHCP whitelist
    
    Introduction to DHCP whitelist
    
    Introduction to DHCP whitelist
    
    DHCP whitelists Show
    
    DHCP whitelists List
    
    Add DHCP whitelist / Edit DHCP whitelist Form
    
    IP address
    
    IP address
    
    Introduction to IP address
    
    Introduction to IP address
    
    IP Addresses Show
    
    IP Addresses List
    
    Edit ipAddress Form
    
    Network device
    
    Network device
    
    Introduction to Network device
    
    Introduction to Network device
    
    Network devices Show
    
    Network devices List
    
    Clone network device Form
    
    Edit network device Form
    
    Add network device Form
    
    Subnetwork
    
    Subnetwork
    
    Introduction to Subnetwork
    
    Introduction to Subnetwork
    
    Subnetworks Show
    
    Subnetworks List
    
    Edit subnetwork Form
    
    Edit migrate subnetwork Form
    
    Add subnetwork Form
    
    Edit subnetwork IP addresses Form
    
    Edit resize subnetwork Form
    
    VLAN
    
    VLAN
    
    Introduction to VLAN
    
    Introduction to VLAN
    
    VLANs Show
    
    VLANs List
    
    Add VLAN / Edit VLAN Form
    
    WiFi Network
    
    WiFi Network
    
    Introduction to WiFi Network
    
    Introduction to WiFi Network
    
    WiFi networks Show
    
    WiFi networks List
    
    Add WiFi network / Edit WiFi network Form
    
    Port
    
    Port
    
    Introduction to Port
    
    Introduction to Port
    
    Add port / Edit port Form
  - Objects
    
    Objects
    
    Endpoint device
    
    Endpoint device
    
    Introduction to Endpoint device
    
    Introduction to Endpoint device
    
    Endpoint devices Show
    
    Endpoint devices List
    
    Edit endpoint device Form
    
    Add endpoint device Form
    
    Identity
    
    Identity
    
    Introduction to Identity
    
    Introduction to Identity
    
    Identities Show
    
    Identities List
    
    Edit identity Form
    
    Add identity Form
    
    MAC address
    
    MAC address
    
    Introduction to MAC address
    
    Introduction to MAC address
    
    MAC Addresses Show
    
    MAC Addresses List
    
    Add MAC Address / Edit MAC Address Form
    
    Certificate
    
    Certificate
    
    Introduction to Certificate
    
    Introduction to Certificate
    
    Object Certificates Show
    
    Object Certificates List
    
    Edit object certificate Form
    
    Add object certificate Form
    
    Organizational unit
    
    Organizational unit
    
    Introduction to Organizational unit
    
    Introduction to Organizational unit
    
    Organizational Units Show
    
    Organizational Units List
    
    Edit organizational unit Form
    
    Add organizational unit Form
    
    identityCommon
    
    identityCommon
    
    Introduction to identityCommon
    
    Introduction to identityCommon
    
    Add Identity multi create Form
    
    identityVoucher
    
    identityVoucher
    
    Introduction to identityVoucher
    
    Introduction to identityVoucher
    
    Add identity voucher multi create Form
  - Reports
    
    Reports
    
    Events accounting
    
    Events accounting
    
    Introduction to Events accounting
    
    Introduction to Events accounting
    
    Accounting events Show
    
    Accounting events List
    
    Events DHCP
    
    Events DHCP
    
    Introduction to Events DHCP
    
    Introduction to Events DHCP
    
    DHCP events Show
    
    DHCP events List
    
    MS events
    
    MS events
    
    Introduction to MS events
    
    Introduction to MS events
    
    MS events Show
    
    MS events List
    
    Events OTP
    
    Events OTP
    
    Introduction to Events OTP
    
    Introduction to Events OTP
    
    OTP events Show
    
    OTP events List
    
    Events SNMP trap
    
    Events SNMP trap
    
    Introduction to Events SNMP trap
    
    Introduction to Events SNMP trap
    
    SNMP trap events Show
    
    SNMP trap events List
    
    Events syslog
    
    Events syslog
    
    Introduction to Events syslog
    
    Introduction to Events syslog
    
    Syslog events Show
    
    Syslog events List
    
    Events TACACS
    
    Events TACACS
    
    Introduction to Events TACACS
    
    Introduction to Events TACACS
    
    TACACS events Show
    
    TACACS events List
  - Access Policies
    
    Access Policies
    
    Policy
    
    Policy
    
    Introduction to Policy
    
    Introduction to Policy
    
    Policies Show
    
    Policies List
    
    Clone policy Form
    
    Clone policy rule Form
    
    Edit policy rule Form
    
    Add policy / Edit policy Form
    
    Edit test policy Form
    
    Edit test policy Form
    
    Policy category
    
    Policy category
    
    Introduction to Policy category
    
    Introduction to Policy category
    
    Policy categories Show
    
    Policy categories List
    
    Add policy category / Edit policy category Form
    
    Policy option
    
    Policy option
    
    Introduction to Policy option
    
    Introduction to Policy option
    
    Policy options Show
    
    Policy options List
    
    Add policy option / Edit policy option Form
    
    Add policy option item / Edit policy option item Form
    
    Policy time
    
    Policy time
    
    Introduction to Policy time
    
    Introduction to Policy time
    
    Policy times Show
    
    Policy times List
    
    Add policy time / Edit policy time Form
    
    Policy profile action
    
    Policy profile action
    
    Introduction to Policy profile action
    
    Introduction to Policy profile action
    
    Policy profile actions List
    
    Add policy profile action / Edit policy profile action Form
- API Documentation
- Release notes
  Release notes
  - 3.0.2
- Legal terms & privacy policy

API Documentation (Redoc)🔗

Sep 04, 2026

Created using Sphinx 9.1.0. and Sphinx-Immaterial