# Devices

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

## Device Management <a href="#d5e5752" id="d5e5752"></a>

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

<figure><img src="https://667469662-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKRbg64KmM7qNtEAbhYIz%2Fuploads%2Fgit-blob-4d50c790a7da86a955a21d0a8f2678b6acbc80ea%2Fdevice-management.png?alt=media" alt=""><figcaption><p>Device Management View</p></figcaption></figure>

### **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.

{% tabs %}
{% tab title="From the Device Management View" %}
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.

{% hint style="info" %}
In the **Device management** view, you can also apply actions on a device using the more options <img src="https://667469662-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKRbg64KmM7qNtEAbhYIz%2Fuploads%2Fgit-blob-364d49109869070dc89f5e2c9daec76160fa3bac%2Fmore-options.png?alt=media" alt="" data-size="line"> button.
{% endhint %}

**Actions Possible in the Device Management View**

Available actions include **Connect**, **Ping**, **Sync from**, **Sync to**, **Check sync**, **Compare config**, **Fetch ssh host keys**, and **Apply template**, and. See [Lifecycle Operations](https://nso-docs.cisco.com/guides/nso-6.5/operation-and-usage/operations/lifecycle-operations) for the details of these actions.

{% hint style="info" %}
The **Modify in Config Editor** and **Delete** are GUI-specific operations accessible by clicking the more options <img src="https://667469662-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKRbg64KmM7qNtEAbhYIz%2Fuploads%2Fgit-blob-364d49109869070dc89f5e2c9daec76160fa3bac%2Fmore-options.png?alt=media" alt="" data-size="line"> button on the device row.
{% endhint %}
{% endtab %}

{% tab title="From the Configuration Editor -> Actions Tab" %}
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.

{% hint style="info" %}
To fetch information about an action in the **Configuration editor** -> **Actions** tab, click the info <img src="https://667469662-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKRbg64KmM7qNtEAbhYIz%2Fuploads%2Fgit-blob-f5a086c0485a6f4240fccce215adaf758fba9a26%2Factions-info.png?alt=media" alt="" data-size="line"> icon.
{% endhint %}

**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**,

See [Lifecycle Operations](https://nso-docs.cisco.com/guides/nso-6.5/operation-and-usage/operations/lifecycle-operations) for the details of these actions.
{% endtab %}
{% endtabs %}

### **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**.

{% hint style="info" %}
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.
  {% endhint %}

## Device Groups <a href="#d5e5978" id="d5e5978"></a>

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.

<figure><img src="https://667469662-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKRbg64KmM7qNtEAbhYIz%2Fuploads%2Fgit-blob-6007916c613776d18356f4b249d0d6fd82bcf282%2Fdevice-groups.png?alt=media" alt=""><figcaption><p>Device Groups View</p></figcaption></figure>

### **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.

{% hint style="info" %}
In the **Device groups** view, you can also apply actions on a device group using the more options <img src="https://667469662-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKRbg64KmM7qNtEAbhYIz%2Fuploads%2Fgit-blob-364d49109869070dc89f5e2c9daec76160fa3bac%2Fmore-options.png?alt=media" alt="" data-size="line"> button.
{% endhint %}

**Actions Possible in the Device Groups View**

The available group actions are the same as in the section called [Apply an Action on a Device](#apply-an-action-on-a-device) (e.g., **Connect**, **Sync from**, **Sync to**, etc.) and are described in [Lifecycle Operations](https://nso-docs.cisco.com/guides/nso-6.5/operation-and-usage/operations/lifecycle-operations).

{% hint style="info" %}
The **Modify in Config editor** option is accessible by clicking the more options <img src="https://667469662-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKRbg64KmM7qNtEAbhYIz%2Fuploads%2Fgit-blob-364d49109869070dc89f5e2c9daec76160fa3bac%2Fmore-options.png?alt=media" alt="" data-size="line"> button on a device group.
{% endhint %}

## Authgroups

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 [NSO Device Management](https://nso-docs.cisco.com/guides/nso-6.5/operations/nso-device-manager#user_guide.devicemanager.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.

<figure><img src="https://667469662-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKRbg64KmM7qNtEAbhYIz%2Fuploads%2Fgit-blob-072e8d54cd2f4d5583e8c6634b0b4881455c3f6a%2Fdevice-authgroups.png?alt=media" alt=""><figcaption><p>Authgroups View (Group)</p></figcaption></figure>

#### 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:

{% hint style="warning" %}
Proceed with caution as the changes are applied immediately.
{% endhint %}

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.

<figure><img src="https://667469662-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKRbg64KmM7qNtEAbhYIz%2Fuploads%2Fgit-blob-0e6edf1e892847e988f965090d9abdecc47e34dc%2Fdevice-snmpgroups.png?alt=media" alt=""><figcaption><p>Authgroups View (SNMP Group)</p></figcaption></figure>

#### 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:

{% hint style="warning" %}
Proceed with caution as the changes are applied immediately.
{% endhint %}

1. Select the desired group using the checkbox.
2. Click **Delete**.
3. Confirm the intent by pressing **Delete** in the pop-up.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://nso-docs.cisco.com/guides/nso-6.5/operation-and-usage/webui/devices.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
