# Devices

## Devices

* Navigate to <mark style="color:blue;">**Inventory >> Devices**</mark>

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FX2iDMDmYrPYCdn4r2A7i%2FScreenshot%202025-02-21%20at%202.32.47%E2%80%AFPM.png?alt=media&#x26;token=9a138922-695a-4782-a420-331140a4409f" alt=""><figcaption></figcaption></figure>

* Using this tab, user can:
  * Onboard the non-sonic(Agent-Less) device to the application using Add devices
  * Syslogs capture
  * Upgrade the device using Custom Upgrade
  * Upgrade the device using ZTP (Zero Touch Provisioning)
  * Reboot individual devices or multiple devices by selecting them in one click
  * Remove the devices
  * Tech-Support download
  * Complete Inventory can be downloaded in CSV format

{% hint style="warning" %}
The user needs to make sure, The devices have a unique name, otherwise, there will issue while plotting the full topology view(Topology Page).
{% endhint %}

### Sonic Devices

* Agent-based devices auto-discover the ONES-App and get registered automatically on the ONES Inventory page

### Add Non-Sonic Devices

* To Onboard the Agent-Less devices user needs to add them manually
  * Navigate to Inventory

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FZiNmyDUAkt7xoN1yncjv%2FScreenshot%202023-11-17%20at%2010.52.33%E2%80%AFPM.png?alt=media&#x26;token=c2c8ea39-392a-49a3-a349-f745a947e65e" alt="" width="175"><figcaption></figcaption></figure>

* This page gives the control to onboard the devices with two options&#x20;
  1. <mark style="color:blue;">**Add Devices**</mark> using the <mark style="color:blue;">**YAML Editor**</mark>&#x20;
  2. Upload the <mark style="color:blue;">**CSV file**</mark> containing the device list

{% hint style="warning" %}
The movement user chooses CSV upload, then the YAML Editor will be disabled
{% endhint %}

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FzAhbcZ8FLPa7VxKHzHvU%2Fimage.png?alt=media&#x26;token=55cc585b-fbc6-4557-9409-a6cc0df191ec" alt=""><figcaption></figcaption></figure>

## 1. Add Devices using YAML

* Click on <mark style="color:blue;">**Add Devices**</mark>
* Upload Device Inventory using <mark style="color:blue;">**YAML Editor**</mark>
* Navigate to <mark style="color:blue;">**Inventory >> Devices >> Add Devices >> Use YAML**</mark>
* Use the below format to add devices to the application

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FC9TvTuBYvmWhKUxrsKiS%2FScreenshot%202025-02-21%20at%209.20.52%E2%80%AFPM.png?alt=media&#x26;token=62ae123a-6a54-4fef-bf01-0ae3e9d098ad" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
To Identify the device type user needs to mention the platform
{% endhint %}

### Device Type&#x20;

1. Cumulus: cumulus
2. Arista: arista
3. Cisco: cisco-nxos
4. SONiC: sonic&#x20;
5. Server: server

{% hint style="info" %}
For SONiC-based devices, the user can also leave the type field empty
{% endhint %}

<pre class="language-yaml"><code class="lang-yaml"><strong> inventory:
</strong>     - ipAddress: "10.4.4.61"
       layer: "Spine"
       region: "San Jose"
       azId: 1
       brickId: 1
       user: "admin"
       password: "YourPaSsWoRd"
       type: "cumulus"
     - ipAddress: "10.4.4.62"
       layer: "Spine"
       region: "San Jose"
       azId: 1
       brickId: 1
       user: "admin"
       password: "YourPaSsWoRd"
       type: "arista"
     - ipAddress: "10.4.4.63"
       layer: "Spine"
       region: "San Jose"
       azId: 1
       brickId: 1
       user: "admin"
       password: "YourPaSsWoRd"
       type: cisco-nxos
     - ipAddress: "10.4.4.64"
       layer: "Spine"
       region: "San Jose"
       azId: 1
       brickId: 1
       user: "admin"
       password: "YourPaSsWoRd"
       type: "sonic"
     - ipAddress: "10.10.0.10"
       layer: "Spine"
       region: "San Jose"
       azId: 1
       brickId: 1
       user: "admin"
       password: "admin@123"
       type: "server"

</code></pre>

* Make sure to use the correct indentation for the YAML files
* Click <mark style="color:blue;">**Save & Apply**</mark>
* ONES Application is now ready to manage the added devices

## 2. Add devices using CSV

* Click on <mark style="color:blue;">**Add Devices**</mark>
* Upload Device Inventory using <mark style="color:blue;">**CSV File**</mark>
* Navigate to <mark style="color:blue;">**Inventory >> Devices >> Add Devices >> Use CSV**</mark>
* Use the below format to add devices to the application

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FtgdodZRHo3kQ7NOHnsRD%2FScreenshot%202024-04-15%20at%209.31.00%E2%80%AFPM.png?alt=media&#x26;token=2763b568-feee-45ff-91a9-bfab15058a20" alt=""><figcaption></figcaption></figure>

* <mark style="color:blue;">**Select CVS file to Upload >> Choose CSV file containing devices entry >>**</mark>

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FuZoWa0hhywPVYqfeVZBX%2FScreenshot%202024-04-15%20at%209.31.41%E2%80%AFPM.png?alt=media&#x26;token=1dc80d44-af08-4c07-902c-bda17fed0b9d" alt="" width="563"><figcaption></figcaption></figure>

* <mark style="color:blue;">**Upload & Add**</mark>

### Feature Set

* Role / Region: Shows the device roles and regions
* SKU / ASIC: Shows the device hardware SKU and ASIC vendor
* Port / Max Speed
  * Shows the number of ports per device and max port speed on the device&#x20;
  * Click on the number of ports to get a detailed view of all the ports on a particular device

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FO9lpCKoPO32ZQ9e4o3uJ%2FScreenshot%202025-02-21%20at%209.23.59%E2%80%AFPM.png?alt=media&#x26;token=5adc1596-f57d-4fde-ab46-c190c7192e10" alt=""><figcaption></figcaption></figure>

* PSUs / Fans: Shows the total number of Power supplies and Fans present on a particular device
* NOS Image: Shows the details of the network operating system running on the device and when it was last updated
* ONIE Version: Shows which ONIE version is running on the device and when the last reboot time of the device
* Agent Version / Network OS: Shows the agent version running on the device and the current active OS version on the device
* Agent status / Last contact: Latest status of the Agent and when it was last communicated with that Agent.
* Connect: Using this feature we directly get the CLI access of the device

  * SSH Connect&#x20;
  * Console Connect

  <figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FB3JiO1nDXGm7VWqaPPjZ%2FScreenshot%202024-09-19%20at%208.48.31%E2%80%AFPM.png?alt=media&#x26;token=2c0cbff4-ffac-443b-bbd5-ff79d629765e" alt=""><figcaption></figcaption></figure>
* Details: This last option we can again use to get the details of the device

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FIM7X9lIpTo3fCvCXgQDp%2FScreenshot%202025-02-21%20at%209.25.32%E2%80%AFPM.png?alt=media&#x26;token=4fbd4e88-57e6-4a7a-9813-c6dfe57e30d4" alt=""><figcaption></figcaption></figure>

### IP Transition&#x20;

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2Fq2V1Pzs665Upo1X24ZHX%2Fimage.png?alt=media&#x26;token=afdcd432-02c5-4019-af6e-fbeca711fd70" alt=""><figcaption></figcaption></figure>

### Remove Devices from the ONES Application

* Navigate to <mark style="color:blue;">**Inventory >> Devices >> Remove Devices**</mark>
* Choose the devices to be removed & confirm

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2F7bwhPWf3G84pi2F67YtA%2FScreenshot%202025-02-21%20at%209.28.19%E2%80%AFPM.png?alt=media&#x26;token=99da4389-08cb-4482-a7e9-bee931c3e293" alt=""><figcaption></figcaption></figure>

* once the user clicks on confirm, the Inventory page will remove the device

{% hint style="warning" %}
If the devices are agent-based they will get added again after some time, \
if the user wants to remove the agent-based devices, then the user needs to uninstall the agent from the device
{% endhint %}

* Now  the selected devices have been removed from the ONES application

## Custom Upgrade

{% hint style="success" %}
This feature gives the control to upgrade the device to the new version

An HTTP image link is required to use the custom upgrade
{% endhint %}

* Select any of the devices to upgrade to the new version

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FXNbzbx6zSlhR3maJv3Bi%2Fimage.png?alt=media&#x26;token=0fb35dba-8d1d-4163-a020-7b94ec3c5851" alt=""><figcaption></figcaption></figure>

* Click on `Custom Upgrade`

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2F7MXkgqoXz0Qarot637RY%2FScreenshot%202025-02-21%20at%209.30.40%E2%80%AFPM.png?alt=media&#x26;token=112e6b5d-0783-4e05-8e51-febce51c1976" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
While upgrading the device, user will have option to take configuration backup
{% endhint %}

* put the new Image URL and then <mark style="color:red;">**`Submit`**</mark>

It will show the status as <mark style="color:red;">**&#x20;**</mark><mark style="color:red;">**`In Progress`**</mark>

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FTJuVKrYyteyjTu6SW9cV%2FScreenshot%202024-09-19%20at%208.54.26%E2%80%AFPM.png?alt=media&#x26;token=fb1a51fa-19bf-48e6-8d9e-3b114f5b6da9" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**HTTP image URL should be accessible**

**This image will be downloaded to the device  and configured as the next boot image and devices will be reloaded**

**Once the device comes up with the new image, the ONES application will install Telemetry and Fabric manager agent**

**when we upgrade any device that will be locked to do any further changes after a successful upgrade user can again use the same device for another task**\\

**Once the image is loaded, the ONES application will show the last image details and time stamp**

{% endhint %}

## Upgrade via ZTP

{% hint style="success" %}
Using this page a user can directly upgrade the box
{% endhint %}

* Select any of the devices to upgrade via ZTP

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FKlqHdiEs93I7m01WkIeX%2FScreenshot%202025-02-21%20at%209.31.29%E2%80%AFPM.png?alt=media&#x26;token=a5f75992-c84c-464c-9724-9501c9b238b0" alt=""><figcaption></figcaption></figure>

* Click on `Upgrade via ZTP`

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FxXQSx8hM9Fqecte2QorP%2FScreenshot%202025-02-21%20at%209.32.20%E2%80%AFPM.png?alt=media&#x26;token=97a38074-7c3f-41f8-bc1e-5313327963bb" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
While upgrading the device, user will have option to take configuration backup
{% endhint %}

* Click on `Yes`

{% hint style="info" %}
when we upgrade any device that will be locked to do any further changes, after a successful upgrade user can again use the same device for another task
{% endhint %}

## Reboot Device

* Here we will see how we can reboot a device using&#x20;
* We have the option to choose one or multiple devices at a time to reboot
* Choose one of the devices that we want to reboot

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2F1fzboJjxFk52nBUT9pmi%2Fimage.png?alt=media&#x26;token=e5dee8a3-c9bc-4880-84cf-aeec7cb72b8a" alt=""><figcaption></figcaption></figure>

* `Click on Reboot`&#x20;

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FqncvkDaFj4zLb2Q1iXqG%2FScreenshot%202025-02-21%20at%209.34.20%E2%80%AFPM.png?alt=media&#x26;token=2a63e061-a90a-4757-8464-2ccd0cbc2e44" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
While rebooting the device, user will have option to take configuration backup
{% endhint %}

* `Click on Yes`

{% hint style="info" %}
While rebooting the device, the device will be locked to do any other task, once the reboot is successful, the lock will be removed and the user can take any new action &#x20;
{% endhint %}

### Sub-options

* Syslog

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FZKWyxOZC5CluhauaemOs%2Fimage.png?alt=media&#x26;token=4171362e-1e28-4a6c-bb94-316d4b69acf5" alt=""><figcaption></figcaption></figure>

#### User will have option to choose count of the logs and can filter as per only Error or Only Warning or all the logs

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2F18Fh3VS2mNWX5XTr27lE%2FScreenshot%202024-09-19%20at%209.02.17%E2%80%AFPM.png?alt=media&#x26;token=1e4e4dbc-aa52-4e14-8ed7-0d7cd7f464d6" alt=""><figcaption></figcaption></figure>

* Tech Support

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FpeROJXHxMEmaLSiyNyBa%2Fimage.png?alt=media&#x26;token=be901ecb-1b05-4dc5-9623-0c06237019ec" alt=""><figcaption></figcaption></figure>

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FvUGrLCDucq1kvOyjcemv%2FScreenshot%202024-09-19%20at%209.04.28%E2%80%AFPM.png?alt=media&#x26;token=6deaef77-284a-4b1c-a234-55bb4c021b31" alt=""><figcaption></figcaption></figure>

* Export Inventory

<figure><img src="https://21707399-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2kx3WmNibhYYGgtbf7Ky%2Fuploads%2FuSDR78glIRhWfpL480Wu%2Fimage.png?alt=media&#x26;token=f2354719-6fb3-45aa-a658-8ef2cbf0d007" alt=""><figcaption><p>User can find the Inventory file in download directory</p></figcaption></figure>
