---
title: "Access to Devices"
slug: "access-to-devices"
updated: 2024-05-02T06:41:37Z
published: 2024-05-02T06:41:37Z
canonical: "docs.zpesystems.com/access-to-devices"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zpesystems.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Access to Devices

This provides an overview of all available devices (Search is available). Users can connect to managed devices and review current device status. User permissions and the current state of Nodegrid Cluster nodes determine which devices are displayed.

## Device Sessions

When a user logs into the WebUI, the first page is the Access section. This is an overview of all available user-accessible targets. Each device current connection status and available connection types are shown.

**Device Sessions**

| **State** | **Indicator color** | **Icon** | **Description** |
| --- | --- | --- | --- |
| Connected | Green | ![](https://cdn.document360.io/763c5fb1-b9af-4ccd-9ad6-cf28ae4cd5a3/Images/Documentation/image-1678125875735.png) | Nodegrid can successfully connect to the device and it is available for sessions |
| In-Use | Blue | ![](https://cdn.document360.io/763c5fb1-b9af-4ccd-9ad6-cf28ae4cd5a3/Images/Documentation/image-1678125885484.png) | The Device is currently in use |
| Disconnected | Orange | ![](https://cdn.document360.io/763c5fb1-b9af-4ccd-9ad6-cf28ae4cd5a3/Images/Documentation/image-1678125908716.png) | Nodegrid could not successfully connect to the device and it is not available for sessions |
| Unknown | Grey | ![](https://cdn.document360.io/763c5fb1-b9af-4ccd-9ad6-cf28ae4cd5a3/Images/Documentation/image-1678125920812.png) | The connection status is unknown. This is the default state for devices with the connection mode On-Demand or for new devices for which the discovery process is not completed. |

Device sessions can be directly started from this location.

### WebUI View![](https://cdn.document360.io/763c5fb1-b9af-4ccd-9ad6-cf28ae4cd5a3/Images/Documentation/image-1678125967166.png)

### Console (CLI) View

Click Console to display a new target session window. ![](https://cdn.document360.io/763c5fb1-b9af-4ccd-9ad6-cf28ae4cd5a3/Images/Documentation/image-1678126006306.png)

Buttons at lower center can further control the session and device. Available options depend on connection type and device configuration.

**Session Options**

| **Options** | **Description** |
| --- | --- |
| ![](https://cdn.document360.io/763c5fb1-b9af-4ccd-9ad6-cf28ae4cd5a3/Images/Documentation/image-1678126136002.png) | Displays current device details. |
| <v:shape id="Picture_x0020_345" o:spid="_x0000_i1031" type="#_x0000_t75"><v:imagedata o:title="" src="file:///C%3A/Users/ALLANS~1/AppData/Local/Temp/msohtmlclip1/01/clip_image002.wmz"><img src="https://cdn.document360.io/763c5fb1-b9af-4ccd-9ad6-cf28ae4cd5a3/Images/Documentation/image-1678126150786.png" class="fr-fic fr-fil fr-dib" style="height: 30px;"></v:imagedata></v:shape> | Expand the window to use the full monitor screen. The session window does not expand beyond its maximum size. |
| <v:shape id="Picture_x0020_346" o:spid="_x0000_i1030" type="#_x0000_t75"><v:imagedata o:title="" src="file:///C%3A/Users/ALLANS~1/AppData/Local/Temp/msohtmlclip1/01/clip_image003.wmz"><img src="https://cdn.document360.io/763c5fb1-b9af-4ccd-9ad6-cf28ae4cd5a3/Images/Documentation/image-1678126164673.png" class="fr-fic fr-fil fr-dib" style="height: 25px;"></v:imagedata></v:shape> | Performs a power off on the device through a connected Rack PDU or IPMI device. |
| <v:shape id="Picture_x0020_347" o:spid="_x0000_i1029" type="#_x0000_t75"><v:imagedata o:title="" src="file:///C%3A/Users/ALLANS~1/AppData/Local/Temp/msohtmlclip1/01/clip_image004.wmz"><img src="https://cdn.document360.io/763c5fb1-b9af-4ccd-9ad6-cf28ae4cd5a3/Images/Documentation/image-1678126175706.png" class="fr-fic fr-fil fr-dib" style="height: 30px;"></v:imagedata></v:shape> | Performs a power on for the device through a connected Rack PDU or IPMI device. |
| <v:shape id="Picture_x0020_348" o:spid="_x0000_i1028" type="#_x0000_t75"><img src="https://cdn.document360.io/763c5fb1-b9af-4ccd-9ad6-cf28ae4cd5a3/Images/Documentation/image-1678126210505.png" class="fr-fic fr-fil fr-dib" style="height: 30px;"></v:shape> | Initiates a power cycle on the device through a connected Rack PDU or IPMI device. |
| <v:shape id="Picture_x0020_349" o:spid="_x0000_i1027" type="#_x0000_t75"><v:imagedata o:title="" src="file:///C%3A/Users/ALLANS~1/AppData/Local/Temp/msohtmlclip1/01/clip_image006.wmz"><img src="https://cdn.document360.io/763c5fb1-b9af-4ccd-9ad6-cf28ae4cd5a3/Images/Documentation/image-1678126230907.png" class="fr-fic fr-fil fr-dib" style="height: 30px;"></v:imagedata></v:shape> | Display device’s current power status (as returned by a connected Rack PDU or IPMI device). |
| <v:shape id="Picture_x0020_350" o:spid="_x0000_i1026" type="#_x0000_t75"><v:imagedata o:title="" src="file:///C%3A/Users/ALLANS~1/AppData/Local/Temp/msohtmlclip1/01/clip_image007.wmz"><img src="https://cdn.document360.io/763c5fb1-b9af-4ccd-9ad6-cf28ae4cd5a3/Images/Documentation/image-1678126248387.png" class="fr-fic fr-fil fr-dib" style="height: 30px;"></v:imagedata></v:shape> | Closes the active session. |
| <v:shape id="Picture_x0020_351" o:spid="_x0000_i1025" type="#_x0000_t75"><v:imagedata o:title="" src="file:///C%3A/Users/ALLANS~1/AppData/Local/Temp/msohtmlclip1/01/clip_image008.wmz"><img src="https://cdn.document360.io/763c5fb1-b9af-4ccd-9ad6-cf28ae4cd5a3/Images/Documentation/image-1678126262241.png" class="fr-fic fr-fil fr-dii" style="height: 30px;"></v:imagedata></v:shape> | Expands or minimizes the command line options at the window’s lower center. |

Close the CLI window to end the device session.

### Copy & Paste Functionality

NOTETTYD terminal copy and paste is not currently supported within Windows and Linux.

Nodegrid supports Copy & Paste of text between the HTML5 graphical device session window and the desktop environment. Some OS may require a different key combination.

Windows and Linux user – Ctrl+Ins to copy highlighted text and Shift+Ins to paste. Mac users - Cmd+C to copy, and Cmd+V to paste.

Highlight the text and right-click to open the menu – or use the shortcuts. ![](https://cdn.document360.io/763c5fb1-b9af-4ccd-9ad6-cf28ae4cd5a3/Images/Documentation/image-1678126595904.png)

## CLI Device Sessions

A user can directly go to this directory with cd /access.

### View currently available targets

**show**.

Example:

```none
[admin@nodegrid access]# show
  name                   status
  =====================  =========
  Device_Console_SSH     Connected
  Device_Console_Serial  InUse
  IPMI                   Connected
  RPDU                   Connected
  usbS2                  Connected
```

### Start a device session

**connect <target name>**

Example:

```none
[admin@nodegrid access]# connect Device_Console_Serial
[Enter '^Ec?' for help]
[Enter '^Ec.' to cli ]

login:
```

NOTEOnly console sessions or sessions which provide a text-based interface can be started from the CLI.

With an established connection, use the escape sequence ^Ec or ^O to further control the session.

NOTEEscape sequences can be changed in Device Settings.

**Session Options**

| **Option** | **Escape sequence** | **Description** |
| --- | --- | --- |
| . | ^Ec. | Disconnect the current session. |
| g | ^Ecg | Display current user group information. |
| l | ^Ecl | Send break signal (defined in Device Settings). |
| w | ^Ecw | Display currently connected users. |
| <cr> | ^Ec<cr> | Send ignore/abort command signal. |
| k | ^Eck | Serial port (speed data bits parity stop bits flow). |
| b | ^Ecb | Send a broadcast message. Type message after the escape sequence. |
| i | ^Eci | Display current serial port information. |
| s | ^Ecs | Change current session to read-only mode. |
| a | ^Eca | Change current session to read-write mode. |
| f | ^Ecf | Force current session to read-write mode. |
| z | ^Ecz | Disconnect a specific connected user session. |
| ? | ^Ec? | Print this message. |

Power Control options are available on targets connected to a managed Rack PDU or provided power control through IMPI. The power menu can be displayed with ^O.

```none
Power Menu - Device_Console_Serial
Options:
1. Exit
2. Status
3. On
4. Off
5. Cycle

Enter option:
```
