arrow-left

Only this pageAll pages
gitbookPowered by GitBook
1 of 84

Aviz Network Copilot

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Getting Started

This section covers the basics of getting started, understanding the Metrics Matrix, and onboarding data efficiently.

  • System Requirements

  • Licensing

Metrics Support

Cloud Deployment

Component
Specification

Compute Instance

  • vCPU - Min: 16 , Recommended: 32

  • RAM - Min: 32 GB , Recomended: 64 GB

  • Disk - 1TB

Model

  • Gemini 2.5 Flash/Pro

  • OpenAI GPT 4.1/5

Environment

  • A 64-bit Ubuntu Server version 22.04 or later

  • NCP-Basic

  • NCP-Advanced

  • NCP-Performance

Docker & Docker-Compose
License

System Requirements

Whether you prefer to deploy the application on-premises and within your infrastructure or take advantage of the scalability and agility of cloud services, NCP supports both deployment strategies.

hashtag
On-Prem Deployment

Deploy NCP within your infrastructure to maintain complete control over your data, security policies, and system configurations.

hashtag

Take advantage of the scalability, flexibility, and reduced maintenance overhead that comes with deploying NCP in the cloud.

Network Copilot

hashtag
What is Network Copilot?

Aviz Network Copilot (NCP) is an AI-native, vendor-neutral network observability and operations assistant designed to accelerate troubleshooting, streamline operations, and improve infrastructure resilience. It empowers network and platform teams to interact with complex telemetry and configuration data using intuitive, natural language prompts.

NCP combines Generative AI with a powerful multi-vendor, multi-NOS data mobility platform to unify structured and unstructured data across telemetry, configuration, inventory, and ticketing systems. It continuously ingests, correlates, and analyzes data across domains, enabling real-time insights, historical context, and predictive recommendations.

Built for hybrid, multi-cloud environments, NCP supports integrations across the network stack—from switches and routers to cloud storage, observability tools, and ITSM platforms. It reduces mean time to insight and action (MTTIA), enables proactive support, and provides always-on compliance and lifecycle visibility, helping teams transition from reactive firefighting to strategic network engineering.

hashtag
Explore these sections to set up and work with Network Copilot:

Deployment Prerequisites

hashtag
External Network Access Requirements

hashtag
NCP Web & Chat UI

Service
Host Port / Protocol
Purpose

hashtag
Flow & Log Ingest

Service
Host Port / Proto
Purpose

hashtag
NCP Backend Services

Service
Host Port / Proto
Purpose

hashtag
NCP Internal Services

Service
Internal Ports
circle-info

These port numbers must be available and allowed through the firewall if the NCP Controller and nodes are in different DMZs.


You can use the following command to verify the currently used ports:

sudo iptables -L

hashtag
Node Configuration Requirements

  • Network reachability from the NCP Controller

  • SSH access must be enabled

  • must be enabled on non-SONiC switches

hashtag
Browser Requirements for NCP Web GUI Access

  • Google Chrome version 107 or later

  • Mozilla Firefox version 106 or later

What's New?

hashtag
Release 1.5.5

  • Roles & Permissions Support for default and admin-defined roles with multi-level access control across projects and users.

  • Upgrade & Installation A unified installer.sh now supports direct in-place upgrades between versions (for example, R1.5.4 to R1.5.5).

  • NCP SDK (Backend Support Only) Backend support was introduced for the NCP SDK to enable user-created agent integrations.

  • Project Isolation & Context History Projects enforce strict data isolation, ensuring AI responses use only project-specific connectors.

  • Multi-Agent (Connector) Support Projects can include multiple agents or data connectors, enabling cross-domain analysis and correlation within a single project.

  • Notes and Limitations

    • Audit Reports - Supported only for unmanaged switches, including SONiC, Arista, and Cisco devices.

    • Firewall Devices - Fortinet and Palo Alto firewalls support manual addition only.

hashtag
Release 1.5.4

  • Project Isolation & Context History Strict project-level data isolation with context-aware follow-up conversations.

  • Multi-Agent Projects Support for multiple agents within a project to enable cross-domain correlation.

  • MCP-Based Connector Migration

hashtag
Release 1.5.3

  • Advanced LDAP Authentication Certificate-based LDAP login with admin-configurable authentication modes and AD availability validation.

  • Auto Complete (Preview) Prompt autosuggestions for new and existing chats. The feature remains unstable and partially validated.

  • Charting Improvements MCP-based chart rendering for improved reliability and consistency.

hashtag
Release 1.5.2

  • Data Connector Enhancements

    • Multi-Instance Data Connectors

    • Splunk MCP Integration

hashtag
Release 1.5.1

  • Project-Level LLM Configuration Assign a specific LLM per project to tailor AI responses to project-specific requirements and data context.

  • Authentication & Access LDAP (Microsoft Active Directory) Enterprise login using existing AD credentials for streamlined and secure access.

  • Notifications & Preferences

    User-configurable notifications for:

hashtag
Release 1.5.0

Collaborative Intelligence

Redesigned platform with project-level organization, enabling multi-user AI chat, shared context, and real-time collaboration for faster and smarter NetOps decision-making.

Each project now supports its files, connectors, and access rules, ensuring data isolation, relevance, and precision in AI-driven responses.

Live user presence, @mentions, and shared chat history keep everyone on the same page. AI responses now route intelligently across project-specific data sources using custom data-connector tags.

  • Basic NetOps

  • Flow Analytics

  • Security Audits

  • Inventory Insights

hashtag

  • Cloud & Storage: AWS S3, Azure, Google Cloud Storage

  • Monitoring & Management: Aviz ONES, NetBox, Cisco Nexus Dashboard, Catalyst Center, IP Fabric, SolarWinds,

  • Data & Logs: ELK Stack, Splunk, Loki, InfluxDB, Snowflake

hashtag
User Experience

  • New project-based UI with intelligent navigation and pinning

  • Archive completed chats/projects for a decluttered view

  • Enhanced search and filtering to quickly find what matters

AI & Engine Enhancements

  • Reasoning Engine: Now powered by Llama-3.3-70B-Instruct for more accurate, contextual, and technically sound responses.

  • Network Correlation Engine (Beta): Performs cross-table analysis to uncover hidden patterns and answer complex queries.

Fixes & Stability Improvements

  • Accurate SQL generation for Flow Analytics

  • Connector state sync across team members

  • Restored audit report and revamped device page

Known Limitations

  • Response loading UI is not yet visible to all project members

  • Uploaded files lack uploader attribution and preview

hashtag
Release 1.4.0

  • Reasoning Model Upgraded LLM responses featuring advanced multi-step reasoning and dynamic decision-making to elevate troubleshooting capabilities and forecasting accuracy

  • Agentic Architecture Introduced a new agentic architecture that empowers autonomous task execution and seamless interaction with external systems

hashtag
Release 1.3.0

  • Inferencing engine enhancements for improved throughput & reduced latency

hashtag
Release 1.2.0

  • Enhanced LLM responses, security, and audit report features

  • Improved user interface

  • Critical bug fixes and stability improvements

hashtag
Release 1.1.0

  • now supports devices using gNMI, SNMP, API, sFlow

  • User Interface: Provides a user-friendly interface that makes it easy for users to ask questions and get answers

hashtag
Release 1.0.0

hashtag
Features Supported

  • Data Ingestion: NCP supports gNMI and SNMP for network state metrics. It also supports the ingestion of sFlow records

  • NCP answers a wide variety of questions in the following use cases:

    • Inventory & Accounting

hashtag
Open Issues

  • NCP-231: The Model returns data even for single-letter or single-word queries.

  • NCP-336: The Model provides incomplete or inaccurate responses to certain questions.

  • NCP-340: The Pie chart for Japanese queries should display labels and details in Japanese.

Cloud Deployment
Downloading Network Copilot
  • Deploying & Managing Network Copilot

  • Web GUI Administration

  • Accessing NCP

  • Data Connectors

  • Curated Use Cases

  • Contact Aviz Support

  • What's New?
    Quick Start
    Getting Started
    Autocomplete - Must be explicitly enabled; currently unstable and not fully validated.
  • Data Export - Export to CSV/Excel returns raw data only.

  • Prompt Behavior - Initial prompts may require additional context to be effective.

  • ELK Integration - Appears as an API-based connector in the UI but operates via MCP in the backend.

  • File Connector - Supported only in projects created by admin users.

  • Splunk Index Handling - Index and sourcetype must be specified in the prompt when needed.

  • NetBox

  • Splunk

  • ELK

  • ServiceNow

  • Firewall Support Fortinet and Palo Alto firewall device inventory, interface visibility, and firewall policy details.

  • Data Connector Enhancements

    • Splunk Agent Expansion Flow Analytics coverage extended with chart support.

    • Collaboration Rocket.Chat integration supports both user messages and AI-generated responses.

    • Data Connector UX Improvements

  • NetQ
  • LDAP Enhancements Centralized versus local user validation, restricted edits for LDAP users, and automatic local user creation on first login.

  • AI Response Feedback Negative feedback now captures user-provided reasons to improve AI responses.

  • User Interface Enhancements Collapsible and minified sidebar with navigation and layout improvements.

  • Audit & Security

    • Downloadable audit reports with improved templates

    • PaloAlto firewall security policy support.

    • @mentions

    • Project additions

  • Dashboard Analytics Enhanced dashboards provide improved visibility into project usage, data activity, and performance metrics.

  • Support Knowledge Base

  • Upgrade Compliance

  • Ticketing and RCA (ServiceNow, Zendesk)

  • Observability & Packet Capture

  • Collaboration & ITSM: Slack, ServiceNow, Zendesk
    Auto-refresh notifications and consistent @mention behavior
    Improved user management and invite workflows
  • More consistent behavior across UI components

  • Basic NetOps

  • Flow Analytics

  • Security Audits

  • Inventory Insights

  • Support Knowledge Base

  • Upgrade Compliance

  • New External Integrations Integrated with a wider ecosystem, including:

    • ELK Stack

    • Google Cloud Storage (GCS)

    • Loki

    • InfluxDB

    • NetBox

    • Azure

    • Cisco Nexus Dashboard

  • User Interface:

    • Suggested questions now appear to help guide your next steps

    • Rolled out an exciting, revamped UI featuring improved navigation, modern design, and enhanced customization options for a streamlined user experience

  • Critical bug fixes and overall stability improvements to ensure reliable performance in diverse operational environments

  • Known Limitations:

    • In the event of an error during chat interactions, please initiate a new chat session to prevent cascading issues

    • Ensure prompts are specific for optimal results, as vague inputs may result in unexpected or incomplete responses

  • Amazon S3
  • Splunk

  • Snowflake

  • Use Case Improvements:

    • Audit Reports

    • Application Visibility

    • Upgrade Compliance

  • Collection of Additional Metrics through:

    • Interface Level Errors & Discards

    • Transceiver DOM Information:

      • Tx/Rx Power

      • Temperature

      • Voltage

      • Bias Current

  • Improved support for the Japanese language

  • Minor UI Changes for quality-of-life improvements

  • Scalability improvements

  • Critical bug fixes and stability improvements

  • Streaming responses

  • Exporting conversations

  • Import user context

  • Timestamps

  • Regenerating responses

  • User feedback on the responses for improvements

  • Light and Dark Modes

  • Generate configurations and charts

  • Capacity Planning
  • Anomaly Detection

  • Compliance

  • AI Fabric

  • NCP-341: The Model's responses are inaccurate or incomplete for some Japanese-language questions.
    Per-Project Data Controlarrow-up-right
    Smarter Conversationsarrow-up-right
    New & Improved Use Cases:arrow-up-right
    Expanded External Integrationsarrow-up-right
    Palo Alto Firewallarrow-up-right
    New & Improved Use Cases:
    Slack Integration
    External Data Ingestion:
    Data Ingestion
    New Use Cases

    NCP Chart MCP

    10130/tcp

    Chart MCP data port

    NCP Palo Alto Collector

    internal only

    NCP SNMP Collector

    162/udp, 8093/tcp

    NCP Streams Processor

    8080/tcp

    NCP Schema Registry

    8081/tcp

    NCP ksqlDB

    internal only

    NCP Zookeeper

    2181/tcp, 2888/tcp, 3888/tcp

    NCP LLM Service

    8000/tcp

    NCP Knowledge Base

    8000/tcp

    NCP PostgreSQL DB

    5432/tcp

    NCP Collector DB

    5432/tcp, 8008/tcp, 8081/tcp

    NCP Web UI

    443/tcp

    Web GUI access

    NCP Chat UI

    9001/tcp

    Chat API endpoint

    Prompt Autocomplete

    8004/tcp

    Prompt autocomplete service

    NetFlow Ingest

    2055/udp

    NetFlow ingestion from network devices

    sFlow Ingest

    6343/udp

    sFlow ingestion from network devices

    Flow Collector API / UI

    8099/tcp

    Flow collector HTTP endpoint

    Syslog Ingest

    514/udp

    NCP Redis

    6379/tcp

    Backend cache / message broker

    NCP Kafka Broker

    9092/tcp

    Kafka client access

    NCP Kafka Connect

    8083/tcp

    Kafka Connect REST API

    NCP Chart MCP

    1122/tcp

    NCP Celery Beat

    internal only

    NCP Celery Worker

    internal only

    NCP DB Migrator

    internal only

    NCP File Connector

    internal only

    NCP Fortinet Collector

    internal only

    NCP Config Collector

    8094/tcp

    SNMP

    Syslog ingestion

    Chart MCP control port

    On-Prem Deployment

    hashtag
    GPU:

    GPU
    GPU Count (Recommended)
    GPU Count (Future Ready)
    Total GPU vRAM (Recomended)
    Total GPU vRAM (Future Ready)
    PCIe

    hashtag
    Server:

    Component
    Specification

    hashtag
    Software:

    Component
    Specification

    Quick Start

    hashtag
    Quick Start Navigation:

    • Overview of hardware and software prerequisites to ensure compatibility

    Deploying & Managing Network Copilot

    hashtag
    Installation Overview

    NCP Installation follows the below steps in the order sequence:

    Data Ingestion Matrix

    Network Copilot collects and analyzes a wide range of network data by integrating with various data connectors across multiple categories.

    The list below outlines what data is ingested, grouped by category, with supported connectors.

    hashtag
    Inventory

    Downloading Network Copilot

    Users can download the latest version of NCP from the . Please refer to the the latest version of the NCP application.

    • Work with the Aviz Sales/Support contact to create an account on the Aviz Networks Support Portal

    • Log in to with your account credentials

    Licensing

    Aviz Open Packet Broker supports 3 license types as listed below

    License Type
    Supported Nodes

    Installing Prerequisite Packages

    This section outlines the steps required to prepare your system to deploy NCP

    Update the local package index:

    hashtag
    Install Docker & Docker-compose:

    Install Docker:

    Install Docker Compose:

    hashtag
    Device Information
    • Data: asic, ip, hostname, serial, macaddress, model, osversion, kernel version, onie version, uptime, asic_type

    • Supported Connectors: Aviz ONES (SONiC, Cumulus), Nexus Dashboard, Catalyst Center, SolarWinds, IP Fabric*, NetBox

    hashtag
    Platform Components (Fan/PSU)

    • Data: presence, model, serial, drawer_name, direction, rpm, replaceable

    • Supported Connectors: Aviz ONES, Nexus Dashboard*, IP Fabric*

    hashtag
    Port Details

    • Data: ifname, admin status, alias, speed, autoneg, mtu, description, fec, breakout, spec compliance

    • Supported Connectors: Aviz ONES (SONiC, Cumulus), Nexus Dashboard*, IP Fabric*

    hashtag
    Health Monitoring

    hashtag
    Platform Health

    • Data: cpu_util, mem_util, psu_power, psu_current, psu_voltage, psu_led status

    • Supported Connectors: Aviz ONES (SONiC, Cumulus), Nexus Dashboard*, IP Fabric*

    hashtag
    Port Health

    • Data: ifname, oper_status

    • Supported Connectors: Aviz ONES (SONiC, Cumulus), Nexus Dashboard, IP Fabric*

    hashtag
    Optics

    • Data: tx/rx bias, power, voltage, temperature, low/high thresholds (alarms, warnings)

    • Supported Connectors: Aviz ONES (SONiC)

    hashtag
    Traffic Visibility

    hashtag
    Interface Counters

    • Data: in/out packets, errors, discards, octets

    • Supported Connectors: Aviz ONES (SONiC, Cumulus), Nexus Dashboard*

    hashtag
    Flow Data

    • Data: srcIP, destIP, srcPort, destPort, proto, pkts, bytes, sampler_address, ingress interface, egress interface

    • Supported Connectors: Aviz NCP Flow Collector,Splunk, ELK, Azure Blob, GCP Cloud, Influx, Snowflake, AWS S3

    hashtag
    Logs

    hashtag
    System Logs

    • Data: ip, hostname, program, severity, priority, message, timestamp

    • Supported Connectors: Aviz NCP SyslogD,Splunk, ELK, Loki

    hashtag
    Ticketing & ITSM

    hashtag
    Ticket Lifecycle

    • Data: Create, Update, List tickets

    • Supported Connectors: Zendesk, ServiceNow

    circle-info

    Data-Connectors marked with * indicate partial integration support.

    Always refer to the latest release notes for the most up-to-date compatibility and feature details.

    Basic

    100

    Advanced

    1000

    Performance

    > 1000

    Downloading Network Copilot Step-by-step guide to downloading the NCP package
  • Licensing & Activation Check your current license status, learn about upgrades, and follow easy activation steps

  • Deploying Network Copilot Instructions for installation, configuration, and launching your Network Copilot instance

  • Manage Your NCP Instance Centralized page to oversee and manage all aspects of your NCP deployment.

  • Device Addition / Onboarding Detailed instructions for integrating new devices into your NCP instance

  • Web UI Management Quick access to NCP UI & management UI

  • External Integrations Learn how to connect third-party services and extend visibility & functionality.

  • Support & Contact Direct links to Aviz support portal & help center

  • System Requirements
    Click on the Downloadsarrow-up-right section, under NCP, and click to download Network Copilot
    • English Version: ncp-rx.x.x-en.tar.bz2

    Support Portal
    link to accessarrow-up-right
    https://support.aviznetworks.comarrow-up-right

    Upgrading NCP

    • To Upgrade:

      • Download the Latest NCP installation package

      • Follow the Steps to upgrade the NCP Controller

    circle-check

    The installer can automatically detect and perform either a fresh installation or an upgrade.

    Preparing the System

  • Installing ONES T-Agents on SONiC Switches or configuring SNMP on other switches for Telemetry

  • hashtag
    This section outlines the steps necessary for installing NCP:

    • Deployment Prerequisites

    • Installing Prerequisite Packages

    • Deploying the NCP Package

    hashtag
    License

    After installing the NCP application, users must contact AVIZ support to obtain a license. A trial license, valid for up to 8 devices and 30 days, can also be requested.

    The license is issued based on the number of nodes.

    hashtag
    Features Supported with Trial License:

    • NCP Chat Interface

    • Telemetry Visibility (Monitor, inventory, analytics)

    • All available use-cases

    hashtag
    To obtain a license, contact Aviz Support, providing the details below:

    • License Duration - In Years (1, 3, 5)

    • Node Count

    • Installation ID

    • Email ID

    License Readiness
    hashtag
    Installing NVIDIA GPU Drivers:

    Install GPU Drivers:

    Reboot the system:

    hashtag
    Installing NVIDIA Toolkit:

    We will leverage the container toolkit provided by NVIDIA to deploy the NCP backend as an additional Docker container along with NCP services packaged as containers.

    Install NVIDIA Container Toolkit:

    Configure the toolkit:

    Additional packages:

    • pbzip2: A parallel bzip2 compression tool for faster file compression

    • python3-pip: A package manager for Python3, used to install Python libraries

    sudo apt update -y

    H100 (96 GB)

    2

    4

    192GB

    384GB

    4

    H200 (96 GB)

    2

    4

    192GB

    384GB

    4

    RTX Pro 6000 (96 GB)

    2

    4

    192GB

    384GB

    5

    A100 (80 GB)

    2

    4

    160GB

    320GB

    4

    A6000 (48 GB)

    4

    8

    192GB

    384GB

    4

    L40S (48 GB)

    4

    8

    192GB

    384GB

    4

    CPU Cores

    Minimum: 16 Cores Recommended: 32 Cores

    RAM

    Minimum: 64 GB Recommended: 128 GB

    Disk

    2 TB

    Environment

    • A 64-bit Ubuntu Server version 22.04 or later

    • Docker & Docker-Compose

    • NVIDIA-based GPU with CUDA 12

    License

    • NCP-Basic

    • NCP-Advanced

    • NCP-Performance

    Model

    • LLAMA 3.3 70B Instruct (Default)

    • GPT-OSS-120B

    Managing Network Copilot

    The following steps guide you through managing your NCP installation:

    • Upgrade the license

    • Upgrade the NCP instance

    Upgrading License

    hashtag
    Please navigate to the page below to upgrade to a new subscription-based license

    circle-check

    Reach out to for generating a new License

    Web UI Administration

    hashtag
    This section outlines the steps to navigate the NCP UI:

    Accessing NCP

    hashtag
    1. Log in to Network Copilot

    Launch the Network Copilot UI in your browser and log in using your credentials.

    hashtag

    Global Chat Search

    The Network Copilot UI includes a global chat search capability that allows users to quickly find conversations across all projects and chat contexts.

    hashtag
    Key Features

    • Global Search Scope Search across all projects, not just the currently active project.

    Deploying the NCP Package

    hashtag
    Installation Steps

    hashtag
    1. Extract the Installation Package

    Uninstalling NCP

    hashtag
    Uninstallation Steps

    hashtag
    1. Navigate to the NCP Installation Directory

    Install
    curl -fsSL https://get.docker.com -o get-docker.sh
    sudo sh get-docker.sh
    Verify
    ubuntu@NCP:~$ docker --version
    Docker version 25.0.0, build e758fe5
    ubuntu@NCP:~$
    sudo curl -L "https://github.com/docker/compose/releases/download/v2.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
    
    sudo chmod +x /usr/local/bin/docker-compose
    sudo apt install nvidia-utils-535 -y
    sudo apt install ubuntu-drivers-common -y
    sudo apt install nvidia-driver-535 -y
    sudo reboot
    curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | sudo gpg --dearmor -o /usr/share/keyrings/nvidia-container-toolkit-keyring.gpg   && curl -s -L https://nvidia.github.io/libnvidia-container/stable/deb/nvidia-container-toolkit.list |     sed 's#deb https://#deb [signed-by=/usr/share/keyrings/nvidia-container-toolkit-keyring.gpg] https://#g' |     sudo tee /etc/apt/sources.list.d/nvidia-container-toolkit.list   &&     sudo apt-get update
    sudo apt-get install -y nvidia-container-toolkit
    Configure
    sudo nvidia-ctk runtime configure --runtime=docker
    sudo systemctl restart docker
    Verify
    sudo docker run --rm --runtime=nvidia --gpus all ubuntu nvidia-smi
    sudo apt install pbzip2 -y
    sudo apt install python3-pip -y
    Managing Network Copilot
    Upgrade the license
    Upgrade the NCP instance
    Uninstall NCP
    NVIDIA Container Toolkit
    Uninstall NCP
    Login page
  • Onboarding Switches

    • Using SNMP

  • Accessing NCP

  • User/Admin View

    • Admin Operations

    • User Operations

  • hashtag
    NCP User Interface - Features

    • Switches can be added via SNMP using the YAML editor or a CSV file

    • Inventory Operations

      • Adding/Removing devices using a YAML or CSV file

      • Monitoring Status

    • User View

    • Admin View

    • System Notifications

    • Licensing

    • User Management

      • Add/Edit/Delete User

      • Role Management

    • API Access from External Tools

    License Activation
    hashtag
    2. Change Directory and Start the Installer

    hashtag
    3. SSL Certificate Configuration (Optional)

    Network Copilot supports custom SSL certificate integration.

    When prompted:

    Option A: Use a Custom SSL Certificate

    Select y and provide the paths to your certificate files:

    Replace the private key and certificate paths with the correct file locations on your system.

    Option B: Use the Default Self-Signed Certificate

    Select n to use the self-signed certificate bundled with NCP:

    hashtag
    4. Configure Host IP Address

    Provide the server IP address that external services will use to connect to Network Copilot.

    hashtag
    5. Installation Progress

    The installer performs the following steps automatically:

    • Installs required system prerequisites

    • Loads and initializes Docker images

    • Sets up the Network Copilot runtime environment

    Example output:

    hashtag
    6. Access the Network Copilot UI

    Once installation completes, access the UI using:

    Example:

    hashtag
    7. Activate License

    After installation, activate the Network Copilot license from the UI.

    hashtag
    Verify the Installation

    Verify that all services are running successfully.

    Example output:

    All containers should be in the Up state. If any service is not running, review the installer and Docker logs.

    For further assistance, raise a support ticket with us.

    After a successful installation, the Docker service ncp-db-migrator will appear in an Exited (down) state.

    This behavior is expected.

    hashtag
    2. Run the Uninstaller

    hashtag
    3. Database Cleanup (Optional)

    During the uninstallation process, you will be prompted to remove the Network Copilot database.

    • Select y to remove all Network Copilot data (irreversible).

    • Select n to retain the database volumes.

    If you choose to clear the database, you will be asked to confirm:

    ⚠️ Selecting y will permanently delete all Network Copilot data.

    hashtag
    4. Uninstallation Progress

    The uninstaller will:

    • Stop all Network Copilot services

    • Remove containers and images

    • Optionally remove database volumes

    Example output:

    hashtag
    Verify Uninstallation

    • Run the following command:

    • Ensure no Network Copilot containers are listed.

    • Confirm the UI is no longer accessible:

    If the URL is inaccessible and no NCP containers are running, the uninstallation is complete.

    tar -I pbzip2 -xf ncp-rX.X.X-en.tar.bz2
    cd ncp-rX.X.X-en
    sudo ./installer.sh
    Would you like to install a custom domain SSL certificate?
    (If you select 'n', the installation will proceed with a self-signed certificate.)
    [y/n]:
    [y/n]: y
    → Proceeding with custom domain SSL certificate installation..
    
    Enter the path to the private key file: ./certs/server.pem
    Enter the path to the certificate file: ./certs/server.crt.pem
    [y/n]: n
    → Proceeding with self-signed certificates.
    Please provide the host IP address.
    This IP will be used by external services to connect to the Network Copilot.
    
    Enter the host IP address: 10.20.5.33
    → Host IP saved to server_host_ip.txt
    Installing prerequisites...
    → Prerequisites installed.
    
    Installing Network Copilot...
    
    Setting up the environment and loading essential dockers...
    <...>
    
    Network Copilot Installation Completed Successfully!
    https://<host-ip>
    https://10.20.5.33
    docker-compose ps -a
    Name                    State   Ports
    --------------------------------------------------------------
    ncp-ui                  Up      0.0.0.0:443->443/tcp
    ncp-api                 Up      0.0.0.0:9001->8000/tcp
    ncp-flow-collector      Up      2055/udp, 6343/udp, 8099/tcp
    ncp-syslog-collector    Up      514/udp
    ncp-broker              Up      9092/tcp
    ncp-connect             Up      8083/tcp
    ncp-schema-registry     Up      8081/tcp
    ncp-zookeeper           Up      2181/tcp
    <...>
    cd ncp-rx.x.x-en
    sudo ./uninstaller.sh
    Do you want to clear DB data? [y/n]:
    WARNING! This will remove anonymous local volumes not used by at least one container.
    Are you sure you want to continue? [y/N]: y
    Starting Network Copilot Uninstaller...
    
    Bringing down Network Copilot services and removing images
    <...>
    
    Removing database volumes...
    
    ------------------------------------------------------------
    Uninstallation process for Network Copilot is complete.
    ------------------------------------------------------------
    docker-compose ps -a
    https://<server-ip>

    Settings >> Accounts >> License >> Upgrade License

    1. Click on 'Upgrade License' & enter the 'license key' and click activate

    Aviz Support
    2. Access the Chat Interface

    After successful login, you are redirected to the default Network Copilot Chat page.

    hashtag
    3. Start Interacting

    Enter your queries in the chat interface to receive real-time responses and insights.

    Keyword-Based Search Supports keyword and phrase matching to locate relevant conversations.

  • Quick Navigation Jump directly to the selected chat thread from the search results.

  • hashtag
    How to Use

    Use the search bar at the top of the chat interface to perform a global chat search.

    Login Page

    hashtag
    Access Network Copilot

    Access the Network Copilot UI using the server IP address or FQDN over HTTPS:

    https://<host-ip-or-FQDN>

    hashtag
    Default Credentials

    Use the following credentials for the initial login:

    • Username: superadmin

    • Password: Admin@123

    Change the default password immediately after first login for security reasons.

    NCP Login page

    Admin Operations

    The Admin Operations section includes all administrative tasks available in the Network Copilot UI. These actions are accessible only to users with admin privileges and are used to manage system configuration, integrations, and user access.

    Available Admin Functions:

    1. Dashboard - View platform statistics (queries, data connectors, files, users, projects, chats).

    2. Data Connectors - Link, configure, remove connectors, and apply custom tags.

    3. Device Onboarding - Add devices using SNMP.

    4. File Management - Upload and delete files for analysis.

    5. LLM Management - Configure and manage additional LLM endpoints.

    6. User Management - Create and manage platform users.

    7. Roles & Permissions - Define roles and control user access.

    8. License Management - Activate or upgrade licenses.

    9. Preferences - Manage general settings, notifications, chat autocomplete, follow-up suggestions, company logo, and session timeout.

    10. Help & Support - Access support tools and resources.

    Navigate to each sub-section for detailed instructions on specific administrative tasks.

    User View and Admin View

    The Network Copilot UI supports two operating modes that can be toggled using the Admin View switch.

    hashtag
    User View

    User View is the default mode displayed after login. It provides access to standard user-level functionality, including:

    • Interacting with the Network Copilot chat interface

    • Creating and working with projects

    • Performing day-to-day operational tasks

    • Viewing uploaded files

    This mode is intended for regular users and does not expose administrative controls.

    hashtag
    Admin View

    circle-info

    The Admin View toggle is visible only to users with administrative privileges

    When switched to , additional administrative capabilities become available, including:

    • Adding and managing Data Connectors

    • Adding devices via SNMP

    • Uploading and managing files

    Changes made in Admin View impact system-wide behavior and access. Use administrative functions with caution.

    Dashboard

    The Dashboard provides a centralized view of Network Copilot platform activity and usage metrics. It helps administrators track system adoption, monitor operational trends, and understand overall platform utilization at a glance.

    The dashboard data can be filtered by time range (for example, Last week) to analyze usage trends over specific periods.

    hashtag
    Dashboard Metrics

    • Individual Queries - Total user queries executed during the selected time range.

    • Data Connectors - Number of active data connectors configured.

    • Files Uploaded - Total files uploaded for analysis.

    • Users - Total users configured in the system.

    • Projects - Number of projects created.

    • Chats - Total chat conversations generated.

    hashtag
    Time-based Filter

    Network Copilot provides time-based filtering to refine dashboard metrics within a specific time window.

    Users can select from predefined ranges or define a custom date range to narrow the scope of queries, chats, and activity data.

    hashtag
    Supported Time Ranges

    • Last week

    • Last month

    • Last 3 months

    • Custom (user-defined start and end dates)

    hashtag
    Custom Date Range

    When Custom is selected, users can specify explicit From and To dates to analyze activity over a precise period.

    hashtag
    Usage and Monitoring

    • Metrics are updated automatically based on system activity

    • Provides visibility into platform adoption and usage patterns

    • Helps administrators identify growth, usage spikes, or underutilized features

    hashtag
    Access

    The Dashboard is available in Admin View and is accessible only to users with administrative privileges.

    License Activation

    Before you can log in to the NCP UI, you must activate your license. Follow the steps below to get started:

    • Access the NCP-IP Interface

    • Open a browser and go to: https://<NCP-host-ip>

    • Activate the License:

      • Click on the "Activate License" option on the page.

      • Copy the Installation ID displayed.

    • Contact Aviz Support:

      • Send the Installation ID to and request a license key.

    • Apply the License Key:

    • You're All Set!

      Welcome to Aviz Network Copilot You can now log in to the NCP UI and talk to your network

      • Default Credentials:

        Username: superadmin

        Password:

    Using SNMP

    hashtag
    Use the following methods to add devices to the NCP UI

    • Via YAML Template

    hashtag
    Prerequisite for Non-SONiC Switches

    • SNMP should be enabled on the Switches with support for the following,

      • SNMP v2

      • SNMP Community string public RO (read-only)

    Data Connector

    Data Connectors allow NCP to integrate with external platforms and tools such as telemetry pipelines, observability platforms, ITSM systems, and cloud services.

    hashtag
    Step 1: Open the Data Connector Panel

    • Navigate to: Toggle Admin View → Data Connector

    • Click on the Add Connector button

    hashtag
    Step 2: Select a Connector

    • A list of supported connectors will be displayed, including:

      • AWS S3, Azure, Cloud Storage, ELK, Influx, IP Fabric, NetBox, Nexus Dashboard

      • ONES, ServiceNow, Slack, Snowflake, SolarWinds, Splunk, and more

    hashtag
    Step 3: Configure the Connection

    Fill in the following fields:

    • Name – Identifier for this connector instance

    • URI – Base API endpoint (e.g., https://10.30.0.254)

    • Authentication Method – Choose one:

    hashtag
    Step 4: Finalize

    • Click Connect

    • You’ll see the connector listed in the dashboard with a status (e.g.,Running)

    circle-info

    Successfully linked connectors can now be used in projects for data collection, analytics, and workflow automation

    hashtag
    See More:

    Notifications

    hashtag
    Notifications in Network Copilot

    Network Copilot generates system notifications to track key user actions, administrative changes, and system events. These notifications provide visibility into platform activity, supporting auditability and troubleshooting.

    Notifications are accessible from the Notifications (bell) icon in the top navigation bar.

    hashtag
    Notification Types

    Network Copilot supports the following notification categories:

    hashtag
    Chat Notifications

    Events related to user interactions within the NCP chat interface, including queries, responses, and chat activity.

    hashtag
    Data Connector Notifications

    Actions related to data connectors, such as:

    • Enabling or disabling connectors

    • Linking or unlinking integrations (Splunk, ELK, Nexus, ONES, etc.)

    hashtag
    Project Notifications

    Project-level changes, including:

    • Project creation

    • Project updates

    • Project deletion

    hashtag
    System Notifications

    General system events and platform-level updates.

    hashtag
    File Notifications

    File-related activities such as:

    • File uploads

    • File deletions

    • File modifications

    hashtag
    Audit and Traceability

    • All notifications are timestamped

    • Each event is attributed to the initiating user or service

    • Notifications provide a clear audit trail for operational and administrative actions

    Via CSV File

    Admins can onboard multiple devices using a structured CSV file.

    This method is efficient for bulk additions and is especially useful when device inventory is maintained in spreadsheet tools.

    circle-exclamation

    If you choose to upload CSV, the YAML Editor will be disabled permanently

    Step 1: Navigate to the Inventory Page

    • Go to: Toggle Admin View → Devices

    Step 2: Select 'Connect Device'

    • Click the Connect Device button in the top-right corner

    • From the dropdown, choose Use CSV

    • A prompt will confirm that once CSV mode is selected, YAML will be disabled for this session → Click Yes, Proceed

    Step 3: Upload the CSV File

    • Use the Select CSV file to upload option

    • (Optional) Click Download sample CSV to see the required format

    • Click Upload & Add

    Step 4: Confirm

    • A prompt will ask you to confirm the import → Click Yes to complete onboarding

    File Management

    The Files module in NCP allows users to upload and manage data files for analysis, ingestion, or reference within the platform.

    Uploaded files can be tagged and scoped for visibility across users or limited to specific roles.

    circle-info

    File processing may take up to 30 seconds. Max file size: 100MB.

    Step 1: Navigate to the Files Section

    • Go to: Toggle Admin View → Files

    • You will see a table listing previously uploaded files (if any), including metadata like source, access level, and timestamp.

    Step 2: Upload a File

    • Click the Upload File button at the top right

    • In the popup window:

      • Either drag and drop a file or click Browse to select one

    Step 3: Confirm Upload

    • Once uploaded, the file appears in the table with:

      • File name

      • Upload time

    Devices Onboarding

    Devices can be onboarded into the NCP Controller primarily via SNMP.

    To extend inventory capabilities, NCP integrates with external systems such as NetBox, Cisco Nexus Dashboard, Catalyst Center, and others. These integrations serve as inventory sources to populate and manage device data within the platform.

    hashtag
    Supported Onboarding Methods

    • SNMP (Native): Direct onboarding via SNMP is supported for any SNMP-capable device. You can add devices using YAML or CSV templates for bulk upload.

    • : Devices can also be imported indirectly through integration with:

      • Cisco Nexus Dashboard

      • Catalyst Center

    circle-info

    These connectors act as inventory sources; once linked, their device databases sync into the NCP system automatically.

    hashtag
    See More:

    NetBox
  • IP Fabric

  • ONES Controller (for SONiC devices)

  • Other supported platforms via API or sFlow

  • Data Connectors
    • via Data Connectors

    Third-party Controllers (via Data Connectors)
    Using SNMP
    Via YAML
    Via CSV

    Once you receive the license key from support:

    • Go back to the browser and go to: https://<NCP-host-ip>

    • Paste the license key in the license activation section.

    • Click Activate.

    Admin@123
    Aviz Support
    Managing LLMs
  • Managing users

  • Managing roles and permissions

  • Managing license

  • Editing system preferences

  • Admin View
    Click on the desired connector (e.g., Aviz ONES)
  • Click Proceed to Connect

  • Auth Token

  • Username & Password

  • User Credentials – Based on the auth method selected

  • Adding Tags
    Set File upload access (e.g., everyone or restricted)
  • Click Upload

  • Access level
  • Tags (if any)

  • Using API

    Platform: Palo Alto and Fortinet Firewall

    You can onboard multiple Palo Alto devices by listing them under inventory, just like in SNMP UI-based workflows. The type field ensures the platform is recognized correctly for telemetry collection.

    inventory:
      - ipAddress: 10.20.0.77
        user: admin
        password: PaloAlto
        type: paloalto-firewall
      - ipAddress: 10.20.0.62
        user: admin
        password: PaloAlto
        type: fortinet-firewall
    Sample configuration:
    • Arista - snmp-server community public ro

    • Cisco - snmp-server community public group network-operator

    • SONiC - sudo config snmp community add public RO

    • For Cumulus, edit the SNMP configuration file by running vi /etc/snmp/snmpd.conf and add the following line:

      • rocommunity public

      • agentaddress <self-mgmt-ip-here>@mgmt

    Via CSV File

    License Management

    The License section allows users to activate and manage their NCP license.

    Step 1: Open the License Page

    • Go to: Toggle Admin View → License

    • The current license type (e.g., Basic, Advanced, or Performance) is displayed along with support contact details.

    Step 2: Retrieve Your Installation ID

    • Your Installation ID is shown on the License page

    • Copy this ID - you’ll need it to request your activation key

    Step 3: Request an Activation Key

    • Send an email to sales@aviznetworks.com Include:

      • The Installation ID

      • The number of devices you plan to onboard with NCP

    Step 4: Enter Activation Key

    • Once you receive the key, paste it into the Activation Key field

    • Click Activate

    Step 5: Confirmation

    • Upon successful activation, you'll see a confirmation message and license summary

    • Click Log in to NCP to begin using the platform

    Help & Support

    The Help section provides centralized access to Aviz Networks support resources, product documentation, and the built-in API Explorer. It is designed to help users troubleshoot issues, understand platform features, and explore integration capabilities.

    hashtag
    Support

    The Support section provides direct access to Aviz Networks product support for Network Copilot.

    For comprehensive assistance, contact Aviz Networks support via email.

    hashtag
    Documentation

    The Documentation tab provides access to the Network Copilot User Guide in a PDF, viewable directly within the UI. It serves as the primary reference for understanding platform capabilities, features, and workflows.

    hashtag
    API Explorer

    The API Explorer tab offers an interactive view of Network Copilot’s REST APIs.

    Browse available endpoints by category (for example, Conversation, KnowledgeBase, and others)

    LLM Management

    The LLM Management section allows administrators to configure, manage, and monitor Large Language Models used by Network Copilot for query processing and response generation.

    This section is accessible only in Admin View.

    hashtag
    LLM Overview

    The LLM list displays all configured models with the following details:

    • LLM Name - Identifier for the configured model

    • Description - Model purpose or usage context

    • Status - Current state (for example, active)

    Administrators can search existing LLMs using the Search LLMs field at the top.

    hashtag
    Add / Configure LLM

    To add a new LLM endpoint:

    1. Click Configure LLM

    2. Provide the following details:

      • Name - Logical name for the LLM

    Once connected, the LLM becomes available for use within the platform.

    Notes

    • One LLM can be configured as the default system LLM.

    • Additional validated LLMs can be selected at the project level during project creation.

    Via YAML Template

    This method allows admins to onboard devices into the NCP Controller using a pre-defined YAML structure, Ideal for bulk inventory uploads.

    Step 1: Navigate to the Devices Page

    • Go to: Toggle Admin View → Devices

    Step 2: Select 'Connect Device'

    • Click the Connect Device button on the top-right

    • From the dropdown, select Use YAML

    Step 3: Upload or Edit YAML

    • Either:

      • Drag-and-drop your YAML file

      • Or use the built-in YAML editor to manually define devices

    Step 4: Save & Apply

    • Once your YAML is ready, click Save & Apply

    • A confirmation appears, and your devices will be added to the inventory

    User Operations

    This section covers all standard user-level tasks within the Network Copilot platform. Unlike Admin Operations, these features are available to all authenticated users and focus on day-to-day interaction with the system.

    Key User Functions:

    1. New Chat - Start and interact with the NCP chat interface to query data and receive insights.

    2. Projects - Organize related queries, data connectors, and files within a single workspace.

    3. Use Cases - Use predefined templates or workflows tailored to specific operational needs.

    4. Help - Access documentation and support resources.

    5. Chat History - View and search previous queries and responses.

    6. Settings - Manage user-specific preferences, credentials, and options.

      1. Files - View files uploaded by administrators and available to the user.

      2. Archive - View archived chat conversations.

    Roles & Permissions

    The Roles & Permissions section allows administrators to define and manage access control within the Network Copilot platform. Roles determine which features and actions are available to users across the system.

    This section is accessible only in Admin View.

    hashtag
    Default Roles

    Network Copilot includes predefined roles with progressively increasing privileges:

    • Basic User - Limited access to core features such as chat and file viewing.

    • Advanced User - Access to devices, data connectors, and files.

    • Power User - Full access, including LLMs, custom agents, and agent submission.

    These roles provide a quick way to assign standard permission sets.

    hashtag
    Permission Categories

    Permissions can be managed across the following feature areas:

    • Devices

    • Data Connectors

    • Files

    Each permission can be enabled or restricted per role.

    hashtag
    Create a Custom Role

    Administrators can define custom roles to meet specific access requirements.

    To create a role:

    1. Navigate to Admin View → Roles & Permissions

    2. Click Add Role

    3. Provide:

    Notes

    • Administrators can restrict users to specific devices, data connectors, LLMs, files, or custom agents.

    • Role changes take effect immediately for assigned users.

    • Permissions control both UI visibility and action-level access.

    And restart the SNMPD services
    • service snmpd restart

    Notifications - Configure user notification preferences.
    LLMs
  • Custom Agents

  • Submit Agents

  • Role Name
  • Description

  • Configure permissions for each category:

    • Devices

    • Data Connectors

    • Files

    • LLMs

    • Custom Agents

    • Submit Agents

  • Click Create Role to save the configuration.

  • Last Synced - Most recent synchronization time
  • Connected - Timestamp indicating successful connectivity

  • Description - Optional description
  • URL - Endpoint URL for the LLM service

  • Auth Token - Authentication token for secure access

  • Click Connect to validate and register the LLM

  • Help

    The Help section accessible from the user view is the same as the one shown in the admin view.

    inventory:
      - ipAddress: 10.20.11.15
        user: admin
        password: Aviz@123
      - ipAddress: 10.20.11.16
        user: admin
        password: Aviz@123
      - ipAddress: 10.20.11.17
        user: admin
        password: Aviz@123
      - ipAddress: 10.20.11.18
        user: admin
        password: Aviz@123
      - ipAddress: 10.20.11.19
        user: admin
        password: Aviz@123      

    User Management

    Administrators can create new users from the Users section of the Network Copilot UI. This action is available only to users with admin privileges.

    hashtag
    Steps to Create a User

    1. Enable Admin View and navigate to Users.

    2. Click Add User (top-right)

    3. Enter the required user details:

      • Username - Unique login identifier

      • First Name/Last Name - User’s personal details

    4. (Optional) Upload a profile picture.

    5. Click Save Changes to create the user.

    Creating Projects

    Projects in NCP allow you to group users, queries, and data connectors under a shared workspace for collaboration and context retention.

    hashtag
    Steps to Create a Project

    1. Create Project Navigate to Projects and click on “Project +.”

    2. Enter Project Details Give the project a name and a description.

    3. Invite People (Optional) Add team members by username to collaborate within the project chat.

    4. Upload Files (Optional) Drag and drop files or click to browse and attach supporting documentation for the project.

    5. Enable/Disable Data Connectors Click the “Data Connectors” button to manage which connectors and tags are active for this project. This ensures queries are contextually scoped.

    6. Start Chatting Click Start Chatting to create the project and launch directly into the dedicated chat space.

    7. Stay on Project Chat Once created, all interactions, queries, and results will persist under the project chat view for future reference.

    Starting a New Chat

    The New Chat feature allows users to interact with the NCP assistant for querying network data, retrieving reports, or analyzing device behavior across projects and data sources.

    hashtag
    Start a New Chat

    • The New Chat page is the default landing screen after login.

    • Enter your query in natural language to begin interacting with the NCP assistant immediately, with no additional navigation required.

    hashtag
    Mentions

    Mentions allow users to control collaboration and data scope within a conversation.

    • User Mentions (@username)

      • Mention another user to collaborate or draw attention.

      • This does not trigger the AI assistant.

    hashtag
    User Chat Options

    Use User Chat to view your personal chat history within Network Copilot.

    This includes:

    • Previous queries

    • Support interactions

    • Insights from earlier sessions

    Chat history helps maintain continuity and revisit earlier findings.

    Available chat management actions:

    • Pin Chat - Keep important conversations at the top

    • Download Chat - Export the full conversation for offline reference or documentation

    • Archive Chat - Remove chats from the main view without deleting data

    hashtag
    Advanced Chat Operations (Optional)

    Each chat or message supports additional actions for workflow control and feedback:

    • Copy - Copy a message for reuse or sharing

    • Good/Bad Response - Provide feedback on assistant responses

    • Delete Chat - Remove specific messages or entire chat threads

    These actions are available via the contextual icons or the three-dot menu.

    Preferences

    The Preferences section allows administrators to configure system-wide behavior and user experience settings for the Network Copilot platform. These settings apply globally and are accessible only in Admin View.

    hashtag
    General Preferences

    General preferences control branding, authentication behavior, and session management.

    • Company Name - Display name shown across the UI

    • Company Logo - Upload a custom logo (maximum file size: 5 MB)

    • User Session Timeout - Define inactivity timeout for standard users

    • Admin Session Timeout - Define inactivity timeout for admin users

    • Archive Chats After - Automatically archive chat conversations after the selected duration

    • Authentication Type - Select authentication method (for example, Local Authentication or LDAP)

    • Suggestions

      • Enable or disable Autocomplete for chat prompts

      • Enable or disable Follow-up Suggestions in the chat interface

    • Sign Out Everywhere - Force sign-out across all active sessions except the current one

    hashtag
    Notification Preferences

    Notification preferences apply only to the currently logged-in user and control which events generate personal notifications.

    • Chat Mentions - Receive notifications when you are mentioned in a chat

    • Project Membership - Receive notifications when you are added to a project

    Users can opt in or out of these notifications based on their individual preferences.

    Settings

    The Settings panel in the user view is read-only and provides a snapshot of the user’s environment.

    No changes can be made from this view. Any updates or configuration changes must be performed by an administrator if required.

    The Settings panel includes:

    • Files Displays files uploaded to the platform (for example, .log, .csv, .pcap), along with upload timestamps and tags for easy filtering and reference.

    • Archive Lists archived chats and projects. Archived items are retained for reference and can be accessed at any time. They are not permanently deleted.

    • Notifications Provides visibility into notification-related settings and preferences applicable to the user.

    • Sign Out Signs the user out of all active sessions across devices, except for the current session.

    Chat History

    The Chat History view shows a timeline of your past conversations within NCP.

    • Resume Context: Revisit prior queries without repeating inputs

    • Browse Interactions: Scroll through past chats to locate insights or responses

    • Manage Chats:

      • Pin/Unpin: Highlight important chats for easy access

      • Download: Export the conversation as a file

      • Archive: Clean up your view without deleting permanently

    Curated Use-cases

    Curated use-cases provide predefined, guided chat scenarios for common network operations and troubleshooting workflows. They are designed to simplify day-to-day tasks, accelerate issue resolution, and deliver actionable insights across your network.

    circle-info

    NCP supports a wide range of use cases. However, your access to specific use-cases may vary based on your current license tier. If you see a use-case that's not available to you, you can request access through your administrator

    hashtag
    Available Use-Cases

    hashtag
    Basic NetOps

    Perform day-to-day operational checks and health validation across the network.

    • Inspect device and interface details

    • Monitor recent reboots, link-down events, and configuration changes

    • Track recent software upgrades and validate upgrade status

    hashtag
    Flow Analytics

    Analyze and visualize network traffic to understand usage patterns and detect anomalies.

    • Identify peak traffic periods and top talkers

    • Analyze application and protocol distribution

    • Track traffic trends using historical and real-time data

    hashtag
    Inventory Insights

    Quickly answer inventory-related questions across your infrastructure.

    • List all devices and their roles

    • View vendor, model, and OS versions

    • Analyze hardware types and CPU/memory distribution

    hashtag
    Knowledge Base

    Query internal and external knowledge sources to support operations and planning.

    • Retrieve playbooks, SOPs, and onboarding guides

    • Track known issues, advisories, and lifecycle milestones

    • Identify applicable CVEs and vendor notifications

    hashtag
    Security Audit

    Perform security and compliance checks across the network.

    • Validate access controls and authentication settings

    • Detect policy violations and misconfigurations

    • Identify outdated firmware, expired certificates, or rogue devices

    hashtag
    Upgrade Compliance

    Monitor and validate software upgrade progress across devices.

    • Track OS upgrade history

    • Identify non-compliant devices

    • Compare pre- and post-upgrade states

    • Generate compliance and audit reports

    Data Connectors

    Network Copilot supports a wide range of integrations to ingest, enrich, and analyze data across platforms - enabling contextual insights and automated operations.

    circle-exclamation

    You must be an admin to set up data connectors

    hashtag
    Supported Operations

    Each connector entry supports the following actions via the menu on the right:

    • Edit - Update tags and descriptions

    • Deactivate - Temporarily disable the connector

    • Remove - Permanently delete the connector

    You can also search and sort connectors using the UI controls

    hashtag
    The following are the supported connectors:

    hashtag

    • (Open Networking Enterprise Suite)

    hashtag
    Identity & Access Management

    hashtag

    • Amazon S3

    • Azure Blob Storage

    • Google Cloud Storage

    hashtag

    • ELK Stack

    • Splunk

    • Loki (supports syslog only)

    • InfluxDB

    hashtag

    • Snowflake

    hashtag

    • Cisco Nexus Dashboard

    • Cisco Catalyst Center

    • SolarWinds

    • IP Fabric

    hashtag

    • Slack

    • Rocket Chat

    • Zendesk

    • ServiceNow

    Analyze hardware and OS distribution using visual summaries
  • Review CPU and memory utilization for targeted devices

  • Identify free and available ports across the network

  • Optimize capacity and performance
    Supports both real-time data and offline uploads (Excel / CSV / JSON)
    Generate audit reports for compliance reviews
    (supports flow logs only)

    NetBox

  • NetQ

  • Aviz Native
    Aviz ONESarrow-up-right
    Active Directory
    Cloud & Storage
    Log & Metrics Ingestion
    Data Warehousing & Analytics
    Observability & Infrastructure
    Collaboration & ITSM
    Password/Confirm Password - Set a secure password
  • Title (optional) - For example, Network Admin or SRE

  • Email - Used for communication and account recovery

  • Role - Select from available roles (Basic, Advanced, Power)

  • Use for direct communication with team members inside a project.

  • Data Connector Mentions (!Connector)

    • Mention a specific data connector (for example, !Splunk, !NetFlow, !SNMP).

    • Scopes the AI query to the selected data source, ensuring targeted, relevant results.

  • Cloud & Storage

    This section provides setup guides for connecting cloud object storage platforms with Network Copilot (NCP). These connectors enable indexing, querying, and insight generation from your cloud-hosted datasets.

    Supported integrations:

    • Google Cloud Storage - Connect GCS buckets for logs, metrics, and other structured data.

    • Amazon Web Services (AWS) S3 - Ingest data directly from AWS S3 buckets.

    • - Integrate with Azure containers to access storage blobs for analysis.

    Each guide includes:

    • Supported authentication methods

    • Required input parameters

    • Step-by-step configuration via the NCP GUI

    Log & Metrics Ingestion

    This section covers integrations that allow NCP to collect, normalize, and analyze telemetry from various logging and metrics platforms.

    Supported integrations:

    • Loki - Centralized log aggregation for Prometheus-native environments.

    • InfluxDB - Time-series data ingestion for network performance and telemetry.

    • - Elasticsearch-based log indexing and search.

    • - Enterprise-grade ingestion and correlation of event logs and metrics.

    Each guide walks you through:

    • Required connection parameters (tokens, URLs, ports)

    • Authentication methods supported

    • GUI-based configuration in the NCP console

    Identity & Access Management

    Windows Active Directory (AD) Data Connector

    The Windows Active Directory (AD) data connector integrates Network Copilot with your enterprise directory service using LDAP, enabling centralized authentication and user identity management with existing AD credentials.

    This integration allows organizations to authenticate users through Active Directory, removing the need to manage local user accounts within Network Copilot.

    hashtag
    Steps to Add Windows AD as a Data Connector

    1. Open Data Connectors

      • Toggle Admin View

      • Navigate to Data Connectors

      • Click Add Connector (top-right)

    2. Select Active Directory

      • From the connector list, select Active Directory (AD)

    3. Configure AD Connection In the Connect Active Directory form, provide:

      • Connector Name - Logical name for the AD integration

      • Description - Description for identification

    4. Connect

      • Click Connect to validate credentials and establish the connection

    Google Cloud Storage

    Google Cloud Storage (GCS) integration allows Network Copilot to ingest syslog and flow log data from cloud buckets for deeper analysis and context-aware automation.

    circle-info

    This connector requires a valid GCS bucket and service account.

    hashtag
    Steps to Add Google Cloud Storage as a Connector

    1. Click Add Connector in the Data Connectors page

    2. Select Google Cloud Storage from the list

    3. In the Connect Google Cloud Storage form:

    Once successful, the connector will appear in the list with a Running status.

    Aviz ONES

    The Aviz ONES data connector integrates the Aviz ONES controllerarrow-up-right with Network Copilot, enabling streamlined ingestion of inventory, topology, and telemetry data.

    hashtag
    Steps to Add Aviz ONES as a Data Connector

    1. Click Add Connector from the top-right of the Data Connectors screen

    2. From the list, select ONES

    3. In the Connect Aviz ONES form:

      • Enter the connector name and ONES URI

      • Select the authentication method: Auth Token or Username & Password

    Once connected, the connector status will appear as Running

    Amazon Web Services S3

    Overview

    This section walks you through connecting AWS S3 as a data source in Network Copilot.

    By enabling this connector, NCP can:

    • Retrieve syslogs and flow logs from an S3 bucket.

    • Index and structure logs for efficient search, filtering, and correlation.

    • Enrich dashboard widgets and Copilot’s chat interface with cloud telemetry.

    hashtag
    Connect AWS S3 as a Data Source in NCP

    To connect AWS S3 to NCP:

    1. Log in to the NCP UI

    2. Go to Settings → Data Connectors and click Add Connector

    3. From the list, select AWS S3

    Once the connector is added, its status will show as Running, and it will sync data at regular intervals.

    Azure Blob Storage
    ELK Stack
    Splunk

    Data Warehousing & Analytics

    This section provides configuration guidance for integrating NCP with data warehouse platforms to enable scalable analytics, long-term retention, and cross-domain data joins.

    Supported integrations:

    • Snowflake - Cloud-native analytics engine for high-performance querying and multi-source aggregation.

    Each integration guide includes:

    • Required credentials and connection parameters

    • Supported authentication modes

    • Example use cases like correlation, reporting, and advanced analytics

    Directory Server URL/IP - Active Directory domain controller address
  • Port - LDAP port

  • Base Directory Root - Base DN for directory searches

  • Username - LDAP bind user or service account

  • Password - Password for the bind account

  • Organizational Unit (OU) - Scope user searches to a specific OU

  • Enter a Name for the connector

  • Provide the Bucket Name

  • Upload the Service Account Key (.json)

  • Click Connect to complete the setup

  • Provide credentials and click Connect

    Fill in the fields:

    • Name - A friendly label for this connector

    • S3 Bucket - The name of your AWS S3 bucket

    • AWS Access Key - IAM access key ID with read permissions

    • AWS Secret Key - IAM secret key for authentication

  • Click Connect to complete the setup

  • Azure

    hashtag
    Overview

    This section guides you through connecting Azure Blob Storage as a data source in Network Copilot.

    hashtag
    By integrating this connector, NCP can:

    • Index and standardize Azure-hosted datasets for daily ops and analysis.

    • Enable natural language querying over telemetry via Copilot’s chat interface.

    • Enhance visibility across hybrid and cloud-stored data.

    hashtag
    Connect Azure Blob as a Data Source in NCP

    To add Azure Blob to NCP:

    1. Log in to the NCP GUI

    2. Navigate to Settings → Data Connectors, then click Add Connector

    3. Select Azure from the list of available connectors

    Once connected, the Azure Blob status will reflect Running, and you’ll see synchronization timestamps

    InfluxDB

    hashtag
    Overview

    This section guides you through configuring and running the integration between InfluxDB and NCP.

    hashtag
    By following these steps, you'll enable NCP to:

    • Connect to a time-series database hosted in InfluxDB

    • Retrieve telemetry and performance metrics for indexing

    • Allow users to query historical trends and real-time metrics via NCP’s chat interface

    circle-exclamation

    NCP–InfluxDB integration is limited to flow log input only at this time

    hashtag
    Prerequisites

    Ensure the following components are ready before beginning the integration:

    • InfluxDB Instance: A running and accessible InfluxDB instance (e.g., https://influxdb.example.com)

    • Database and Bucket Information: The name of the InfluxDB bucket or database that stores your telemetry data

    • Access Token or API Credentials: A valid read-only token or user credentials with access to query relevant data

    hashtag
    Configure InfluxDB as a Data Source in NCP

    To integrate InfluxDB with NCP:

    1. Log in to the NCP GUI

    2. Navigate to Settings → Data Connectors, then click Add Connector

    3. Select InfluxDB from the list of available connectors

    Cisco Nexus Dashboard

    hashtag
    Overview

    This section guides you through configuring and running the integration between the Cisco Nexus Dashboard and NCP

    hashtag
    By following these steps, you'll enable NCP to:

    • Retrieve and index infrastructure data from Nexus Dashboard.

    • Make network state and topology information queryable via NCP’s chat interface.

    • Enhance operational visibility and streamline troubleshooting through AI-powered interactions.

    hashtag
    Prerequisites

    Before proceeding, ensure the following:

    • Nexus Dashboard Instance: Accessible via HTTPS (e.g., https://nexus-dashboard.example.com)

    • API Credentials: A valid authentication token or admin user credentials with API access to the Nexus Dashboard

    hashtag
    Configure Nexus Dashboard as a Data Source in NCP

    To integrate Nexus Dashboard with NCP:

    1. Log in to the NCP GUI

    2. Navigate to Admin View → Data Connectors, then click Add Connector

    3. Select Nexus Dashboard from the list of available connectors

    ELK Stack

    hashtag
    Overview

    This section guides you through configuring and running the integration between the ELK Stack and NCP

    hashtag
    By following these steps, you'll enable NCP to:

    • Pull and index logs from Elasticsearch for real-time visibility.

    • Allow users to query logs and telemetry data using NCP’s chat interface.

    • Improve troubleshooting efficiency and accelerate root cause analysis.

    hashtag
    Prerequisites

    Before you begin, ensure the following:

    • Elasticsearch Endpoint: URL of your Elasticsearch instance (e.g., https://elk.example.com:9200)

    • Index Information: The names of the indices that contain relevant network logs (e.g., network-logs-*, telemetry-*)

    hashtag
    Configure ELK as a Data Source in NCP

    To integrate your ELK Stack with NCP:

    1. Log in to the NCP GUI

    2. Navigate to Settings → Data Connectors, then click Add Connector

    3. Select ELK from the list of available connectors

    Loki

    hashtag
    Overview

    This section guides you through configuring and running the integration between Grafana Loki and NCP.

    hashtag
    By following these steps, you'll enable NCP to:

    • Connect to your Loki instance and ingest structured syslog streams

    • Parsing and index logs for efficient retrieval and context-aware insights

    • Allow users to query logs using natural language through NCP’s chat interface

    circle-exclamation

    NCP–Loki integration is limited to syslog input only at this time

    hashtag
    Prerequisites

    Before beginning, make sure you have:

    • Loki Endpoint URL: Example: http://loki.example.com:3100

    • LogQL Query: Used to filter logs from specific sources (e.g., {job="network-agent"})

    • Log Limit: Maximum number of log lines to fetch per query (e.g., 100

    hashtag
    Connect Grafana Loki as a Data Source in NCP

    To connect NCP with your Loki instance:

    1. Log in to the NCP GUI

    2. Navigate to Settings → Data Connectors, then click Add Connector

    3. Select Loki from the list of available connectors

    Splunk

    hashtag
    Overview

    This section guides you through configuring and running the integration between Splunk and NCP.

    hashtag
    By following these steps, you'll enable NCP to:

    • Connect to your Splunk instance and pull structured logs.

    • Parsing and index logs for efficient search and correlation.

    • Allow users to query logs using natural language in the NCP chat interface.

    hashtag
    Prerequisites

    Before beginning, make sure you have:

    • Splunk Endpoint URL: Example: https://splunk.example.com:8089

    • Splunk Query: Used to filter logs from specific sources (e.g., index="network" sourcetype="syslog")

    hashtag
    Configure Splunk as a Data Source in NCP

    To connect NCP with your Splunk instance, follow these steps:

    1. Log in to the NCP GUI

    2. Navigate to Settings → Data Connectors, then click Add Connector

    3. Select Splunk from the list of available connectors

    Snowflake

    hashtag
    Overview

    This section guides you through configuring and running the integration between Snowflake and NCP.

    hashtag
    By following these steps, you'll enable NCP to:

    • Fetch and index time-series data, application flows, and syslogs for analysis

    • Enable natural language queries via NCP’s chat interface for troubleshooting, monitoring, and anomaly detection

    • Improve operational visibility and enable real-time, data-driven decisions

    hashtag
    Prerequisites

    Before you begin, ensure you have the following:

    • Snowflake Account Details

      • Snowflake URL (e.g., xyz.snowflakecomputing.com)

      • Account Name (e.g., xyz)

    hashtag
    Configure Snowflake as a Data Source in NCP

    To connect NCP with your Snowflake instance, follow these steps:

    1. Log in to the NCP GUI

    2. Navigate to Admin View → Data Connectors, then click Add Connector

    3. Select Snowflake from the list of available connectors

    NetBox

    hashtag
    Overview

    This section guides you through configuring and running the integration between NetBox and NCP

    hashtag
    By following these steps, you'll enable NCP to:

    • Synchronize device inventories from NetBox.

    • Index and standardize device data for quick access.

    • Empower customers to ask questions and retrieve detailed device information through NCP’s chat interface.

    hashtag
    Prerequisites:

    • NetBox Server: Running at https://netbox.example.com

    • Authentication Token: Obtain an API token from your NetBox admin panel

    hashtag
    Configure NetBox as a Data Source in NCP:

    To connect NCP with your NetBox instance, follow these steps:

    1. Log in to the NCP GUI

    2. Navigate to Admin View → Data Connectors, then click Add Connector

    3. Select NetBox from the list of available connectors

    Observability & Infrastructure

    This section enables integration with external platforms that monitor infrastructure health, visualize network topology, and centralize device configuration data. These integrations extend Network Copilot’s situational awareness by enriching queries with real-time and authoritative infrastructure context.

    hashtag
    Supported Integrations

    • NetBox - Source of truth for network infrastructure, including IPAM and DCIM data

    • Cisco Nexus Dashboard - Fabric management, analytics, and operational visibility

    • SolarWinds - Network performance monitoring and fault detection

    • IP Fabric - Automated network assurance and intent verification

    • Cisco Catalyst Center - Policy-based SD-Access controller and telemetry source

    • NetQ - Fabric-level telemetry, state validation, and network health insights

    Fill in the required fields:

    • Name - A display label for this connector

    • Azure Connection String - The full blob storage access string

    • Azure Container - The specific container name holding logs or data blobs

  • Click Connect to complete the setup

  • Enable proactive insights and troubleshooting based on time-series data

    Fill in the required fields:

    • Name: A friendly name for your InfluxDB instance

    • InfluxDB URL: The base URL (e.g., https://influxdb.example.com)

    • InfluxDB Port: The port number used by your InfluxDB instance (default: 8086)

    • Auth Method: Use Username/Password to connect your instance

    • Bucket/Database Name: The target bucket or database to query

  • Click Save to complete the configuration

  • Provide the required details:

    • Name: A friendly name for this Nexus Dashboard instance

    • Nexus URI: URL of the Nexus Dashboard (e.g., https://nexus-dashboard.example.com)

    • Authentication Method: Select between Auth Token or Username/Password

      • If using Auth Token, paste the token obtained from Nexus Dashboard

      • If using Username/Password, enter admin credentials with API access

  • Click Save to complete the integration

  • Enter the following details:

    • Name: A friendly name for your ELK data source

    • Elasticsearch URI: Base URL of your Elasticsearch instance (e.g., https://elk.example.com:9200)

    • Index Patterns: Specify the indices or wildcard patterns to fetch logs from

  • Click Save to complete the configuration

  • Enhance observability and streamline troubleshooting using real-time log analytics
    ,
    500
    )

    Fill in the required fields:

    • Name: A label for the Loki configuration (e.g., Loki-Cluster)

    • Host: The full URL of your Loki endpoint (e.g., https://loki.example.com)

    • Query: A LogQL query string (e.g., {job="network-logs"})

    • LogLimit: The maximum number of logs to retrieve per query (e.g., 200)

  • Click Save to complete the setup

  • Enhance troubleshooting workflows and observability through log-driven insights.

    Enter the following details:

    1. Name: A label for the Splunk configuration (e.g., Splunk-Cluster)

    2. Host: The full URL of your Splunk endpoint (e.g., http://splunk.example.com:8089)

    3. Username: Your Splunk username (e.g., admin, user123)

    4. Password: The password associated with the Splunk username (e.g., your_password_here)

    5. Index: The index in Splunk where the logs are stored (e.g., network, syslog)

  • Click Save

  • Warehouse, Database, and Schema names for query execution

  • Snowflake Credentials

    • User credentials (username/password or other authentication methods such as OAuth)

  • Enter the following details:

    • Name: A label for the Snowflake configuration (e.g., Snowflake-Prod-Cluster)

    • Account URL: Your Snowflake account URL

    • Username: Your Snowflake user

    • Password: Corresponding password

    • Warehouse: Compute the warehouse to use

    • Database: The target database

    • Table: Name of the table you wish to query

    • Schema: The Snowflake schema where your tables or logs reside

  • Click Save

  • Streamline network operations and improve overall network visibility.

    Fill in the required fields:

    • Name: A friendly name for this NetBox instance

    • NetBox URI: The base URL of your NetBox instance (e.g., https://netbox.example.com/)

    • Authentication Method: Choose Auth Token or Username/Password based on your setup

      • If using an Auth Token, enter the token here

      • If using a Username/Password, provide valid credentials with API access

  • Click Save to complete the configuration

  • SolarWinds

    hashtag
    Overview

    This section outlines how to integrate SolarWinds as a data connector in Network Copilot.

    By enabling this integration, NCP can:

    • Ingest metrics and alerts from your SolarWinds environment.

    • Enrich network telemetry insights with infrastructure health and topology data.

    • Support contextual queries and visualizations in Copilot’s interface.

    hashtag
    Connect SolarWinds as a Data Source in NCP

    To configure the SolarWinds connector:

    1. Log in to the NCP GUI

    2. Navigate to Admin View → Data Connectors, then click Add Connector

    3. Select Nexus Dashboard from the list of available connectors

    Once connected, the connector will show as Running, and the sync timestamps will be displayed.

    Collaboration & ITSM

    This section allows you to connect NCP with ticketing systems and real-time collaboration tools. These integrations help streamline incident response, automate workflows, and enable faster cross-team coordination.

    Supported integrations:

    • Slack - Send alerts, trigger workflows, and collaborate directly from Network Copilot events

    • Zendesk - Automatically create and sync support tickets with network issues

    • - Integrate with CMDB, incident, and change management modules

    Each connector setup includes:

    • Authentication and token handling

    • Required fields (e.g., subdomain, user)

    • Step-by-step screenshots for configuration

    Slack

    This guide provides step-by-step instructions for creating a Slack bot that allows you to talk to your Network Copilot from Slack. The bot can respond to queries about generating Compliance reports, Audit reports, and general chat about your network.

    Enhance efficiency and streamline communication within your Slack channels.

    hashtag
    Procedure:

    hashtag
    Setting up the Slack Bot

    1. Create a Slack APP

      • Visit and log in with your organization ID

      • Click on "Create New App" and choose "From Scratch"

    hashtag
    Add the OAuth Slack token to NCP

    1. Obtain the OAuth token from Slack

      • Navigate to Slack API -> Your APPs -> Select the NCP-App -> Features -> OAuth & Permissions -> Bot User OAuth Token

      • In the features section, select 'Bot User OAuth Token'

    hashtag
    Add the NCP-bot to your Workspace

    1. Adding the NCP-Bot

      • Go to the settings of the desired channel or group

      • Navigate to Integrations → Apps -> Add an App

    Cisco Catalyst Center

    hashtag
    Overview

    This section guides you through connecting Cisco Catalyst Center as a data source in Network Copilot.

    With this integration, you can:

    • Leverage Catalyst's real-time network telemetry and topology insights

    • Correlate infrastructure events and device data with NCP’s AI-driven analytics

    • Power contextual queries with inventory and assurance data

    hashtag
    Connect Cisco Catalyst Center as a Data Source in NCP

    To integrate Catalyst Center with NCP:

    1. Log in to the NCP GUI

    2. Go to Admin View → Data Connectors, then click Add Connector

    3. Select Catalyst Center from the list

    The connector will appear with status indicators and last sync time.

    IP Fabric

    hashtag
    Overview

    This section explains how to configure IP Fabric as a data source in Network Copilot

    Integrating IP Fabric enables NCP to:

    • Collect network snapshots and topology data

    • Enhance path insights and historical network context

    • Support intent-based query results using IP Fabric’s dataset

    hashtag
    Connect IP Fabric as a Data Source in NCP

    To set up the IP Fabric connector:

    1. Log in to the NCP GUI

    2. Navigate to Admin View → Data Connectors, then click Add Connector

    3. Select IP Fabric from the list of available connectors

    Once added, the connector will be marked as Running, and you can view the sync status.

    ServiceNow

    Flow Analytics

    Understanding how traffic moves through your network is essential for performance optimization, capacity planning, and anomaly detection. NCP provides powerful flow visibility by analyzing traffic patterns in real time and over historical windows.

    With Flow Analytics, you can:

    • What is the peak traffic hour in the last 24 hours?

    • Show total traffic volume per hour over the last 24 hours

    • What are the top talkers in my network?

    • Show average daily traffic volume over the past week

    • Which source and destination IPs generate the most traffic in my network?

    • Can you show me the traffic distribution by protocol?

    • Calculate how many packets were transferred per protocol

    • list the source and destination IPs of the ICMP traffic?

    • what are the destination ports of the TCP traffic?

    • which destination address has more amount of traffic in my network and what is the traffic value?

    • How many flows in my network and what is the total byte in Mbps?

    • which source IP has more number of flows in my network?

    • Count the number of flows per hour for today

    • List the top interfaces used based on total bytes transferred in last 24 hours

    NCP gives your network team the clarity to spot usage trends, detect anomalies, and make data-driven decisions—all without complex tooling or scripts.

    Provide the following details:

    • Name – A user-friendly label for the integration.

    • SolarWinds URI – The HTTP endpoint of your SolarWinds server (e.g., http://<ip>:8787/).

    • Authentication Method:

      • Auth Token or

      • Username & Password (credentials with API access)

  • Click Connect to finish.

  • Name your app and select the target workspace from the dropdown menu

  • Click on "Create App"

  • Setup permissions

    • In the left navigation bar, go to Features → OAuth & Permissions → Bot Token Scopes

    • Click on "Add an OAuth Scope"

    • Add the following permissions: chat:write, app_mentions:read, files:write, incoming-webhook, users:read

  • Configure Event Subscriptions

    • Go to Features → Event Subscriptions and enable the feature

    • Enter your API endpoint URL (ex. -> https://<server-public-ip>:9001/api/v1/slack-events/questions)

    • Scroll down and subscribe to the following bot events: app_mentions:read

    • Click Save Changes

  • Install the APP

    • Go back to OAuth & Permissions and click Install App to Workspace

    • Select the Channel for NCP-bot to post on

    • Click on Allow

  • and copy the token
  • Configure the NCP with the Slack token

    • Login to the NCP GUI

    • Go to Admin View → Data Connectors → Add Connector

    • Click on Add Channel

    • Enter the 'Channel Name' and the 'Bot User OAuth Token'

    • Click Save

  • Select your app from the dropdown menu

  • Interacting with the NCP-Bot

    • Begin a conversation with the bot by typing @your_bot_name followed by your query

  • Setup a Slack bot for NCP
    Add the OAuth Slack token to NCP
    Add the NCP-bot to your workspace
    Slack APIarrow-up-right
    Audit Report through Slack
    Audit Report through Slack
    Audit Report through Slack
    General Chat through NCP

    Enter the connection details:

    • Name – A descriptive label (e.g., Cisco Catalyst).

    • Catalyst URI – The base URL or IP of your Cisco Catalyst instance (e.g., https://10.20.0.199/)

    • Authentication Method – Choose either:

      • Auth Token

      • Username & Password: Provide credentials with API access

  • Click Connect to complete the setup

  • Enter the following:

    • Name – A friendly label for this connector (e.g., ip-fabric)

    • IPF Host – The full URL to your IP Fabric instance (e.g., https://demo1.eu.ipfabric.io/)

    • IPF Token – A valid API token with access to fetch snapshots and network data

  • Click Connect to establish the integration

  • NetQ

    The NetQ data connector integrates Network Copilot with NetQ, enabling ingestion of fabric-level telemetry, state validation, and network health data.

    This allows Network Copilot to correlate fabric events and operational state with AI-driven analytics, supporting contextual queries and accelerated troubleshooting across the network.

    hashtag
    Steps to Add NetQ as a Data Connector

    1. Open Data Connectors

      • Toggle Admin View

      • Navigate to Data Connectors

      • Click Add Connector (top-right)

    2. Select NetQ

      • From the connector list, select NetQ

    3. Configure NetQ Connection

      In the Connect NetQ form, provide the following details:

      • Connector Name - Logical name for the NetQ integration

      • Description - Optional description for identification

    4. Connect

      • Click Connect to validate credentials and establish the connection

    Basic NetOps

    Network Operations (NetOps) aims to automate and streamline daily tasks, improve operational efficiency, and reduce the risk of human error. With NCP, you get actionable insights, real-time performance metrics, and the ability to generate visual reports to assist with decision-making and monitoring.

    hashtag
    NetOps Capabilities Include:

    • Can you list down all the interface details for device IP = x.x.x.x?

    • Is there any device which got upgraded in the last 24 hours?

    • Can you provide a pie chart of my network based on HWSKU?

    • Can you provide a pie chart of my network based on OS Version?

    • draw a pie chart by interfaces admin status for device x.x.x.x

    • can you provide a line chart of my network speed?

    • Can you draw a pie chart of the device x.x.x.x Trans Manufacturer?

    • Can you draw a bar chart of HWSKU based on layer?

    • is any of the device in my network is configured with MTU greater than 9000 and what is the value and device ip?

    • Can you provide the list of free ports in device in my network

    hashtag
    Summary Insights:

    • Give me a summary of my network in the past 24 Hours

    • Can you provide the detailed information on the CPU utilization for Device IP x.x.x.x

    • Can you provide the detailed information on the Mem utilization for Device IP x.x.x.x

    With NCP, you get the visibility and tools needed to automate and optimize daily operations while ensuring network performance and uptime.

    Curated Use Cases

    Use NCP to streamline and strengthen your network operations across these key areas:

    • Basic NetOps Automate and streamline daily tasks, improve operational efficiency, and reduce the risk of human error. Get actionable insights, real-time performance metrics, and generate visual reports to support decision-making.

    • Flow Analytics Gain visibility into how traffic flows through the network. Analyze patterns in real time and historically to detect anomalies, plan capacity, and optimize performance.

    • Quickly search your installed base by interface types, port speed, IP, host name, hardware/OS version, transceivers, location, and more. Ideal for troubleshooting, planning, and architectural reviews.

    • Validate network security against custom-defined rules, including:

      • Secure management access (SSH, TACACS+, RADIUS)

      • Access control (ACLs, firewalls)

    • Proactively manage hardware/software lifecycle to reduce outages and vendor risks. Integrates vendor intelligence - EoS dates, CVEs, bug reports - to monitor your infrastructure’s health.

    • Track OS changes, ensure pre/post upgrade compliance, and visualize how upgrades impact network behavior over time. Supports tracking of firmware changes, RMAs, and config shifts.

    • Integrate with tools like ServiceNow and Zendesk to track support cases by customer ID, monitor trends, and use data to accelerate RCA and build executive-level summaries.

    • For Deep Network Observability users, analyze metadata, KPIs, and even packet captures to understand app usage, user QoE, and pinpoint network impact.

    Security Audits

    Security audits are mandatory for any network infrastructure to meet IT security compliance requirements. These audits typically begin with configuration compliance to ensure the network is protected against unauthorized access and follows organizational security policies.

    hashtag
    Key areas include:

    • Secure management access (SSH, TACACS+, RADIUS)

    • Access control (ACL rules, firewall configurations)

    • Performance protection (e.g., Control Plane Policing)

    The Network Copilot agent framework supports integration with your existing tools to run detailed audits in a multi-vendor environment and generate actionable reports.

    hashtag
    With NCP, you can quickly:

    • generate a security audit report for my network

    • generate security audit report for x.x.x.x

    • generate security audit report for x.x.x.x. Include only SNMP

    Whether you’re preparing for a compliance review or proactively hardening your infrastructure, NCP makes it easy to get accurate, actionable audit data on demand.

    Rocket Chat

    This guide provides step-by-step instructions to integrate Rocket.Chat with Network Copilot using a bot. The integration allows users to interact with Network Copilot directly from Rocket.Chat channels to run queries, generate reports, and collaborate on network insights.

    This helps streamline communication and operational workflows within Rocket.Chat.

    hashtag
    Procedure Overview

    ServiceNow

    hashtag
    Overview

    This guide explains how to integrate your ServiceNow instance with NCP to enhance operational intelligence with ITSM data

    With this integration, you can:

    Zendesk

    hashtag
    Overview

    This section explains how to connect your Zendesk account to Network Copilot (NCP) for integrated service and ticket analytics

    With this integration, you can:

    Provide detailed information on the FAN fault for Device IP x.x.x.x
  • Provide detailed information on the PSU fault for Device IP x.x.x.x

  • Are there any packet drops in any of my devices for past one day?

  • How many linkDown events happened in the past 24 hours?

  • generate audit report for arista devices
  • generate security audit report for <multiple IPs separated by comma)

  • Hostname naming conventions

    Helps ensure IT security compliance and policy enforcement.

    Inventory Insights
    Security Audits
    Support Knowledge Base
    Upgrade Compliance
    Ticketing and Support
    Observability

    Ticketing and Support

    Effective ticket management is key to operational efficiency and rapid incident resolution. Network Copilot integrates with popular ticketing platforms like ServiceNow and Zendesk, enabling users to access real-time and historical support data within a unified dashboard.

    By leveraging this integration, users can monitor case volumes, track open and closed tickets, and filter incidents based on priority, status, customer ID, or issue type. This allows teams to identify recurring patterns, generate summaries for RCA and executive reporting, and streamline troubleshooting workflows.

    The contextual insights from support tickets, combined with operational telemetry, empower users to manage network health and improve service response times proactively.

    • Give me a list of my Zendesk tickets

    • Give me a summary of pending high priority zendesk tickets

    • Summary of 'xyz' tickets

    • Show me all high-priority tickets raised in the last 30 days.

    • What are the top 5 recurring issues reported in Zendesk?

    • Give me the details of ticket id 683.

    • Give me a pie chart of Zendesk tickets grouped by priority and status.

    • Give me the total number of 'xyz' pending tickets

    • Plot a line chart of the number of closed tickets per week ServiceNow

    • List ServiceNow incidents

    • Give me details of ServiceNow incidents that are in progress and of high priority

    • Resolve the service now incident INCxxxxxx

    • Give me a list of ServiceNow incidents with 'xyz'

    Support Knowledge Base

    Effective network support goes beyond troubleshooting—it includes staying informed about known issues, lifecycle updates, and platform advisories. NCP integrates operational data with real-time vendor intelligence to help you manage your network’s health proactively.

    hashtag
    With NCP, you can:

    • Give the details of bug with id CSCum21100

    • give me security advisories for Cisco IOS XE Software 16.12.8

    • provide end of sale details for catalyst switches

    • provide end of support details for catalyst-3560-series-switches

    • Are there any bugs affecting my network operating systems?

    By combining operational data with intelligence on device lifecycles and vulnerabilities, NCP ensures you stay ahead of potential risks and issues—keeping your network running smoothly.

    NetQ Server URL/IP - Base URL or IP address of the NetQ instance

  • Authentication Method - Select one of the following:

    • Auth Token - Paste the token generated from the NetQ Dashboard

    • Username & Password - Enter NetQ administrator credentials with API access

  • Create a Rocket.Chat bot user
  • Generate an authentication token for the bot

  • Configure the Rocket.Chat connector in Network Copilot

  • Add the bot to the desired Rocket.Chat channels

  • Start interacting with Network Copilot from Rocket.Chat

  • hashtag
    Step 1: Create a Rocket.Chat Bot User

    1. Log in to Rocket.Chat as an administrator

    2. Navigate to Administration → Users

    3. Click Add User

    4. Create a dedicated bot user:

      • Username (for example, ncp-bot)

      • Set a strong password

      • Assign appropriate roles (bot or integration role)

    5. Save the user

    hashtag
    Step 2: Generate Bot Authentication Token

    1. Navigate to Administration → Integrations → Bots

    2. Create a new bot and associate it with the bot user

    3. Copy the generated Bot Token

    This token will be used by Network Copilot to authenticate with Rocket.Chat.

    hashtag
    Step 3: Add Rocket.Chat Connector in NCP

    1. Log in to the NCP UI

    2. Toggle Admin View

    3. Navigate to Data Connectors → Add Connector

    4. Select Rocket.Chat

    In the Connect Rocket.Chat form, provide:

    • Rocket.Chat Server URL

    • Bot Username

    • Bot Password

    • Room Name

    Click Connect to complete the configuration.

    hashtag
    Step 4: Add the Bot to Channels

    1. Open the desired Rocket.Chat channel

    2. Add the bot user to the channel

    3. Ensure the bot has permission to read and post messages

    hashtag
    Step 5: Interact with Network Copilot

    Start interacting with Network Copilot from Rocket.Chat by mentioning the bot:

    Example:

    Correlate incident and change data with infrastructure alerts
  • Enable contextual troubleshooting across support and network events

  • Power up LLM-based investigations using service data

  • hashtag
    Connect ServiceNow as a Data Source in NCP

    To set up the ServiceNow connector:

    1. Log in to the NCP GUI

    2. Go to Settings → Data Connectors, then click Add Connector

    3. Select ServiceNow from the connector list

    4. Fill in the connection details:

      • Name – A descriptive label (e.g., ServiceNow)

      • ServiceNow URI – Your instance’s URI (e.g., 172.16.1.195 or a full domain)

    5. Click Connect

    Once linked, ServiceNow will show up in your connectors list with sync status and last activity timestamp

    Correlate infrastructure events with support tickets for faster RCA
  • Gain visibility into issue trends, volumes, and resolution metrics

  • Enable AI-driven insights across operations and support data

  • hashtag
    Connect Zendesk as a Data Source in NCP

    To integrate Zendesk with NCP:

    1. Log in to the NCP GUI

    2. Go to Settings → Data Connectors, then click Add Connector

    3. Select Zendesk from the list

    4. Enter the following connection details:

      • Name – A friendly identifier (e.g., ZD)

      • Subdomain – Your Zendesk subdomain (e.g., aviz if your URL is https://aviz.zendesk.com)

    5. Click Connect

    Once connected, Zendesk will appear in your data connectors list with sync status and timestamp

    Adding Tags

    Users can assign custom tags to data connectors.

    These tags can be referenced in projects or chat interactions to ask data-connector-specific questions or to narrow down troubleshooting to a specific source.

    Step 1: Open the Connector Settings

    • Navigate to: Toggle Admin View → Data Connector

    • Locate the connector you want to tag from the list

    • Click the ⋮ (three-dot) menu beside the connector name

    • Select Edit

    Step 2: Add Tags

    • In the "Add user tags to data connector" dialog:

      • Enter the tag name in the Add tag field

      • (Optional) Edit the description if needed

    Step 3: Verify

    • Once saved, the tag will appear in the Tags column next to the connector entry

    Inventory Insights

    What You Can See with NCP

    hashtag
    NCP helps you instantly answer important inventory questions like:

    • List all my device in network

    Contact Aviz Networks Support

    hashtag
    Contact Support

    Aviz Network Support team can be reached by

    1. Sending an email to

    Upgrade Compliance

    What You Can Track with NCP

    Network upgrades are inevitable and are critical for any network to ensure the security, performance and reliability of the infrastructure. Network upgrades include software or firmware updates, switch RMAs, and configuration changes. Once the upgrade is complete, it's essential for network administrators to confirm that the production environment is functioning normally and that application performance remains unaffected.

    The challenge with upgrade compliance is that it’s a repetitive, detail-oriented task—especially in multi-vendor environments. Network Copilot (NCP) leverages continuously monitored operational data to assist network teams with comprehensive pre- and post-upgrade compliance checks.

    hashtag
    With NCP, stay on top of software lifecycle and compliance with clear, actionable insights:

    @ncp-bot <your query>
    @ncp-bot Generate a compliance report for all spine switches
    Number of devices with their IP address in all region of my network
  • List the device by hostname with their mac address

  • What are the HWSKU used in my network?

  • What are the different platforms running in the network?

  • List the device by hostname with their os details in table format?

  • What are the different ASICs used in the network?

  • List devices with uptime less than 30 days

  • Show devices with their layer and region information by hostname

  • List the device which has no hwsku detail

  • Interfaces count by hostname

  • List all transceiver manufacturers used in my network

  • Is there any interface on any device using auto-negotiation?

  • what are all interfaces with oper status down in device with ip x.x.x.x?

  • is any of the interface in any device has MTU greater than 1500 bytes?

  • Which manufacturer transceiver is used mostly in my network?

  • what are the transceiver serial number present in device with hostname <>?

  • All of this is available in just a few clicks with NCP - no manual scripts or CLI hunting required.

  • Provide os version upgrade history in my network

  • Which region devices has more number of OS upgrades?

  • Which layer devices has more number of OS upgrades?

  • Generate upgrade compliance for the device with ip x.x.x.x

  • Show the history of OS changes for x.x.x.x

  • Count of os version changes in the last 7 days

  • NCP keeps your upgrade visibility sharp, ensuring your network is always in sync with policy and standards.

    Submitting a Ticket at https://support.aviznetworks.comarrow-up-right

  • Live Chat on https://support.aviznetworks.comarrow-up-right

  • hashtag
    Submitting a Ticket

    A ticket could be submitted with or without an account on https://support.aviznetworks.comarrow-up-right

    Mandatory Fields

    • Subject

    • Issue Type (Post Deployment, Pre-Deployment, General Query, RMA)

    • Priority (Low, Normal, High, Urgent)

    • Description

    Optional Fields

    • External ID (Community Request ID or Past Case Number)

    • Hardware (Switch Model)

    • ASIC vendor (chipset)

    • Serial Number

    • Host Name

    • Attachments (Tech Support Dump, Screenshots, Logs)

    For Technical Issues, we recommend the description include;

    • Repro steps, if the issue is reproducible

    • The sequence of events that lead to the failure state

    • Artifacts - Tech Support dump (tar.gz file), Logs, Command Outputs, Topology Diagrams

    support@aviznetworks.comenvelope

    Click Save

    Authentication Method – Choose between:
    • Auth Token

    • Username & Password

  • If using Username & Password:

    • User – Your admin username

    • Password – The corresponding password

  • Email – The admin email associated with the Zendesk account

  • API Token – A Zendesk API token generated from your Zendesk Admin Console

  • Observability

    For customers leveraging the Aviz Deep Network Observability Solutionarrow-up-right, NCP enables detailed analysis of metadata and KPI snapshots. This allows teams to:

    • Identify which applications are being used,

    • Understand how network behavior may impact user or subscriber quality of experience (QoE), and

    • Perform high-level summaries of uploaded telemetry or packet capture files.

    This capability is particularly valuable during troubleshooting, RCA creation, and performance validation workflows.

    Sample Questions

    • Provide summary of uploaded file Ex: DNOAppIn.xlsx

    • What are the applications with details as per uploaded DNOAppIn.xlsx

    • List all the unique application services as per uploaded DNOAppIn.xlsx