Tools

Tools

This page describes the tools in the sidebar under Tools, and the macros under Macros. Each tool opens in a tab of its own; clicking it again in the list while it shows closes it and goes back to the tab you were on. The search box (Ctrl+K) finds them by name too.

Tunnels

Port forwards over SSH that keep running while you work in other tabs. New tunnel draws the route step by step, from where it listens to where it arrives:

• Local: a port on this PC reaches a host behind the SSH server.
• Remote: a port on the SSH server reaches a host near this PC.
• Dynamic (SOCKS): a SOCKS proxy on this PC; traffic leaves through the SSH server.

Choose a saved SSH server from your sessions (its host, user, key file and jump hosts are filled in) or type the details. Then the Port on this PC or Port on the SSH server, where it Goes to, whether other computers may use the port, Start this tunnel when Cablebag starts, and a Name. Each tunnel card shows its state and open connections, with Start and Stop; Start all and Stop all are at the top. The sidebar shows how many tunnels are running.

The same page holds the WireGuard networks; see WireGuard per session.

Run on many servers

One command on every SSH session of a folder (or all SSH sessions), a few at a time, with the answers side by side. Also from a folder's right-click menu, Run a command on all its servers.

• Choose the Folder, type the Command or pick one of the Examples (Uptime and load, Disk space, Pending updates, Operating system, Failed services).
• As root, with sudo works only where sudo needs no password. At the same time sets how many servers run at once (up to 20).
• Untick servers to skip them. Each gets its own short connection; one that needs a typed password asks for it. A command stops after 60 seconds.
• The first line of each answer is in the table; click a row for the whole output. Copy all and Save keep the results.

It does exactly what you type on every chosen server; there is no undo.

Network scanner

Finds the computers that answer a ping or one of the common service ports in a range such as 192.168.1.0/24 or 192.168.1.10-50 (your own network is filled in). The table shows address, name, hardware address, ping time and open ports, with buttons to open SSH or Remote Desktop straight away and to copy the address.

Port scanner

Checks which TCP ports of one computer accept connections: the Well-known ports list or A range. Open ports are listed with what usually runs on them.

Open ports on this PC

Which programs on this PC listen for connections or are connected right now, with protocol, address, port and state. Filter by program or port; untick Only listening ports to see connections too.

Wake on LAN

Sends the wake-up packet a sleeping or switched-off computer listens for, if its network card allows it: Hardware (MAC) address, optionally a Broadcast address and Port. Remember keeps the computer in a list for next time. The network scanner shows the hardware addresses of computers on your own network.

SSH key generator

Creates a key pair, saves it and puts it on a server in one step. See Credential sources.

Macros

Macros type text into a terminal, with pauses and waits. The Macros section of the sidebar lists them; right-click one for Run in the active terminal, Run in all connected terminals, Edit, Duplicate and Delete. The search box (Ctrl+K) finds them too.

• Record one: right-click a terminal tab (or use the search box), Record a macro in this terminal, do what you want recorded, then Stop recording and save the macro.
• Save a command as one: select it in a terminal, right-click (Shift+right-click when right-click pastes, see Settings, Terminal) and choose Save the selected text as a macro. The prompt in front of it (user@host:~$, PS C:\>) is left out. The same menu has Copy, Paste and Run a macro....
• Edit one: Name, Hotkey, Show for (every session, or only the sessions in one folder, such as one customer's), and the steps: Type text, Pause, or Wait for text or a regular expression with a timeout. Halve all pauses and Double all pauses speed a recording up or slow it down.
• A macro with a hotkey is listed under Settings, Keyboard shortcuts.

Blanks

Write {{name}} in a text step for a blank, for example systemctl restart {{service}}. When the macro runs, Cablebag asks for every blank once, also when it runs in several terminals at once, and offers what you filled in last time (it forgets that when Cablebag closes, as an answer may be secret). Three blanks it fills in itself, from the terminal's session: {{host}}, {{user}} and {{session}} (the tab's name).

A blank starts with a letter and has no dots or quotes, so templates of other programs stay as they are: docker's {{.Names}} or a Jinja {{ item }} are typed as written.

Macros travel with Sync.