ARTICLE 02 / 02

OKTET-OS CLI essentials

The configuration model, navigating modes, show commands, and the commit/save workflow that every OKTET-OS task depends on.

OKTET-OS uses a structured, commit-based CLI. Configuration changes are staged in a candidate, reviewed, then applied atomically with commit. This page covers the essentials you need before any other CLI task.

Connect

Open an SSH session to the management address:

ssh admin@10.0.10.5

You land in operational mode, indicated by a > prompt. Operational mode runs show commands, diagnostics, and actions. To change configuration, enter configuration mode:

configure

The prompt changes to #. Type exit to leave configuration mode and return to operational mode.

Read before you write: show commands

Always inspect state before changing it. Common operational show commands:

show system
show interfaces
show interface ethernet 1
show vlan
show poe
show log last 50

In configuration mode, review the running and candidate configuration:

show configuration
show configuration | compare

show configuration | compare prints only what your candidate would change versus the running config — read this before every commit.

The candidate / commit / save model

This is the most important concept in OKTET-OS. Three distinct states exist:

  • Candidate — your staged edits. Not yet active.
  • Running — what the switch is doing right now.
  • Startup — what loads after a reboot.

A set command edits the candidate only. Nothing happens to live traffic until you commit.

configure
set interface ethernet 5 description "uplink-to-core"
set interface ethernet 5 speed 10000
show configuration | compare
commit
save
  • commit applies the candidate to the running configuration atomically — all changes take effect together, or none do if validation fails.
  • save copies the running configuration to startup so it survives a reboot. A commit without a save is lost on the next power cycle. This is intentional: it gives you a safety net (see below).

Commit confirmed: the remote-change safety net

When you make a change that could lock you out — a management-address change, an ACL, a routing edit — use a confirmed commit:

commit confirmed 5

This applies the change but automatically rolls it back after 5 minutes unless you confirm. If the change cut your connection, doing nothing restores the previous config. If everything still works, lock it in:

commit
save

Use this discipline for every change made over the network on a production device.

Removing configuration

Use delete to remove a candidate setting, then commit:

configure
delete interface ethernet 5 description
commit
save

Rolling back

OKTET-OS keeps recent committed revisions. To view and restore:

show configuration revisions
rollback 1
commit

rollback 1 loads the previous committed configuration into the candidate; commit makes it live. This is the fastest recovery from a bad change.

Saving and exporting configuration

Export the full configuration for backup or version control:

show configuration | save backup-2026-05-22.cfg

Keep dated configuration exports in your own repository. The switch’s revision history is a convenience, not a backup strategy.

Quick reference

TaskCommand
Enter config modeconfigure
Stage a changeset <path> <value>
Preview pending changesshow configuration | compare
Apply changescommit
Apply with auto-rollbackcommit confirmed <minutes>
Persist across rebootsave
Undo a settingdelete <path>
Restore previous configrollback 1 then commit