Release Announcement: NSO 6.5 is now released.
Head to the release highlights to see what's new
LogoLogo
NSO DevCenterTry NSO
NSO 6.5
  • Get Started
  • User Guides
  • Developers
  • Release Info
NSO 6.5
  • Start
  • What's New
  • Administration
    • Get Started
    • Installation and Deployment
      • Local Install
      • System Install
      • Post-Install Actions
        • Explore the Installation
        • Start and Stop NSO
        • Create NSO Instance
        • Enable Development Mode
        • Running NSO Examples
        • Migrate to System Install
        • Modify Examples for System Install
        • Uninstall Local Install
        • Uninstall System Install
      • Containerized NSO
      • Deployment Example
      • Upgrade NSO
    • Management
      • System Management
        • Cisco Smart Licensing
        • Log Messages and Formats
        • Alarm Types
      • Package Management
      • High Availability
      • AAA Infrastructure
      • NED Administration
    • Advanced Topics
      • Locks
      • CDB Persistence
      • IPC Connection
      • Cryptographic Keys
      • Service Manager Restart
      • Security Issues
      • Run NSO as Non-Privileged User
      • IPv6 on Northbound Interfaces
      • Layered Service Architecture
  • Operation & Usage
    • Get Started
    • CLI
      • Introduction to NSO CLI
      • CLI Commands
    • Web UI
      • Home
      • Devices
      • Services
      • Config Editor
      • Tools
    • Operations
      • Basic Operations
      • NEDs and Adding Devices
      • Manage Network Services
      • Device Manager
      • Out-of-band Interoperation
      • SSH Key Management
      • Alarm Manager
      • Plug-and-Play Scripting
      • Compliance Reporting
      • Listing Packages
      • Lifecycle Operations
      • Network Simulator
  • Development
    • Get Started
    • Introduction to Automation
      • CDB and YANG
      • Basic Automation with Python
      • Develop a Simple Service
      • Applications in NSO
      • Develop and Deploy a Nano Service
    • Core Concepts
      • Services
      • Implementing Services
      • Templates
      • Nano Services
      • Packages
      • Using CDB
      • YANG
      • NSO Concurrency Model
      • Service Handling of Ambiguous Device Models
      • NSO Virtual Machines
        • NSO Python VM
        • NSO Java VM
        • Embedded Erlang Applications
      • API Overview
        • Python API Overview
        • Java API Overview
      • Northbound APIs
        • NSO NETCONF Server
        • RESTCONF API
        • NSO SNMP Agent
    • Advanced Development
      • Development Environment and Resources
      • Developing Services
        • Services Deep Dive
        • Service Development Using Java
        • NSO Developer Studio
      • Developing Packages
      • Developing NEDs
        • NETCONF NED Development
        • CLI NED Development
        • Generic NED Development
        • SNMP NED
        • NED Upgrades and Migration
      • Developing Alarm Applications
      • Kicker
      • Scaling and Performance Optimization
      • Progress Trace
      • Web UI Development
        • JSON-RPC API
    • Connected Topics
      • SNMP Notification Receiver
      • Web Server
      • Scheduler
      • External Logging
      • Encrypted Strings
  • Resources
    • Manual Pages
      • Section 1
      • Section 3
      • Section 5
Powered by GitBook
LogoLogo

Site

  • Cisco.com
  • Documentation
  • Learning Labs
  • Sample Code

Connect

  • Feedback
  • Community
  • Blogs
  • Events

Follow Us

  • X/Twitter
  • Facebook
  • YouTube
  • LinkedIn

© Copyright 2025 Cisco Systems, Inc. | This site is part of the official Cisco Crosswork NSO documentation set.

On this page
  • Device Management
  • Search
  • Add a Device
  • Apply an Action on a Device
  • Edit Device Configuration
  • Device Groups
  • Create a Device Group
  • Remove Device(s) from a Device Group
  • Apply an Action on a Device Group
  • Authgroups
  • Groups
  • SNMP Groups

Was this helpful?

Edit on GitHub
Export as PDF
  1. Operation & Usage
  2. Web UI

Devices

Manage devices, device groups, and authgroups in your NSO deployment.

PreviousHomeNextServices

Last updated 3 days ago

Was this helpful?

The Devices view provides options to manage devices, device groups, and authgroups in the NSO network.

Device Management

The Device management view lists the devices in the network and provides options to manage them.

Search

You can search for a device by its name, IP address, or other parameters. Narrow down the results by using the Select device group filter.

Add a Device

To add a new device to NSO:

  1. Click the Add device button.

  2. In the Add device pop-up, specify the device name.

  3. Click Add.

  4. Configure the specifics of the device in the Configuration editor.

  5. Review and commit the changes in the Commit manager when done.

Apply an Action on a Device

Actions can be applied on a device from the Device management view or the Configuration editor -> Actions tab.

An action can be applied to a single or multiple devices at once.

  1. Select the device(s) from the list using the checkbox.

  2. Using the Choose actions button, select the desired action. The result of the action is returned momentarily.

Actions Possible in the Device Management View

Additional actions are applied to an individual device. Use this option if you want to run an action with additional parameters.

  1. Click the device name in the list. You will be redirected to the Configuration editor view.

  2. Access the Actions tab in the Configuration editor.

  3. Click the desired action in the list.

  4. At this point, you can configure different parameters.

    (To reset all the parameters to their default value, use the Reset action parameters option).

  5. Run the action.

Actions Possible in the Configuration Editor -> Actions Tab

If you access the device in the Configuration editor, the following additional actions are available:

migrate, instantiate-from-other-device, check-yang-modules, scp-to, copy-capabilities, compare-config, connect, scp-from, find-capabilities, sync-from, disconnect, rename, add-capability, sync-to, ping, load-native-config, apply-template, check-sync, delete-config, clear-trace, and fetch-host-keys,

Edit Device Configuration

To edit the device configuration of an existing device:

  1. In the Devices view, click the desired device from the list.

  2. In the Configuration editor, click the Edit config tab.

  3. Make the desired changes.

    (Press Enter to save the changes. An uncommitted change in a field's value is marked by a green color, and is referred to as a 'dirty state').

  4. Review and commit the change in the Commit manager.

The other two tabs, i.e., Config and Operdata can be respectively used to:

  • View the device configuration, and,

  • View the device's operational data.

Device Groups

The Device groups view lists all the available groups and devices belonging to them. You can add new device groups in this view as well as carry out actions on devices belonging to a group.

Create a Device Group

Device groups allow for the grouping and collective management of devices.

  1. Click Add device group.

  2. In the Create device group pop-up, specify the group name.

    • If you want to place the new device group under a parent group, select the Place under parent device group option and specify the parent group.

  3. Click Create. You will be redirected to the group's details page. Here, the following panes are available:

    • Details: Displays basic details of the group, i.e., its name and parent/subgroup information. To link a sub-group, use the Connect sub device group option.

    • Devices in this group: Displays currently added devices in the group and provides the option to remove them from the group.

    • Add devices: Displays all available NSO devices and provides the option to add them to the group.

  4. In the Add devices pane, select the device(s) that you want to add to the new group and click Add to device group. The added devices become visible under the Devices in this group pane.

  5. Finally, click Create device group.

Remove Device(s) from a Device Group

  1. Click the desired device group to access the group's detail page.

  2. In the Devices in this group pane, select the device(s) to be removed from the group.

  3. Click Remove from device group. The devices are removed immediately (without a Commit Manager review).

  4. Click Save device group.

Apply an Action on a Device Group

Device group actions let you perform an action on all the devices belonging to a group.

  1. Select the desired device group from the list. It is possible to select multiple groups at once.

  2. Choose the desired action from the Choose actions button.

Actions Possible in the Device Groups View

Authgroups

This view is further partitioned into the following two tabs for different device types:

  • The Group tab

  • The SNMP Group tab

Groups

The Group tab is used to view, search, and manage device authentication groups for CLI and NETCONF-managed devices.

Create an Authgroup

To create a new group:

  1. Click the Add authgroup button.

  2. Enter the Authgroup name and click Continue.

  3. In the group details page, add users to the newly created group. If a default map is desired for unknown/unmapped users, use the Set default-map option.

    1. Click the Add user button to bring up the Add user overlay window. Here, you have the option to add the user with the authentication type set to 'remote mapping' or 'callback':

      • Remote mapping: If remote mapping is desired, specify the local-user that is to be mapped to remote authentication credentials and configure the following settings:

        • remote-user: Choose between same-user or remote-name options.

        • remote-auth: Choose between same-pass, remote-password, or public-key options.

        • remote-secondary-auth (optional): Choose between same-secondary-password or remote-secondary-password options.

      • Callback: If a callback-type authentication is desired to retrieve login credentials, specify the local-user, set the Use callback flag, and configure the following settings:

        • callback-node

        • action-name

    2. Click Add. This adds the newly created user to the group and displays it in the list.

  4. Click Create authgroup to save and finish creating the group.

View/Edit Authgroup Details

To view/edit details of a group:

  1. Click the group name to access the group details page.

  2. Make the desired changes, such as adding/removing a user from the group, editing existing user settings, or configuring general group settings.

  3. Click the Save authgroup button to save and apply the changes.

Delete an Authgroup

To delete a group:

Proceed with caution as the changes are applied immediately.

  1. Select the desired group using the checkbox.

  2. Click Delete.

  3. Confirm the intent by pressing Delete in the pop-up.

SNMP Groups

The SNMP Group tab is used to view, search, and manage device authentication groups for SNMP-managed devices.

Create an SNMP Group

To add a new group:

  1. Click the Add SNMP group button.

  2. Enter the SNMP group name and click Continue.

  3. In the group details page, add users to the newly created group. If a default map is desired for unknown/unmapped users, use the Set default-map option.

    1. Click the Add user button to bring up the Add user overlay window.

    2. Specify the local-user and configure the following settings:

      • community (optional): Choose between community-name or community-binary-name.

      • remote-user: Choose between same-user or remote-name options.

      • security-level: Choose between no-auth-no-priv, auth-no-priv, or auth-priv options. Depending on the security-level selection, specify further the required SNMP authentication and privacy parameters, which include the authentication/privacy protocol, key type, and remote password.

    3. Click Add. This adds the newly created user to the group and displays it in the list.

  4. Click Create SNMP group to save and finish creating the group.

View/Edit SNMP Group Details

To view/edit details of a group:

  1. Click the group name to access the group details page.

  2. Make the desired changes, such as adding/removing a user from the group, editing existing user settings, or configuring general group settings.

  3. Click the Save SNMP group button to save and apply the changes.

Delete an SNMP Group

To delete a group:

Proceed with caution as the changes are applied immediately.

  1. Select the desired group using the checkbox.

  2. Click Delete.

  3. Confirm the intent by pressing Delete in the pop-up.

In the Device management view, you can also apply actions on a device using the more options button.

Available actions include Connect, Ping, Sync from, Sync to, Check sync, Compare config, Fetch ssh host keys, and Apply template, and. See for the details of these actions.

The Modify in Config Editor and Delete are GUI-specific operations accessible by clicking the more options button on the device row.

To fetch information about an action in the Configuration editor -> Actions tab, click the info icon.

See for the details of these actions.

In the Device groups view, you can also apply actions on a device group using the more options button.

The available group actions are the same as in the section called (e.g., Connect, Sync from, Sync to, etc.) and are described in .

The Modify in Config editor option is accessible by clicking the more options button on a device group.

The Authgroups view displays device authentication groups and provides ways to manage them. Concepts and settings involved in the authentication groups setup are discussed in .

Lifecycle Operations
Lifecycle Operations
Lifecycle Operations
Apply an Action on a Device
NSO Device Management
Device Management View
Device Groups View
Authgroups View (Group)
Authgroups View (SNMP Group)