Updated
8-November-2000
|
|
Undocumented SSP
Command Line Switches
|
Dan Anderson,
SSP Software
|
Introduction
System Service Processor (SSP)
software provides booting and system administration functions for the
Enterprise 10000 (code name "Starfire") from a separate Sun workstation.
The following are switches for SSP commands
that are not documented in a man page
(directory /opt/SUNWssp/man/man1m/)
for SSP 3.3.
Several new and (undocumented) old options were added to the documentation for
SSP 3.2 and 3.3--so get the
latest SSP manuals!
Unless otherwise mentioned,
all commands here are available starting with SSP 3.0
(the first release of SSP for the Enterprise 10000).
(SSP 2.x was for the earlier-generation Cray
CS6400).
See
below for Notational Conventions.
Use caution with undocumented option flags!
In some cases, there's a good reason for not documenting them.
Please let me know of additions or SSP commands that aren't listed.
- Dan Anderson <danx@West>
[ A
| B
| C
| D
| E
| F
| G
| H
| I
| J
| M
| N
| O
| P
| R
| S
| T
| U
]
- A
-
addboard
[SSP 3.3]
No known command line option.
-
autoconfig [board_name]
No known undocumented command line option.
The optional board_name parameter is either
sysboardN or centerplaneN,
where N is 0 - 15 or 0 - 1, respectively.
- B
-
board_id
No known command line option.
- bringup
BJrs:fFLp:Q:gvCLA:l:D:X:
+ (args to obp_helper, netcon_server, & hpost)
- -B Internal use, send INFO-level messages to the domain log
(note: this is always enabled by default now).
- -J Jam requested bus config with minimal testing.
Passed to hpost.
- -s Boot into single-user mode (see the kernel(1M) man page)
- -S Disable netcon_session logging, if enabled
(see the
netcon_server(1M)
man page)
- -st: This specifies the offset from the current time to set
the domain's time. This is for the "Independent Time Domains"
feature
[Ref: RFE 4132886].
It has nothing to do with timezones, but was used back in the
late 1990s by some customers for Y2K verification.
The format is:
-stmmddhhMMyy or -stmmddhhMMccyy.
May this option be quickly forgotten :-)
- -r Reconfiguration boot (see the kernel(1M) man page)
- -rt resets (or undoes) the time offset set by -st
- devalias The devalias name to boot the domain to.
See the boot(1M) man page.
- If a secret1
environment variable
is set (to a secret value),
log a INFO level message when MIB item confMemAddrMap is reset.
Also used by hpost.
Don't use this unless you know what you are doing.
Not intended for customer use.
- Note: Additionally, all arguments for
netcon_server, hpost, and obp_helper
(not all apparently documented) are passed to the respective commands.
This requires command arguments among these commands to be unique,
or at least not conflict.
(Warning: getopt is not used by the bringup command, which helps
explain, but not excuse, the command's bizarre syntax :-()
- C
- cancelcmdsync
[SSP 3.4]
- cb_prom
ep:d:h:
No known command line option.
- cb_reset
vdp:
- -d debug mode--prints even more messages than -v (verbose).
- Signals: SIGALARM caught for timeouts
- cbs
f:mpsc
- -f Set the initial default maximum number of file descriptors
(min 10, default 512).
"This flag should remain undocumented."
SSP 3.2+ only.
- -m Memory allocation/deallocation and CBMP packet trace
- -p Protocol message trace
- -s Do not perform initial setup with cbe.
- -c Do not combine JTAG transactions.
- Signals:
SIGUSR1 caught to print the lock queue, and
SIGALARM caught for timeouts.
- check_host
qbBPvp:h:
- -b check for bringup (when in doubt assumes the host is UP)
- -B Verbose bringup
- -P check for edd's PowerFailRebootact when system boards are off.
Ignore unknown signature/state.
[BugID 4368475].
[SSP 3.4+]
- -v Internal messages
- -p ping host for 3 sec. to quickly decide if host is up
- -h SUNW_HOSTNAME
- codcheck
[COD 1.0]
No known undocumented command line option.
- codd
[COD 1.0]
No known undocumented command line option.
- codlit
[COD 1.0]
No known undocumented command line option.
- codlogrotate
[COD 1.0]
No man page. Rotates COD logs under $SSPLOGGER.
Usually called from cron via /var/spool/cron/crontabs/root.
- codsendlog
[COD 1.0]
No known undocumented command line option.
- cvcd [Solaris domain]
dp:r
- -r Override /etc/ssphostname
- -d debug output
(present only if compiled with -DDEBUG)
- -p specify the port to connect to
(present only if compiled with -DDEBUG)
- D
- datasyncd
[SSP 3.4]
-
deleteboard
[SSP 3.3]
No known command line option.
- domain_create
fh?d:b:o:p:t:q*
- -q Quiet
- -f Force the operation, even if domain_config locked by FAD
(SSP 3.3+ only)
- -h Display usage information (help)
- -? Display usage information (help)
- -* Display usage information (help)
- -o Although not documented, domain_create translates 2.y[.z]
to 5.y[.z] and x.y[.z] to 5.x.y[.z] where x is >= 7.
-
domain_history
d:r
- domain_link
vIRE?
[SSP 3.2]
- -v Enable verbose debug output in libidn.
- -I Display a domain's IDN status.
(Tip: the 1st field displayed, the domain state, is be one of:
ERROR, NOTSUPPORTED, DOWN, ARBSTOP, BUSY, READY, or UP.
The 4th number displayed is the boot processor number
of the IDN's master domain.
E.g., for "UP:ACTIVE:0:3:1:4. . .", the master domain's
boot processor is 4.)
[see this page for more details]
- -R Will display SMD (Shared Memory Domain)
register contents for a IDN domain.
(tip: "redx -x "shgaa 0" also does this).
- -E Supposedly enables use of other flags designated
"privileged op", but only real effect is to give a fuller
usage message with "domain_link -E -?")
- -? Display usage information (help)
Use "domain_link -E -?" for a full usage message.
- Warning: SUNW_HOSTNAME must be set to a domain running Solaris 7+
- domain_remove
fh?d:qyn
- -q Quiet
- -y Remove directories
- -n Don't remove directories
- -f Force the operation, even if domain_config locked by FAD
(SSP 3.3+ only)
- -h Display usage information (help)
- -? Display usage information (help)
- domain_rename
fqh?d:n:o:
- -f Force the operation, even if domain_config locked by FAD
(SSP 3.3+ only)
- -q Quiet
- -h Display usage information (help)
- -? Display usage information (help)
- -o Although not documented, domain_rename translates 2.y[.z]
to 5.y[.z] and x.y[.z] to 5.x.y[.z] where x is >= 7.
-
domain_status
h?
- -h Display usage information (help)
- -? Display usage information (help)
-
domain_switch
No known undocumented command line option
(it's just a csh alias).
- domain_unlink
?vfFkEBCX:d:
[SSP 3.2]
- -? Display usage information (help).
Use "domain_unlink -E -?" for a full usage message.
- -v Enable verbose debug output in libidn.
Used during a "bringup -v"
Multiple v's give even more verbosity (e.g., "-vvv")
- -k kill (not enabled)
- -E Enables use of other flags designated "privileged op"
(used during a bringup).
Also gives a fuller usage message with
"domain_unlink -E -?"
- -B Bypass acquiring the SSP bringup_dr.lock lock
(used during a bringup).
- -C Used during a "bringup -C"
- -XM means don't update MIB.
MIB update not wanted until all hardware is cleaned up
(used during a bringup).
- -XW means don't wait for
idn_reg, idn_run, and bringup_dr.lock locks
(used during a bringup).
- -d (Privileged op)
- Warning: SUNW_HOSTNAME must be set to a domain running Solaris 7+
- download_helper
No man page. No command line options.
Called by obp_helper to download OpenBoot.
- E
- edd
acd
- -c cbs should not be contacted (EDDApp.cc)
- Signals:
SIGHUP to re-read its configuration, and
SIGUSR2 to generate an event for unit testing only.
- edd_cmd
ehx:
+ (args passed on to edd)
No known undocumented command line option.
- /usr/platform/SUNW,Ultra-Enterprise-10000/eeprom [Solaris domain]
- F
-
fad
No known command line option.
- fan
l:t:p:s:q
- -q quiet (suppress output)
- G
- genkey
p:d:s:h:n
[(1m-mfg) Internal SSP command for R & D]
- H
- hostinfo
FShptV
- -V Internal debug message(s)
-
hostint
No known command line option.
- hostview
v:t:p:
- -v Debug Verbosity level
(0=everything, 5="default", 10=mib members error output)
(gDebugThreshold).
You must have a space after "-v"
(e.g., "-v 0" or "-v default").
- -t -t off or -t on disables traps.
- -p Sets the MIB refresh frequency (gMibRefreshFreq)
You must have a space after "-p" (e.g., "-p 60").
Default is 300 seconds.
- hostreset
dp:
- -d debug messages (present only if -DDEBUG on compile)
- -p Processor number
-
hpost
- If a secret1
environment variable is set (to a secret value),
take some internal actions and bypass some checking.
Not intended for customer use.
- I
- ict_create
[(1m-mfg) Internal SSP command for R & D]
- ict_test
[(1m-mfg) Internal SSP command for R & D]
- initcmdsync
[SSP 3.4]
- J
- Javahelp
[SSP 3.5]
Access to online help via Java (JDK).
- M
- machine_server m
No known undocumented command line option.
-
moveboard
[SSP 3.3]
No known command line option.
- N
- nets_create
[(1m-mfg) Internal SSP command for R & D]
- netcon (aka cvc)
de:fglM:
- -d Debug output
- -M Shared Memory ID
(used when running under netcontool (aka cvctool))
- netcon_server (aka cvc_server)
drp:S
- -d Debug output (option disabled in source)
- If environment variable $NETCON_DEBUG is set (to a secret value),
don't put netcon_server in the background.
- Signals:
SIGUSR1 when a new bootproc is configured.
- netcontool (aka cvctool)
b:c:
- -b (option parsed, but is ignored)
- -c Background Color (used in -bg option in spawning a terminal)
- newssplog
No man page. Rotates SSP logs under $SSPLOGGER.
Usually called from cron via /var/spool/cron/crontabs/root.
- O
- obp_helper
HeiqrvxA:D:d:m:o:
- -x sys_reset: Call cbs_reset_system
- -vv Log even more verbose messages than -v
(most of these are at the NOTICE syslog level)
- -H dr_debut:
Load and start download_helper on all valid processors.
Don't put obp_helper in the background.
[ADR internal use only]
- If environment variable $OBP_DEBUG is set (to a secret value),
don't put obp_helper in the background.
- P
- post See hpost
- post_os_upgrade
This is command with no man page.
It is used after upgrading SSP from
Solaris 2.5.1 or earlier to Solaris 2.6 or later (with SEA snmpdx).
It modifies configuration files so SSP snmpd will use different
(non-standard) UDP ports than used by SEA's snmpdx.
- power
c:p:m:fqvdBo:a:s:k
(Warning:
getopt() isn't used by the power command, which helps explain,
but not excuse, the
command's bizarre syntax)
No known undocumented command line option.
- R
- rcfgadm
[SSP 3.5]
NGDR command to retrieve staus information.
- /usr/platform/SUNW,Ultra-Enterprise-10000/prtdiag [Solaris domain]
- redx
nlq?x:
redx command line options are documented, but
redx internal commands
are not documented (except in the redx binary).
See my page
"Redx commands"
for a description of these undocumented commands.
- E.g., redx -x seterr -f mc 0 0x7ff
forces an arbstop on board 0.
- If a secret1
environment variable is set (to a secret value),
take some internal actions and bypass some checking.
Don't use this unless you know what you are doing.
Not intended for customer use.
- resetMessaging
No known command line option.
Called by machine_server to restart syslogd after machine_server
starts. This ensures syslogd is forwarding SSP messages to
machine_server.
Can also be invoked directly if no messages are appearing
in the ssp logs under $SSPLOGGER.
- runcmdsync
[SSP 3.4]
- runif
[(1m-mfg) Internal SSP command for R & D]
- S
- savecmdsync
[SSP 3.4]
- scotty
c:f:nI
A scripting language with SSP enhancements.
Based on tcl.
Many SSP commands are implemented with scotty scripts.
Can be used directly, although it's not supported for end use.
- setdatasync
[SSP 3.4]
- setfailover
hr
[SSP 3.4]
- -h Display usage information (help)
- set_ddr_brd_st
[SSP 3.4]
For use by ssp_startup only.
Initializes board states in the ssp_resource file for
"turbo" DR operations.
- showcmdsync
[SSP 3.4]
- showdatasync
[SSP 3.4]
- showdevices
[SSP 3.5]
NGDR: display information about a domain's devices
- showfailover
hr
[SSP 3.4]
- -h Display usage information (help)
- showusage
hb:r:s
[SSP 3.3]
- -h Display usage information (help)
- sigbcmd
IBRSvifsrt:p:P:
- -I Issue a "PC Vector Interrupt" to a processor
(not enabled for all versions of Solaris domains).
- -B Output the processor's signature block. Requires -P.
- -R Output the processor's reset info. Requires -P.
- -S Zero-out a processor's signature block. Requires -P.
Note: -S is used by domain_create to zero-out bbsram on the newly-created
domain.
Resetting any one of the procs is good enough for the whole domain.
- -P Processor list when used with the B or R option
in bd.procG format (bd=0-15, proc=0-3)
separated by a dash (-).
The processor ID (0-63) when used with the S option.
E.g., sigbcmd -B -P2.0G-1.0G
E.g., sigbcmd -S -P20
- E.g., sigbcmd -i -p4 panic forces a panic on proc 4.
- snmpd hp:Xns:t:?
- -s Set SSP Secondary SNMP UDP port to n
(default 161)
SSP 3.2 and above only.
- -n Do not enable trap handling (for debugging use only)
SSP 3.2 and above only.
- -h or ? Print a usage (help) message and exit.
- A SIGUSR1 signal generates a statistics file
/var/tmp/snmpd/snmpd.stats. Use:
kill -USR1 `cat $SSPVAR/pids/snmpd-*.pid | cut -f1 -d' '`
- Signals:
SIGUSR1 to generate usage statistics
- /etc/init.d/ssp [start | stop]
[SSP 3.1.1]
Normally called from the /etc/rc*.d/[KS]*ssp
startup/shutdown scripts.
- /etc/init.d/ssp start calls ssp_startup
- /etc/init.d/ssp stop calls ssp_terminate
- /etc/init.d/sysidssp
[SSP 3.1.1]
Normally called from
/etc/rc2.d/S72sysidssp
at startup.
"/etc/init.d/sysidssp start"
calls "ssp_config sysidssp"
- /etc/init.d/ssp start calls ssp_startup
- /etc/init.d/ssp stop calls ssp_terminate
- ssp_backup
[SSP 3.1.1]
ssp_backup backs up the SSP configuration files (only).
Usage: ssp_backup <target-directory>
Backs up the SSP configuration to file
<target-directory>/ssp_backup.cpio
Gotcha (user-hostile feature):
specify a directory, not a file (unlike ssp_restore).
- ssp_config
[ spare | cb | float | main | cpu | sysidssp | prom | enable_tftp | disable_tftp | configure_floatip | deconfig_floatip]
- ssp_config spare - Option removed in SSP 3.4
- ssp_config main - configure a SSP that's currently the main.
same as specifying no option. Option removed in SSP 3.4
- ssp_config cpu - configure processors [SSP 3.4]
- ssp_config sysidssp - configure sysid [SSP 3.4]
(same as "ssp_config main" except nothing is started;
called from /etc/rc2.d/S72sysidssp) [SSP 3.4].
- ssp_config prom - check the control board PROM revision
[SSP 3.4].
- ssp_config subcommands enable_tftp, disable_tftp,
configure_floatip, and deconfig_floatip
are private and are used only in the ssp_startup scripts
[SSP 3.4].
- ssp_downgrade
[SSP 3.3]
No known command line option.
-
ssp_install
[SSP 3.1.1]
This command has no man page!
See my
substitute man page instead.
[Ref: RFE 4304974].
To use, type ssp_install <package directory>
where <package directory> is the directory containing
the SSP packages.
- ssp_restore
[SSP 3.1.1]
This command now has a man page (starting with SSP 3.2).
ssp_restore restores the SSP configuration files backed-up
with ssp_backup. Usage: ssp_backup <backup file>
- /etc/opt/SUNWssp/ssp_startup.sh
This command has one optional argument:
<Server monitor time interval, in seconds>
It is usually called from and set in /etc/init.d/ssp.
The default, if an argument isn't specified, is 30 seconds.
-
ssp_unconfig
[SSP 3.3]
No known command line option.
-
ssp_upgrade
[SSP 3.1]
This command has no man page!
See my
substitute man page instead.
[Ref: RFE 4304974].
To use, type ssp_upgrade <package directory>
where <package directory> is the directory containing
the SSP packages.
- sys_clock
mi:p:s
No known undocumented command line option.
-
sys_id
No known undocumented command line option.
(see man page updates)
- sys_reset
fFA
- -A Reset all boards (platformReset MIB item)
- Note: this command is not needed (it's a carryover from CS6400).
All it does is refresh the sysBrdGenTable MIB items.
It is being removed from the man pages for SSP 3.4.
-
straps
No known command line option.
- T
-
thermcal.
No known command line option.
- thermcal_config
ub:z:m
- -m Don't control EDD's temperature monitoring. This option
is useful when monitoring hasn't been initiated yet.
- "thermcal_config -b 1" is the same as
"thermcal_config -b sb"
- "thermcal_config -b 4" is the same as
"thermcal_config -b csb"
- The controlboard (2) or centerplane board (3)
cannot be calibrated.
- U
- upload
TP:
[(1m-mfg) Internal SSP command for R & D]
- "upload -t" displays output from CBE
(see CBE Debugging),
if the Sun port A is connected to the CBE port 0 serial port.
_________
1
$SUNW_INTERNAL.
Not for customer use--may harm customer systems.
I use the
getopt(3c)
"optstring parameter" syntax to specify command line parameters.
That is, I list all valid flags in a string.
Each flag that's followed with a parameter has a colon after it.
To quote the
getopt(3c)
man page:
optstring must contain the option letters the command using getopt()
will recognize; if a letter is followed by a colon,
the option is expected to have an argument, or group of arguments,
which may be separated from it by white space.
I list undocumented flags in bold after the command name,
in getopt(3c) format..
For example,
"netcon de:fglM:"
means the d and M switches are undocumented.
It also means that both the e and M options are followed
with a parameter, as in "netcon -e %"
Each undocumented command line option is explained below the command.
Notes on searching SSP source code for arguments
Here's some things to look for when searching for SSP source code that
accesses command line options:
- C source (*.c): getopt(3C) and argv.
- C++ source (*.cc):
registerApplicationCommandLineFlags(), addCommandLineFlag(),
and argv.
- sh scripts: $* or $#
(SSP sh scripts (unfortunately)
parse options by hand instead of using getopts(1))
- tcl/scotty scripts: args or CLA_Parse Args (from library/CLA_Parse.tcl)
SSP Source
SSP source code is located here:
Locally (San Diego):
SSP 3.0,
SSP 3.1,
SSP 3.1.1,
SSP 3.2,
SSP 3.3,
SSP 3.4,
SSP 3.5,
COD 1.0,
COD 1.1
Elsewhere (outside San Diego):
SSP 3.0,
SSP 3.1,
SSP 3.1.1,
SSP 3.2,
SSP 3.3,
SSP 3.4,
SSP 3.5,
COD 1.0,
COD 1.1
http://esp.West/~danx/options.html
Sun
Proprietary/Confidential: Internal Use Only
Feedback
to Daniel.Anderson@West