Command Reference Map
From each tacctl command family to its reference page and the task page that uses it · Checked against tacctl 0.2.25
This documentation explains how to do things. The flag-by-flag reference for every
command lives in the repository’s
CLI reference
and in man tacctl on the server. This table maps each command family to
both.
In the console or
tacctl shell,?andhelp <command>show the usage of any command. A command family with no arguments prints its usage too.
1. Command families
| Command family | What it covers | Reference (repo) | Task pages |
|---|---|---|---|
tacctl status, passwd, ssh, version, hash |
Top-level commands | Conventions and top-level commands | Getting Started, Connecting to Devices |
tacctl shell, completion, man |
The interactive shell, completion, the bash help key, the manual page, password cache | Shell, completion and manual page | Getting Started |
tacctl console |
The login console and its settings: system shell, password cache, colour, list length | Console commands | Getting Started, Superuser Daily Operations §10 |
tacctl user |
Users, passwords, scope membership, email addresses | User commands | Access Lifecycle |
tacctl group |
Groups, privilege levels, tiers, Junos classes | Group commands | Concepts |
tacctl scope |
Prefixes, shared secrets, break-glass accounts, per-scope settings (SNMP among them), the timing scale of a scope | Scope commands | Superuser Daily Operations §4.9, §8, Break Glass |
tacctl device |
Registry, clone and replace, notices, host keys, timing scale, SNMP settings and users, check and scan (with --sources), pull, diff, plan, apply (with --timing), enroll, onboard |
Device commands | Engineer Guide: Device Changes §2.5, §3.1, Connecting to Devices §7, Superuser Daily Operations §4.10 |
tacctl host |
Linux hosts: enroll, sync, check, move, unenroll | Host commands | Linux Host Operations |
tacctl breakglass |
Holding and releasing devices and hosts (the firewall for held addresses is tacctl config breakglass-firewall) |
Break-glass commands | Break Glass |
tacctl emergency |
Emergency lockdown, devices and enrolled hosts | Emergency commands | Emergency Lockdown |
tacctl log |
Authentication logs, failures, accounting, with filters by time, user, device and kind, and --json |
Maintenance commands | Day-to-Day Device Operations §1.4, Superuser Daily Operations §9, Audit and Compliance §1, Troubleshooting |
tacctl backup |
Snapshots, diff, restore, keep, unkeep, recover | Maintenance commands | Backups and Undo |
tacctl backend, store |
Backends and the store | Maintenance commands | Out of scope for this documentation |
tacctl config |
Settings (including the server’s timing scale, config devices timeout-scale, the SNMP defaults of config snmp and the break-glass firewall) and the device configuration walkthroughs |
Config commands, tacctl.yaml settings | Vendor Notes, Superuser Daily Operations §4.9, §4.10, Break Glass §2.1 |
tacctl server |
This server’s own settings: an overview, its console name, the address devices and hosts reach it at, listeners, the metrics exporter | Server commands | Superuser Daily Operations §11 |
| Exit codes, environment | — | Exit status and environment | Exit Codes |
2. Out of scope for this documentation
Installation, upgrades, backends, the store and server files are covered only in the repository (Backups and Undo §5 summarises going back to an earlier release):
| Topic | Reference (repo) |
|---|---|
| Install, upgrade, roll back | Installation and upgrades |
| Backends, store, RADIUS, metrics | Server |
| Scopes, tiers, command authorization, audit log in depth | Security |
See also: Quick Reference · Glossary ·
man tacctl