SAT Command Cheat Sheet
The SAT (System Administration Terminal) in Avaya Aura Communication Manager is the core command‑line interface (CLI) used to administer, configure, and troubleshoot Communication Manager. It is where administrators run operational commands such as adding stations, adjusting trunk groups, viewing signaling status, and monitoring system health.
Accessing SAT:
From the Linux CLI on the Communication Manager server, use one of the following commands:
| sat | Launch a standard SAT session |
| dsat | Launch an alternate SAT session |
| autosat | Launch an automated SAT session |
| logoff | Cleanly closes the terminal session |
| exit | Terminates the terminal session |
SAT Command Syntax:
Each command consists of: [Action] + [Object] + [Qualifier(s)]
Example: test station 1000 long
- test = action,
- station = object,
- 1000 = required qualifier,
- long = optional qualifier
You can abbreviate commands, just type enough letters to be unique. Example: t al l c = test alarms long clear
Concurrency Limits:
- Simultaneous loginsUp to 21
- Concurrent maintenance commandsUp to 5
- Concurrent administration commandsUp to 10
Commands:
| Station Commands |
|---|
| add station <ext> | Add a new station |
| display station <ext> | View station configuration |
| change station <ext> | Modify station configuration |
| remove station <ext> | Remove a station |
| list station | List all stations |
| list station <ext> count <n> | List stations starting at extension |
| status station <ext> | Show real-time status of a station |
| test station <ext> short | Run short test on station |
| test station <ext> long | Run long test on station |
| busyout station <ext> | Busyout a station |
| release station <ext> | Release a busied-out station |
| reset station <ext> | Reset a station |
| Trunk Group Commands |
|---|
| add trunk-group <n> | Add a new trunk group |
| display trunk-group <n> | View trunk group configuration |
| change trunk-group <n> | Modify trunk group |
| remove trunk-group <n> | Remove a trunk group |
| list trunk-group | List all trunk groups |
| status trunk-group <n> | Show trunk group status |
| test trunk <n>/<m> short | Short test on trunk member |
| test trunk <n>/<m> long | Long test on trunk member |
| busyout trunk <n>/<m> | Busyout a specific trunk member |
| release trunk <n>/<m> | Release a busied-out trunk |
| busyout trunk-group <n> | Busyout entire trunk group |
| release trunk-group <n> | Release entire trunk group |
| Signaling Group Commands |
|---|
| add signaling-group <n> | Add a signaling group |
| display signaling-group <n> | View signaling group |
| change signaling-group <n> | Modify signaling group |
| remove signaling-group <n> | Remove signaling group |
| status signaling-group <n> | Show signaling group status |
| busyout signaling-group <n> | Busyout signaling group |
| release signaling-group <n> | Release signaling group |
| Hunt Group Commands |
|---|
| add hunt-group <n> | Add a hunt group |
| display hunt-group <n> | View hunt group configuration |
| change hunt-group <n> | Modify hunt group |
| remove hunt-group <n> | Remove hunt group |
| list hunt-group | List all hunt groups |
| status hunt-group <n> | Show hunt group status |
| Media Gateway Commands |
|---|
| add media-gateway <n> | Add a media gateway |
| display media-gateway <n> | View media gateway configuration |
| change media-gateway <n> | Modify media gateway |
| remove media-gateway <n> | Remove a media gateway |
| list media-gateway | List all media gateways |
| status media-gateway <n> | Show media gateway status |
| test media-gateway <n> | Test a media gateway |
| reset media-gateway <n> | Reset a media gateway |
| Circuit Pack / Board Commands |
|---|
| display circuit-packs | Display all circuit packs |
| list configuration all | List all hardware configuration |
| test board short | Short test on a board |
| test board long | Long test on a board |
| busyout board | Busyout a circuit pack |
| release board | Release a circuit pack |
| reset board | Reset a circuit pack |
| display port | Display port information |
| test port | Test a specific port |
| Port location format: | <cabinet><carrier><slot><port> (eg, 01A0513) |
| - or - | <gateway>V<module><port> (eg, 005V90613) |
| IP Network Region Commands |
|---|
| display ip-network-region <n> | View network region |
| change ip-network-region <n> | Modify network region |
| status ip-network-region <n> | Show network region status |
| list ip-network-region | List all network regions |
| IP Codec Set Commands |
|---|
| display ip-codec-set <n> | View codec set |
| change ip-codec-set <n> | Modify codec set |
| list ip-codec-set | List all codec sets |
| Route Pattern & Dial Plan Commands |
|---|
| display route-pattern <n> | View route pattern |
| change route-pattern <n> | Modify route pattern |
| display dialplan analysis | View dial plan analysis table |
| change dialplan analysis | Modify dial plan analysis |
| display ars analysis | View ARS routing |
| change ars analysis | Modify ARS routing |
| display aar analysis | View AAR routing |
| change aar analysis | Modify AAR routing |
| Coverage Path Commands |
|---|
| add coverage path <n> | Add a coverage path |
| display coverage path <n> | View coverage path |
| change coverage path <n> | Modify coverage path |
| remove coverage path <n> | Remove coverage path |
| Alarm & Error Commands |
|---|
| display alarms | Display all active alarms |
| display errors | Display error log |
| test alarms long | Run long alarm test |
| test alarms long clear | Run long alarm test and clear passing alarms |
| clear alarms | Clear alarms |
| display events | Display system events |
| System Status & Monitoring Commands |
|---|
| status system | Overall system status |
| status port-network <n> | Port network status |
| status processor | Processor/server status |
| status health | System health summary |
| status server | Server status |
| list measurements | List measurement types |
| list trace station <ext> | Trace calls on a station |
| list trace tac | Trace calls on a TAC |
| monitor system | Real-time system monitoring |
| monitor traffic trunk-group | Monitor trunk group traffic |
| status station <ext> | Station registration/call status |
| System Administration Commands |
|---|
| display system-parameters customer-options | View licensed features |
| change system-parameters customer-options | Modify licensed features |
| display system-parameters features | View feature parameters |
| change system-parameters features | Modify feature parameters |
| display node-names ip | View node name to IP mappings |
| change node-names ip | Modify node name mappings |
| save translation | Save all translations to disk |
| display time | Display system time |
| set time | Set system time |
| Feature Access Code Commands |
|---|
| display feature-access-codes | View all FACs |
| change feature-access-codes | Modify FACs |
| Class of Restriction / Service |
|---|
| display cor <n> | View Class of Restriction |
| change cor <n> | Modify Class of Restriction |
| display cos <n> | View Class of Service |
| change cos <n> | Modify Class of Service |
| SSH Key Management |
|---|
| reset ssh-keys board | Reset SSH keys on a circuit pack (must busyout first)
Applicable to TN799DP (C-LAN), TN2501AP (VAL), TN2602AP (Crossfire)
|
Busyout & Release Rules
The busyout command:
- Removes the object from active service
- Drops services/links dependent on the component
- Prevents scheduled/periodic background tests
- Demand maintenance tests can still run
The release command:
- Returns the object to in-service state
- Restores normal call processing
| Useful Linux CLI Commands (on CM Server) |
|---|
| sat | Launch SAT session |
| dsat | Launch alternate SAT session |
| server | Display active/standby server status |
| server -i | Interchange active/standby servers |
| swversion | Display CM software version |
| swversion -v | Display version string only |
| save_trans | Save translations (same as save translation on SAT) |
| statapp | Display application status |
| systat | Display running processes |
| systat -b | Brief application status |
| start -a | Start all applications |
| stop -acfn | Stop all applications gracefully |
| testinads | Test connectivity to INADS |
| testcustalm | Generate test SNMP alarm trap |
| testled | Test server LEDs |
| tlscertmanage -l | List all CA certificates |
QUICK REFERENCE: Common Workflows
- Add a New Station:
- add station <ext> → Fill in Type, Port, Name, COR, COS → Submit
- Troubleshoot a Down Station:
- status station <ext>
- test station <ext> long
- display errors → look for station-related errors
- Troubleshoot a Down Trunk:
- status trunk-group <n>
- status signaling-group <n>
- test trunk <n>/<m> long
- display errors → look for trunk-related errors
- Save Your Work:
- save translation (SAT)
- - or -
- save_trans (Linux CLI)
- Check System Health:
- status system
- status health
- display alarms
Tip: Press the HELP key at any point in the SAT to display available commands and valid qualifiers for your current context.