Canvas reference
Every canvas control in the words the canvas uses: toolbar, menus, shortcuts and device settings.
On this page
Every control on the canvas, in the words the canvas uses. For how to draw, cable and run an environment, read Canvas. Rows marked Depends on edition are hidden or locked on some editions; see Limits per edition.
Top bar#
| Control | What it does |
|---|---|
| Back to Environments | Returns to the environment list. |
| Environment name, pencil | The pencil (Rename environment) turns the name into a field. Enter saves it, Esc cancels. |
| Caption under the name | Reads "Environment · N devices". It changes to Powering on…, Powering off…, Cancelling… or "N of M running" while devices change state, and to "Focus: name · Esc to exit" in focus mode. |
| Time, CPU, RAM | The time and the CPU and memory use of the appliance, with a colored dot (green, amber from 50 percent, red from 85 percent). The numbers dim while ONEP waits for a new sample. |
| Checkpoints | Opens the checkpoint list: a name and an optional note, Save, then one row per checkpoint with restore and delete. Depends on edition. |
| Snapshot environment | Takes a named disk snapshot of every virtual machine in the environment. Other kinds of device are skipped. Depends on edition. |
| Environment status | Opens or closes the status panel. |
| Lock | Turns the lock on or off for the environment's topology. A locked environment shows an amber lock and a banner on the canvas. |
| Power on · Power off | Starts or stops every device. The label changes to Starting... with a count, Stopping... or Cancelling... while devices change state. |
Toolbar#
The toolbar floats at the bottom of the canvas. It fades while you pan, zoom or drag. Hold the pointer over a button to see its name and shortcut.
| Button | What it does | Shortcut |
|---|---|---|
| Select | Returns to plain selection and closes Add Device or Connect Devices. | |
| Add device | Opens Add Device. | A |
| Connect devices | Opens Connect Devices. | C |
| Undo · Redo | Step back and forward through moves, alignment, shapes and text, up to 50 steps. They do not bring back a deleted device or link. | Ctrl+Z · Ctrl+Y |
| Align & arrange | Opens the align menu, described below. | |
| Zoom (shows a percentage) | Opens a vertical slider with plus and minus. Double-click the button to fit the drawing. The slider covers 25 to 200 percent in steps of 10; scrolling zooms between 20 and 200 percent. | |
| Fit view | Fits the whole drawing in view. It does not zoom out below 60 percent. | Ctrl+F |
| Screenshot | Saves the whole drawing as a PNG file named after the environment and the date. | |
| Layers | Lists every device and shape. Select a device name to find it on the canvas; Hide and Show toggle each item. | |
| Notes | Free text, saved with the environment. | |
| Search | Find a device by name. Enter or a click selects the device and centers it. | |
| Add a diagram picture · View diagram | Adds a PNG or JPEG diagram, or opens the diagram when there is one. | |
| More tools (…) | Opens the menu described below. |
Align & arrange#
- Align selection: Align left, Align right, Center horizontally, Align top, Align bottom, Center vertically. Needs two or more selected devices.
- Distribute horizontally and Distribute vertically. Need three or more.
- Snap to grid (16px): snaps the selected devices, or all devices when none is selected.
- Arrange by connectivity: lays out the whole drawing by how devices are linked, then fits it in view. It moves devices only and never changes the wiring.
- Bring selection to front and Send selection to back.
More tools#
| Row | What it does |
|---|---|
| Appearance… | Canvas theme (Navy, Graphite, White), Grid style (Dots, Lines, Plain), Show interface labels, and the Legend — link type: Ethernet, Serial, Management, Uplink / Cloud and Other, each with its own line style. |
| Annotate… | Add text and Shapes (Rectangle, Circle, Line, Arrow, Dotted line). With an annotation selected: Border style (Solid line, Dotted line), a color picker with presets and, for text, Font (Sans, Serif, Mono, Verdana, Trebuchet, Times, Courier, Impact) and Size (12, 14, 18, 24, 32). |
| Edit… | Copy, Paste, Delete and Select all, each with its shortcut. |
| Customize… | A checklist of the toolbar buttons from Add device to Diagram. Untick a button to move it into this menu under Hidden tools. Reset to default ticks them all. Select and More tools are always on the toolbar. The choice is saved in your browser. |
| Task | Opens a panel with the task text, the description and the source of an imported environment. |
| Show minimap · Hide minimap | Turns the minimap on or off. You can pan and zoom from it. |
| Pin minimap always-on | Cycles Auto, Pinned and Unpinned. The minimap otherwise shows while the pointer is over the canvas. Auto pins it once an environment has more than 30 devices. |
| Refresh | Reloads the environment from the appliance. |
| Keyboard shortcuts | Opens the shortcut sheet. |
Keyboard shortcuts#
Shortcuts do not fire while you type in a field or while a dialog is open. On macOS use Cmd in place of Ctrl.
| Keys | Action |
|---|---|
| A | Add a device. |
| C | Connect devices. |
| R | Refresh. |
| Ctrl+K | Open or close the command palette. |
| ? | Show the shortcut sheet. |
| Ctrl+A | Select all. |
| Delete or Backspace | Delete the selection. ONEP asks you to confirm for devices and links. |
| Esc | Close the top-most open menu or dialog, or deselect when nothing is open. |
| Arrow keys | Nudge the selection by one pixel; with Shift, by 16. |
| Ctrl+D | Duplicate the selection. |
| Ctrl+Z | Undo. |
| Ctrl+Y or Ctrl+Shift+Z | Redo. |
| Ctrl+C · Ctrl+V | Copy and paste the selection. A pasted device is a new device of the same type and image, without links or configuration. |
| Ctrl+F | Fit the whole drawing in view. |
| Shift+click, Shift+drag | Add to the selection; select everything inside a rectangle. |
Command palette#
Press Ctrl+K, type, and press Enter. The arrow keys move through the results. The palette offers:
- Environment: Power on or Power off (whichever applies), Rename environment.
- Canvas: Add device, Connect devices, Fit view, Zoom to 100%.
- Panels: Toggle Layers panel, Toggle Notes panel, Toggle Search panel, Show or Hide minimap.
- Appearance: Theme: Navy, Theme: White, Theme: Graphite, Grid: Dots, Grid: Lines, Grid: Plain.
- Devices: every device by name, which selects it and centers it, and "Open console — name" for each device.
Right-click menus#
| Right-click on | Rows |
|---|---|
| Empty canvas | Add device, Paste, Select all, Delete selected, Refresh, Fit view. |
| A device | The device menu. See The device menu. |
| A cloud node or native switch | Switch to NAT or Switch to Bridge (cloud only), Change icon…, Remove…. |
| One of several selected devices | Start, Stop, Restart, Open consoles, Export configs, Import config to all, Align (Horizontal, Vertical, Grid), Set icon, Lock positions (the row reverses once positions are locked), Delete…. |
| A link | Disconnect link (deletes the link, after a confirmation), Cancel. |
| A shape or text | Color (None, Neutral, Accent, Green, Amber, Red, Blue, Gray, Outline), Text size (S, M, L, XL), Bring to front, Send to back, More (Forward, Backward), Delete. |
| A container shown on the canvas, or in the container panel | Open console, View logs, Start or Stop, Restart, Copy exec cmd. |
Bar above a selected device or link#
- Device: Start this device or Stop this device, Open console (running devices only), Startup config, Reset device, Delete device and More device actions, which opens the device menu.
- Link: Capture on this link (needs the capture permission of your role) and Delete link.
Dialogs#
Add Device#
Name, a class and a role, then for most roles an Image menu. For the Cloud class the dialog asks How should this Cloud connect? with Bridge and NAT instead. Cancel and Add. Add stays disabled until the device has a name.
Connect Devices#
For each end: a device menu, an interface menu that lists free interfaces only, and an optional IP address field. + Add interface appears under an end whose device has no free interface. Router images that use line cards show a note on interfaces that need a restart or add a line card at the next start. Cancel and Connect.
Device Settings#
Opened with Machine Settings. A badge shows the kind of device. While the device runs the fields are locked and Stop & edit stops it. Save Changes applies the settings.
| Field | Meaning | Applies to |
|---|---|---|
| Name | The device name. | All |
| Icon | A preset icon (router, switch, firewall, nac, ips, server, linux, linux-client, windows, pc, container, cloud, attacker, target, kali), Browse... for your own image, or clear to go back to the default. | All |
| Device Type | Class and role of this device. Sets which images the Image menu offers. | All |
| Advanced settings | Shows or hides the hardware options below. | Virtual machines and router images |
| Ethernet line cards | Default, or 1, 2, 3, 4, 6 or 8 cards of four ports each. Applies on the next stop and start. A badge notes that Cisco licenses are bring-your-own. | Router images with line cards |
| Serial line cards | Default (none), 0, 1, 2 or 4 cards. Applies on the next stop and start. | Router images with line cards |
| Network adapters | The number of network cards, 1 to 16. The field shows how many exist now. Saving a different number adds or removes interfaces. | Virtual machines |
| Machine type | Auto (image default), q35 (modern PCIe) or pc / i440fx (legacy). | Virtual machines |
| Firmware | BIOS (SeaBIOS), UEFI + Secure Boot + TPM, or UEFI (no Secure Boot). | Virtual machines |
| NIC model | Auto (vendor default), virtio, e1000, e1000e, vmxnet3 or rtl8139. | Virtual machines |
| Disk bus | Auto (vendor default), virtio, sata or ide. | Virtual machines |
| CPU model | Auto (host-passthrough), host-passthrough, host-model, IvyBridge, Haswell, SandyBridge or qemu64. | Virtual machines |
| vCPU | 1 to 32. The information mark shows where the value came from. | All except router images |
| RAM (MB) | 128 to 65536. The information mark shows where the value came from. | All |
| Image | The image the device runs, limited to ready images of the chosen type. Locked until the device is stopped. A note appears when no ready image exists for the role. | All except cloud nodes |
What a device shows#
- Status word under the name: Powered on, Powered off, Starting, Stopping, Failed, Suspended, Didn't start or Crashed. A cloud node shows NAT or Bridge. The word hides when you zoom far out.
- Status dot on the icon: green when running, red when failed, grey otherwise. It stays visible at every zoom.
- Amber dot on the icon: the image changed and the disk was reset. Point at it for the details.
- Event dot at the top left of the icon: select it for the reason and a Dismiss button.
- Tooltip: a start failure or a crash message, or a hint to double-click a running device for its console.