Submit comments about this document by clicking the Feedback[+] link at: http://docs.sun.com
Copyright 2007-2009Sun Microsystems,Inc., 4150 Network Circle, SantaClara, California95054, U.S.A. and FUJITSU LIMITED,1-1,
Kamikodanaka 4-chome,Nakahara-ku, Kawasaki-shi, Kanagawa-ken 211-8588,Japan. All rights reserved.
Sun Microsystems, Inc.and Fujitsu Limited each ownor controlintellectual propertyrights relating to products and technology describedin
this document,and such products, technology and this documentare protectedby copyright laws, patents andother intellectualproperty laws
and internationaltreaties. Theintellectual propertyrights of SunMicrosystems, Inc.and Fujitsu Limited in suchproducts, technologyand this
document include,without limitation, one or more ofthe United States patents listedat http://www.sun.com/patentsand one or more
additional patentsor patent applications in theUnited Statesor other countries.
This documentand the product and technology to whichit pertains are distributed under licenses restrictingtheir use,copying, distribution,
and decompilation.No part of such product ortechnology, orof this document, may bereproduced inany formby any meanswithout prior
written authorizationof Fujitsu Limited and SunMicrosystems, Inc.,and their applicable licensors, ifany. Thefurnishing of this document to
you doesnot give you any rightsor licenses, express or implied, with respect tothe productor technology to which itpertains, and this
document doesnot contain or representany commitment ofany kindon the part of FujitsuLimited or Sun Microsystems, Inc.,or anyaffiliate of
either ofthem.
This documentand the product and technology described inthis document may incorporate third-party intellectualproperty copyrightedby
and/or licensedfrom suppliersto Fujitsu Limited and/or SunMicrosystems, Inc.,including software and font technology.
Per theterms of the GPL orLGPL, a copy of thesource codegoverned by the GPL orLGPL, as applicable, is availableupon requestby the End
User.Please contactFujitsu Limited orSun Microsystems,Inc.
This distributionmay include materials developed bythird parties.
Parts ofthe productmay be derived from BerkeleyBSD systems,licensed from the University ofCalifornia. UNIXis a registered trademark in
the U.S.and in other countries, exclusivelylicensed throughX/Open Company, Ltd.
Sun, SunMicrosystems, theSun logo, Java, Netra, Solaris,Sun Ray, Answerbook2, docs.sun.com, OpenBoot, andSun Fireare trademarks or
registered trademarks of SunMicrosystems, Inc.in the U.S. and othercountries.
Fujitsu andthe Fujitsu logo are registered trademarks of Fujitsu Limited.
All SPARC trademarks are used under license andare registered trademarksof SPARC International, Inc.in theU.S. and othercountries.
Products bearing SPARC trademarksare basedupon architecturedeveloped by Sun Microsystems, Inc.
SPARC64 isa trademarkof SPARC International, Inc.,used under license by FujitsuMicroelectronics, Inc.and Fujitsu Limited.
The OPENLOOK and Sun™ Graphical UserInterface was developed by SunMicrosystems, Inc.for its users and licensees.Sun acknowledges
the pioneeringefforts ofXerox inresearching anddeveloping the concept of visualor graphical user interfaces forthe computer industry.Sun
holds anon-exclusive license from Xeroxto the Xerox GraphicalUser Interface,which license alsocovers Sun’slicensees who implement OPEN
LOOK GUIsand otherwise comply with Sun’swritten license agreements.
United StatesGovernment Rights - Commercial use. U.S. Governmentusers aresubject to the standard governmentuser licenseagreements of
Sun Microsystems, Inc.and Fujitsu Limited and theapplicable provisionsof the FAR andits supplements.
Disclaimer: Theonly warranties granted by FujitsuLimited, Sun Microsystems, Inc. or any affiliate ofeither of them in connectionwith this
document orany productor technology described herein are those expressly set forth in thelicense agreementpursuant to which the product or
technology isprovided. EXCEPTAS EXPRESSLY SET FORTH INSUCH AGREEMENT, FUJITSU LIMITED,SUN MICROSYSTEMS, INC.
AND THEIRAFFILIATESMAKE NO REPRESENTATIONSOR WARRANTIES OF ANYKIND (EXPRESS OR IMPLIED) REGARDINGSUCH
PRODUCT ORTECHNOLOGY OR THIS DOCUMENT,WHICH AREALL PROVIDED AS IS, ANDALL EXPRESS OR IMPLIED
CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDINGWITHOUT LIMITATION ANYIMPLIED WARRANTY OF
MERCHANTABILITY, FITNESSFOR A PARTICULARPURPOSE ORNON-INFRINGEMENT, ARE DISCLAIMED, EXCEPTTO THE
EXTENT THAT SUCH DISCLAIMERS ARE HELDTO BELEGALLYINVALID.Unless otherwise expressly set forth in suchagreement, tothe
extent allowedby applicablelaw,in no event shall FujitsuLimited, SunMicrosystems, Inc.or any of their affiliates haveany liabilityto any third
party underany legal theory for anyloss ofrevenues or profits, loss of use ordata, or business interruptions, orfor any indirect, special,
incidental orconsequential damages, even if advisedof the possibility of suchdamages.
DOCUMENTATION IS PROVIDED “AS IS”AND ALL EXPRESS OR IMPLIEDCONDITIONS, REPRESENTATIONS ANDWARRANTIES,
INCLUDING ANYIMPLIED WARRANTY OF MERCHANTABILITY,FITNESS FORA PARTICULAR PURPOSE OR NON-INFRINGEMENT,
ARE DISCLAIMED,EXCEPT TOTHE EXTENT THAT SUCHDISCLAIMERS AREHELD TO BE LEGALLY INVALID.
Copyright 2007-2009Sun Microsystems,Inc., 4150 Network Circle, SantaClara, California95054, U.S.A. et FUJITSU LIMITED,1-1,
Kamikodanaka 4-chome,Nakahara-ku, Kawasaki-shi, Kanagawa-ken 211-8588,Japon. Tous droits réservés.
Sun Microsystems, Inc.et Fujitsu Limited détiennent etcontrôlent toutes deux des droits depropriété intellectuellerelatifs auxproduits et
technologies décritsdans ce document. De même,ces produits,technologies et ce document sontprotégés pardes lois sur le copyright,des
brevets, d’autres lois surla propriétéintellectuelle et des traités internationaux.Les droitsde propriétéintellectuelle de SunMicrosystems, Inc.
et FujitsuLimited concernant ces produits, ces technologies etce document comprennent, sans que cette listesoit exhaustive, un ou plusieurs
des brevets déposésaux États-Unis et indiqués àl’adresse http://www.sun.com/patents de même qu’un ouplusieurs brevetsou applications
brevetées supplémentaires aux États-Uniset dansd’autres pays.
Ce document,le produitet les technologies afférents sont exclusivement distribuésavec des licences qui enrestreignent l’utilisation,la copie,la
distribution etla décompilation. Aucune partie dece produit,de ces technologies ou dece document ne peut être reproduite sousquelque
forme quece soit, par quelque moyenque ce soit, sans l’autorisationécrite préalablede Fujitsu Limitedet deSun Microsystems, Inc., et deleurs
éventuels bailleursde licence. Ce document, bienqu’il vousait été fourni,ne vousconfère aucun droit et aucune licence, expressesou tacites,
concernant leproduit oula technologie auxquels il serapporte. Par ailleurs, il necontient ni ne représente aucun engagement, dequelque type
que cesoit, de la part deFujitsu Limited ou de SunMicrosystems, Inc.,ou des sociétés affiliées.
Please
Recycle
Ce document,et le produit et les technologies qu’ildécrit, peuvent inclure des droits de propriété intellectuellede parties tierces protégéspar
copyright et/oucédés sous licence par desfournisseurs àFujitsu Limited et/ouSun Microsystems,Inc., y compris des logicielset des
technologies relatives auxpolices de caractères.
Cette distributionpeut comprendredes composantsdéveloppés par destierces parties.
Des partiesde ce produit pourrontêtre dérivées des systèmes BerkeleyBSD licenciés par l’Université deCalifornie. UNIXest une marque
déposée auxEtats-Unis et dans d’autres pays et licenciéeexclusivement par X/Open Company, Ltd.
Sun, SunMicrosystems, lelogo Sun, Java, Netra, Solaris,Sun Ray, Answerbook2, docs.sun.com, OpenBoot, etSun Firesont des marques de
fabrique oudes marquesdéposées de Sun Microsystems, Inc.aux Etats-Uniset dans d’autres pays.
Fujitsu etle logo Fujitsu sont desmarques déposéesde Fujitsu Limited.
Toutes lesmarques SPARC sont utilisées sous licenceet sont des marques de fabrique oudes marquesdéposées de SPARC International, Inc.
aux Etats-Uniset dans d’autres pays. Les produits portantles marquesSPARCsont basés sur une architecture développée par Sun
Microsystems, Inc.
SPARC64 estune marquesdéposée de SPARC International, Inc., utiliséesous le permis par FujitsuMicroelectronics, Inc.et FujitsuLimited.
L’interfaced’utilisation graphiqueOPEN LOOK et Sun™ aété développée par Sun Microsystems,Inc. pourses utilisateurs etlicenciés. Sun
reconnaît les efforts depionniers deXerox pour la recherche et le développementdu conceptdes interfaces d’utilisationvisuelle ougraphique
pour l’industriede l’informatique. Sun détient unelicense non exclusive de Xerox surl’interface d’utilisation graphique Xerox, cette licence
couvrant égalementles licenciésde Sun qui mettent enplace l’interfaced’utilisation graphique OPEN LOOK etqui, enoutre, se conforment aux
licences écritesde Sun.
Droits du gouvernement américain- logiciel commercial. Les utilisateursdu gouvernementaméricain sont soumis aux contratsde licence
standard de Sun Microsystems,Inc. etde Fujitsu Limitedainsi qu’auxclauses applicables stipulées dans leFAR et ses suppléments.
Avis denon-responsabilité: lesseules garanties octroyées par Fujitsu Limited, SunMicrosystems, Inc.ou toute sociétéaffiliée del’une ou l’autre
entité enrapport avec ce document outout produitou toute technologie décrit(e) dansles présentes correspondent aux garanties expressément
stipulées dansle contrat de licence régissantle produitou la technologie fourni(e). SAUFMENTION CONTRAIRE EXPRESSÉMENT
STIPULÉE DANSCE CONTRAT, FUJITSULIMITED, SUN MICROSYSTEMS, INC. ETLES SOCIÉTÉSAFFILIÉES REJETTENT TOUTE
REPRÉSENTATION OU TOUTE GARANTIE, QUELLE QU’EN SOITLA NATURE (EXPRESSEOU IMPLICITE)CONCERNANT CE
PRODUIT,CETTE TECHNOLOGIEOU CE DOCUMENT, LESQUELS SONT FOURNIS ENL’ÉTAT. ENOUTRE, TOUTESLES CONDITIONS,
REPRÉSENTATIONS ET GARANTIES EXPRESSES OUTACITES,Y COMPRIS NOTAMMENT TOUTE GARANTIEIMPLICITE RELATIVE À
LA QUALITÉMARCHANDE, À L’APTITUDE À UNE UTILISATION PARTICULIÈREOU À L’ABSENCE DECONTREFAÇON,SONT
EXCLUES, DANSLA MESUREAUTORISÉE PAR LA LOI APPLICABLE. Saufmention contraireexpressément stipuléedans cecontrat, dans la
mesure autorisée par laloi applicable, en aucun casFujitsu Limited, Sun Microsystems, Inc. ou l’unede leurs filiales ne sauraientêtre tenues
responsables envers une quelconquepartie tierce,sous quelque théoriejuridique quece soit, de tout manqueà gagner ou de pertede profit,de
problèmes d’utilisation ou deperte de données, ou d’interruptionsd’activités, ou de tout dommageindirect, spécial,secondaire ouconsécutif,
même sices entités ont été préalablementinformées d’unetelle éventualité.
LA DOCUMENTATION EST FOURNIE “ENL’ETAT” ETTOUTES AUTRESCONDITIONS, DECLARATIONS ET GARANTIESEXPRESSES
OU TACITES SONT FORMELLEMENT EXCLUES, DANSLA MESURE AUTORISEE PAR LA LOIAPPLICABLE, YCOMPRIS NOTAMMENT
TOUTE GARANTIE IMPLICITE RELATIVE A LAQUALITE MARCHANDE,A L’APTITUDE AUNE UTILISATION PARTICULIERE OU A
L’ABSENCEDE CONTREFACON.
viiiSPARC Enterprise Mx000 Servers XSCF Reference Manual • August 2009
testsb 469
traceroute 475
unlockmaintenance 479
version 481
viewaudit 485
who 493
Contentsix
xSPARC Enterprise Mx000 Servers XSCF Reference Manual • August 2009
Preface
This manual contains the man pages for the eXtended System Control Facility
(XSCF) firmware for Sun SPARC Enterprise™ M3000/M4000/M5000/M8000/M9000
servers.
Overview of Man Page Structure
The following table describes the sections included in man pages. The man pages of
each manual section generally follow this order, but include only needed headings.
For example, if there are no examples, there is no EXAMPLES section. Refer to the
Intro page for a description of each man page, and man(1) for more information
about man pages in general.
NAMEThis section gives the names of the commands
or functions documented, followed by a brief
description of what they do.
SYNOPSISThis section shows the syntax of commands or
functions. Options and arguments are
alphabetized, with single-letter arguments first,
and options with arguments next, unless a
different argument order is required.
The following special characters are used in this
section:
[]Brackets. The option or argument
enclosed in these brackets is optional. If
the brackets are omitted, the argument
must be specified.
xi
…Ellipses. Several values may be
provided for the previous argument, or
the previous argument can be specified
multiple times, for example
“filename...”.
|Separator. Only one of the arguments
separated by this character can be
specified at one time.
{}Braces. The options and/or arguments
enclosed within braces are
interdependent, such that everything
enclosed must be treated as a unit.
DESCRIPTIONThis section defines the functionality and
behavior of the service. Thus it describes
concisely what the command does. It does not
discuss OPTIONS or cite EXAMPLES.
OPTIONSThis lists the command options with a concise
summary of what each option does. The options
are listed literally and in alphabetical order.
Possible arguments to options are discussed
under the option, and where appropriate,
default values are supplied.
OPERANDSThis section lists the command operands and
describes how they affect the actions of the
command.
EXTENDED DESCRIPTIONThis section includes further description.
EXAMPLESThis section provides examples of usage or of
how to use a command or function. Wherever
possible, a complete example including
command-line entry and machine response is
shown. Most examples illustrate concepts from
the SYNOPSIS, DESCRIPTION, OPTIONS, and
OPERANDS sections.
EXIT STATUSThis section lists the values the command
returns to the calling program or shell and the
conditions that cause these values to be
returned. Usually, zero is returned for
successful completion and values other than
zero for various error conditions.
SEE ALSOThis section lists references to other man pages.
xiiSPARC Enterprise Mx000 Servers XSCF Reference Manual • August 2009
Intro(8)
NAMEIntro - list the commands provided by the XSCF firmware
DESCRIPTIONIntro(8) command lists the commands provided by the XSCF firmware of the
DESCRIPTIONThe addboard(8) command, based on domain component list (DCL), configures a
XSB into the domain configuration or assigns it to the domain configuration.
The addboard(8) command is not available on the M3000 server.
One of the following configuration methods can be specified:
configureConfigures an XSB into the specified domain configuration. The
incorporated XSB can be accessed from the Solaris™ OS.
assignAssigns an XSB to the specified domain. The assigned XSB is
reserved for the specified domain and cannot be configured in or
assigned to other domains. The assigned XSB is configured in the
domain by reboot or execution of the addboard(8) command
with "-c configure".
reserveReserves incorporation of an XSB into the domain configuration.
The action of "reserve" is the same as "assign."
PrivilegesYou must have one of the following privileges to run this command:
platadmCan run this command for all domains.
domainadmCan run this command only for your managed domains.
Refer to setprivileges(8) for more information.
OPTIONSThe following options are supported:
-c assignAssigns an XSB to the domain configuration. If the -c option is
omitted, "-c configure" is used.
-c configureConfigures an XSB in the domain configuration. If the -c option
is omitted, "-c configure" is used.
-c reserveReserves incorporation of an XSB into the domain configuration.
If the -c option is omitted, "-c configure" is used.
System Administration7
addboard(8)
-d domain_idSpecifies the ID of the domain in which an XSB is to be
configured or to which it is to be assigned. domain_id can be 0–23
depending on the system configuration.
-fForcibly incorporates into a domain an XSB.
Caution – If the -f option is used to forcibly add an XSB to a
domain, all the added hardware resources may not work
normally. For this reason, use of the -f option is not
recommended in normal operation. If the -f option must be
specified, verify the status of every added XSB and device.
-hDisplays usage statement. When used with other options or
operands, an error occurs.
-nAutomatically answers "n" (no) to all prompts.
-qSuppresses all messages to stdout, including prompts.
-vDisplays a detailed message. If this option is specified with the
-q option, the -v option is ignored.
-yAutomatically answers "y" (yes) to all prompts.
OPERANDSThe following operand is supported:
xsbSpecifies the XSB number to be configured or assigned. Multiple
xsb operands are permitted, separated by spaces. The following
xsb form is accepted:
x–y
where:
xAn integer from 00–15.
yAn integer from 0–3.
EXTENDED
DESCRIPTION
■ You can execute the addboard(8) command under the environment where the
following services, managed by the Solaris Service Management Facility (SMF),
are in operation:
■ Domain SP Communication Protocol (dscp service) is working properly and
the network with XSCF has been established
■ Domain Configuration Server (dcs service) is working properly
■ Sun cryptographic key management daemon (sckmd service) is working
properly
8SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised August 2009
addboard(8)
■ When the command is executed, a prompt to confirm execution of the command
with the specified options is displayed. Enter "y" to execute the command or "n"
to cancel the command.
■ If "-c configure" is specified when either the domain power has been turned
off or the Solaris OS is not running, an error occurs.
■ When "-c configure" is specified, hardware diagnosis is performed on the XSB
before it is incorporated into the domain. Therefore, command execution may
take time.
■ To use the addboard(8) command to configure or assign an XSB, DCL must be
set up in advance using the setdcl(8) command.
■ If the addboard(8) command is executed under the progress of power-on or
power-off processing, the busy status is returned. After that processing in the
domain is completed, reexecute the command.
■ See the setdcl(8) and showdcl(8) commands for DCL.
EXAMPLES
EXAMPLE 1Configures XSB#00-0, #01-0, #02-0, and #03-0 into domain ID 0.
10SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised August 2009
addcodlicense(8)
NAMEaddcodlicense - add a Capacity on Demand (COD) right-to-use (RTU) license key to
the COD license database
SYNOPSISaddcodlicense license-signature
addcodlicense -h
DESCRIPTIONaddcodlicense(8) adds the COD RTU specified license key to the COD license
database on the Service Processor.
The addcodlicense(8) command is not available on the M3000 server.
When the license key is added, the quantity of headroom is reduced by the quantity
provided by the license key. The quantity of headroom cannot be lower than 0.
Note – Before you run this command, you must obtain a COD license key. To
obtain a license key, contact your sales representative. For details on COD RTU
license keys, refer to the COD User’s Guide for your server.
PrivilegesYou must have platadm privileges to run this command.
Refer to setprivileges(8) for more information.
OPTIONSThe following option is supported:
-hDisplays usage statement.
When used with other options or operands, an error occurs.
OPERANDSThe following operands are supported:
license-signatureSpecifies the COD RTU license key to be added to the COD
EXIT STATUSThe following exit values are returned:
0Successful completion.
>0An error occurred.
SEE ALSOdeletecodlicense(8), setcod(8), showcod(8), showcodlicense(8),
showcodusage(8)
System Administration11
addcodlicense(8)
12SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
NAMEaddfru - add a Field Replaceable Unit (FRU)
SYNOPSISaddfru
addfru -h
DESCRIPTIONThe addfru(8) command adds an FRU.
The addfru(8) command enables the user to make the settings that are required for
FRU addition and related to selecting, confirming, and mounting FRUs,
interactively using menus.
The following FRUs can be added by the addfru(8) command:
■ CPU/Memory Board unit (CMU)
■ I/O unit (IOU)
■ Fan unit (FANU)
■ Power supply unit (PSU)
PrivilegesYou must have fieldeng privileges to run this command.
addfru(8)
Refer to setprivileges(8) for more information.
OPTIONSThe following option is supported:
-hDisplays usage statement.
EXIT STATUSThe following exit values are returned:
0Successful completion.
>0An error occurred.
SEE ALSOdeletefru(8), replacefru(8), setupfru(8), showfru(8), showhardconf(8),
testsb(8), unlockmaintenance(8)
System Administration13
addfru(8)
14SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
adduser(8)
NAMEadduser - create an XSCF user account
SYNOPSISadduser [-u UID] user
adduser -h
DESCRIPTIONadduser(8) creates a new local XSCF user account. This account is used to
configure, operate, manage and administer the XSCF firmware. Initially, this
account has no password. It cannot be used for login until either the password is set
(using password(8)) or Secure Shell (SSH) public key authentication is set for the
user. The new account will be locked but not disabled. The system can support up
to 100 local users with an average length of 10 characters for the user operand.
When invoked without the -u option, adduser automatically assigns a UID for the
user account. When invoked with the -u option adduser assigns the given UID to
the user account. Automatic UIDs are assigned starting from 100.
If the Service Processor is configured to use Lightweight Directory Access Protocol
(LDAP) for user account data, the user name and UID (if specified) must not
already be in use, either locally or in LDAP.
When a user is created, adduser(8) command stores the current password policy
values in a file for the user. For more information on setting password policy see,
setpasswordpolicy(8).
PrivilegesYou must have useradm privileges to run this command.
Refer to setprivileges(8) for more information.
OPTIONSThe following options are supported.
-hDisplays usage statement.
When used with other options or operands, an error occurs.
-u UIDCreates a new user with the given user identifier (UID). Specifying
a UID is optional. If specified, the UID must be greater than or
equal to 100; and 65534 and 65535 are reserved. If not specified, a
UID is automatically assigned.
OPERANDSThe following operand is supported:
userSpecifies a valid user name to be added. The maximum length of
the user name is 31 characters. A new local XSCF user account
name can be a combination of lowercase letters, numbers, "-", or
"_". Do not use uppercase letters. The first character must be a
letter. ( Examples of acceptable names include jsmith, j_smith,
and j_smith-0123.
System Administration15
adduser(8)
EXAMPLESEXAMPLE 1Creating a New User
XSCF> adduser -u 359 jsmith
EXIT STATUSThe following exit values are returned:
0Successful completion.
>0An error occurred.
SEE ALSOdeleteuser(8), disableuser(8), enableuser(8), password(8), setldap(8),
16SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised August 2009
applynetwork(8)
NAMEapplynetwork - reflect the information that has been set for the XSCF network
SYNOPSISapplynetwork [[-q] -{y|n}][-M]
applynetwork -h
DESCRIPTIONapplynetwork(8) command reflects the information that has been set for the XSCF
network to XSCF.
When you set one of the following for the XSCF network, it is necessary to execute
the applynetwork(8) command to reflect the information to XSCF.
■ XSCF host name
■ DNS domain name
■ IP address
■ netmask
■ routing
When you execute the applynetwork(8)command, it displays the information
which has been set to XSCF host name, DNS domain name, name server, IP
address, net mask, and routing. After reflected the information of XSCF network,
use the rebootxscf(8) command to reset XSCF, to complete the setting.
Note – If XSCF is reset without executing the applynetwork(8) command,
network information that is set is not reflected in XSCF. Also, information that is set
is deleted.
PrivilegesYou must have platadm privileges to run this command.
Refer to setprivileges(8) for more information.
OPTIONSThe following options are supported:
-hDisplays usage statement. When used with other options or
operands, an error occurs.
-MDisplays text by page. This option provides a function that is the
same as that of the more command.
-nAutomatically answers "n" (no) to all prompts.
-qSuppresses all messages to stdout, including prompts.
-yAutomatically answers "y" (yes) to all prompts.
EXTENDED
DESCRIPTION
■ When the command is executed, a prompt to confirm execution of the command
with the specified options is displayed. Enter "y" to execute the command or "n"
to cancel the command.
System Administration17
applynetwork(8)
■ Unless all of the host name, DNS domain name, IP address, net mask, and
routing settings have been made on the target interface, it results in errors.
Please execute the sethostname(8) and setnetwork(8) command to set all
items, then reexecute the applynetwork(8) command.
■ To set to multiple interfaces, all of the host name, DNS domain name, IP address,
and net mask settings need to be set on every interface. In these interfaces, if any
of these setting items omitted, it results in errors.
■ To specify a host name, use the sethostname(8) command. To specify an IP
address and net mask, use the setnetwork(8) command.
■ When the status is down in all network interfaces, it results in errors.
■ On the M8000/M9000 servers, when you set different netmask in the following
interfaces, it results in errors.
■ xscf#0-lan#0, xscf#1-lan#0, lan#0
■ xscf#0-lan#1, xscf#1-lan#1, lan#1
■ xscf#0-if, xscf#1-if
EXAMPLES
EXAMPLE 1Reflects the information that has been set for the XSCF network.
On the M3000/M4000/M5000 servers:
XSCF> applynetwork
The following network settings will be applied:
xscf#0 hostname :hostname-0
DNS domain name :example.com
nameserver :10.23.4.3
interface :xscf#0-lan#0
status :up
IP address :10.24.144.214
netmask :255.255.255.0
route :-n 0.0.0.0 -m 0.0.0.0 -g 10.24.144.1
interface :xscf#0-lan#1
status :down
IP address :
netmask :
18SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
route :
Continue? [y|n] :y
On the M8000/M9000 servers:
XSCF> applynetwork
The following network settings will be applied:
xscf#0 hostname :hostname-0
xscf#1 hostname :hostname-1
DNS domain name :example.com
nameserver :10.23.4.3
interface :xscf#0-lan#0
status :up
applynetwork(8)
IP address :10.24.144.214
netmask :255.255.255.0
route : -n 0.0.0.0 -m 0.0.0.0 -g 10.24.144.1
interface :xscf#0-lan#1
status :down
IP address :
netmask :
route :
interface :xscf#0-if
status :down
IP address :10.24.100.1
netmask :255.255.255.0
interface :lan#0
status :down
IP address :
netmask :
System Administration19
applynetwork(8)
interface :xscf#1-lan#0
status :up
IP address :10.24.144.215
netmask :255.255.255.0
route : -n 0.0.0.0 -m 0.0.0.0 -g 10.24.144.1
interface :xscf#1-lan#1
status :down
IP address :
netmask :
route :
interface :xscf#1-if
status :down
IP address :10.24.100.2
netmask :255.255.255.0
interface :lan#1
status :down
IP address :
netmask :
Continue? [y|n] :y
EXAMPLE 2Reflects the information that has been set for the XSCF network, on the
M3000/M4000/M5000 servers. Automatically answers "y" to all prompts.
XSCF> applynetwork -y
The following network settings will be applied:
xscf#0 hostname :hostname-0
DNS domain name :example.com
nameserver :10.23.4.3
20SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
interface :xscf#0-lan#0
status :up
IP address :10.24.144.214
netmask :255.255.255.0
route :-n 0.0.0.0 -m 0.0.0.0 -g 10.24.144.1
interface :xscf#0-lan#1
status :down
IP address :
netmask :
route :
applynetwork(8)
Continue? [y|n] :
Please reset the XSCF by rebootxscf to apply the network settings.
Please confirm that the settings have been applied by executing
showhostname, shownetwork, showroute and shownameserver after rebooting
the XSCF.
EXAMPLE 3Reflects the information that has been set for the XSCF network. Suppresses
y
prompts, and automatically answers "y" to all prompts.
XSCF> applynetwork -q -y
EXIT STATUSThe following exit values are returned:
0Successful completion.
>0An error occurred.
SEE ALSOrebootxscf(8), sethostname(8), setnameserver(8), setnetwork(8), setroute(8)
System Administration21
applynetwork(8)
22SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
cfgdevice(8)
NAMEcfgdevice - connect the CD-RW/DVD-RW drive unit and the tape drive unit to the
port, disconnect it from the port, or display the status of the drive
DESCRIPTIONThe cfgdevice(8) connects the CD-RW/DVD-RW drive unit and the tape drive
unit to the specified port, disconnects it from the domain, or displays the current
status.
The cfgdevice(8) command is available only for the M8000/M9000 servers.
To connect the CD-RW/DVD-RW drive unit and the tape drive unit, the port
number which is a PCI slot number on the I/O unit which installed IOU Onboard
Device Card A (IOUA) needs to specify. Executing the cfgdevice(8) command, the
CD-RW/DVD-RW drive unit and the tape drive unit is connected to specified port
by the built-in switching unit.
The current status of the drive that is displayed with this command includes the
following types of status information:
port_noPort number of the port where the IOUA is installed and that
can be connected to the CD-RW/DVD-RW drive unit and the
tape drive unit. It is displayed in the "IOU number-PCI slotnumber" format.
IOU/SAS-status Connection status between IOUA and built-in switching unit. It
is changed by specifying "attach"or"detach."
■ enable/disable: Setting status of the cfgdeive(8)
command
enable: Connected with "-c attach."
disable: Not connected.
■ up/down: Logical connection between IOUA and built-in
switching unit.
up: Connected.
down: Not connected.
System Administration23
cfgdevice(8)
PrivilegesYou must have platadm or fieldeng privileges to run this command.
OPTIONSThe following options are supported:
SAS-statusConnection status between I/O unit and the system.
■ enable/disable: Connection setting between I/O unit and
the system. When starting a domain with no I/O unit, the
"disable" may be displayed.
enable:Yes
disable:No
■ up/down: Logical connection between I/O unit and the
system.
up: Connected.
down: Not connected.
Refer to setprivileges(8) for more information.
-c attachConnects the CD-RW/DVD-RW drive unit and the tape drive
unit to the specified port.
EXTENDED
DESCRIPTION
-c detachDisconnects the CD-RW/DVD-RW drive unit and the tape
drive unit from the specified port.
-hDisplays usage statement. When used with other options or
operands, an error occurs.
-lDisplays the current status of the CD-RW/DVD-RW drive
unit and the tape drive unit currently set up.
-MDisplays text by page. This option provides a function that is
the same as that of the more command.
-nAutomatically answers "n" (no) to all prompts.
-p port_noSpecifies the number of the port, in the specified domain, to
which the CD-RW/DVD-RW drive unit and the tape drive
unit is to be connected. port_no can be specified in the ’IOUnumber-PCI slot number’ format. The -p option cannot be
omitted.
-qSuppresses all messages to stdout, including prompts.
-yAutomatically answers "y" (yes) to all prompts.
■ When the command is executed, a prompt to confirm execution of the command
with the specified options is displayed. Enter "y" to execute the command or "n"
to cancel the command.
24SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
cfgdevice(8)
■ If connection or disconnection is made when the power supply of the system is
ON, settings are made immediately after cfgdevice(8) command execution.
When the power supply of the system is OFF, connection or disconnection is
reserved and settings are made after the power supply is turned on.
■ The CD-RW/DVD-RW and the tape connection is maintained even if the domain
configuration is changed, or a CPU/Memory Board unit (CMU) or I/O unit
(IOU) is replaced with a connected CD-RW/DVD-RW drive unit and the tape
drive unit.
■ The CD-RW/DVD-RW and the tape connection is maintained even if the domain
power is turned off or the system is rebooted.
■ The CD-RW/DVD-RW drive unit and the tape drive unit is mounted in each of
the base and expansion cabinets in the M9000 server that has the expansion
cabinet. In such cases, each CD-RW/DVD-RW drive unit and the tape drive unit
can be connected only to a domain within the cabinet in which the drive is
mounted. Settings for connection must be made for both the base cabinet and
expansion cabinet.
XSCF> cfgdevice -l
Current connection for DVD/DAT:
Main chassis: port 0-0
Expansion chassis: port 8-0
Expander status
Port No. IOU/SAS-status SAS-status
-----------------------------------
0-0 enable up enable up
0-2 disable down enable up
0-4 disable down enable up
0-6 disable down enable up
1-0 disable down enable up
1-2 disable down enable up
1-4 disable down enable up
1-6 disable down enable up
2-0 disable down enable up
2-2 disable down enable up
2-4 disable down enable up
2-6 disable down enable up
8-0 enable up enable up
System Administration25
cfgdevice(8)
EXAMPLESEXAMPLE 1When the system is being powered off, reserves the connection of the CD-
8-2 disable down enable up
8-4 disable down enable up
8-6 disable down enable up
RW/DVD-RW drive unit and the tape drive unit to the port 0-0.
XSCF>
Are you sure you want to attach the device [y|n] :y
Completed.( Reservation )
EXAMPLE 2When the system is being powered on, connects the CD-RW/DVD-RW drive
cfgdevice -c attach -p 0-0
unit and the tape drive unit to port 0-0.
XSCF> cfgdevice -c attach -p 0-0
Are you sure you want to attach the device [y|n] :y
Completed.
EXAMPLE 3Disconnects the CD-RW/DVD-RW drive unit and the tape drive unit from
the port 0-0.
XSCF> cfgdevice -f -c detach -p 0-0
Are you sure you want to detach the device [y|n] :y
Completed.
EXAMPLE 4Displays the status of individual CD-RW/DVD-RW drive unit and the tape
drive unit set on the M8000 server and the M9000 server without the expansion cabinet.
XSCF> cfgdevice -l
Current connection for DVD/DAT: port 0-0
Expander status
Port No. IOU/SAS-status SAS-status
-----------------------------------
0-0 enable up enable up
0-2 disable down enable up
EXAMPLE 5Displays the status of individual CD-RW/DVD-RW drive unit and the tape
26SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
drive unit set on the M9000 server with the expansion cabinet.
XSCF> cfgdevice -l
Current connection for DVD/DAT: port 0-0
Main chassis: port 0-0
Expansion chassis: port 8-0
Expander status
Port No. IOU/SAS-status SAS-status
-----------------------------------
0-0 enable up enable up
0-2 disable down enable up
0-4 disable down enable up
0-6 disable down enable up
1-0 disable down enable up
1-2 disable down enable up
cfgdevice(8)
1-4 disable down enable up
1-6 disable down enable up
2-0 disable down enable up
2-2 disable down enable up
2-4 disable down enable up
2-6 disable down enable up
8-0 enable up enable up
8-2 disable down enable up
8-4 disable down enable up
8-6 disable down enable up
EXAMPLE 6Connects the CD-RW/DVD-RW drive unit and the tape drive unit to port 0-
0 when the system is being powered on. Automatically answers "y" to all
prompts.
XSCF>
Are you sure you want to attach the device [y|n] :y
Completed.
cfgdevice -y -c attach -p 0-0
EXAMPLE 7Connects the CD-RW/DVD-RW drive unit and the tape drive unit to port 0-
0 when the system is being powered on. Automatically answers "y" to all
System Administration27
cfgdevice(8)
prompts without displaying messages.
XSCF> cfgdevice -q -y -c attach -p 0-0
EXIT STATUSThe following exit values are returned:
0Successful completion.
>0An error occurred.
28SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
clockboard(8)
NAMEclockboard - Set or display the clock control unit used at system startup
SYNOPSISclockboard
clockboard -s CLKU_B-number
clockboard -h
DESCRIPTIONThe clockboard(8) command specifies the clock control unit used when the
system power is turned on, or it displays the clock control unit that is currently
used and the clock control unit used at the next system startup.
The clockboard(8) command is available only for the M8000/M9000 servers.
The number 0 or 1 is used to specify or display a clock control unit. When the
clockboard(8) command is executed with no options, the clock control unit that is
currently used and the one used at the next system startup are displayed.
PrivilegesYou must have fieldeng privilege to run this command.
Refer to setprivileges(8) for more information.
OPTIONSThe following options are supported:
-hDisplays usage statement. When used with other options or
operands, an error occurs.
-s CLKU_B-number Specifies the clock control unit to be used the next time the
system power is turned on. Either 0 or 1 can be specified for
CLKU_B-number.
EXAMPLES
EXAMPLE 1Displays the clock control unit that is currently used and the one used at the
next system startup.
XSCF> clockboard
current CLKU_B number:0
next CLKU_B number:1
EXAMPLE 2Specifies the clock control unit used at the next system startup.
XSCF> clockboard -s 1
EXIT STATUSThe following exit values are returned:
0Successful completion.
>0An error occurred.
System Administration29
clockboard(8)
30SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
DESCRIPTIONThe console(8) command connects the XSCF shell console to the console of the
specified domain (domain console).
Domain consoles include a writable console and read-only console. Only one
writable console and multiple read-only consoles can be connected to one domain.
An attempt to set up a connection to another writable console while one writable
console is already connected results in an error. Even in this case, however, a user
with the platadm or domainadm privilege can forcibly establish a connection to a
writable console, in which case the currently connected writable console is
disconnected.
To exit the domain console and return to the XSCF shell console, press the Enter key
and then enter "#" and "." (period).
Note – When you return to XSCF shell console without logging out from the
domain, the return causes automatically logging out from the domain.
PrivilegesYou must have one of the following privileges to run this command:
platadm, platop, fieldeng
Can run this command for all domains.
domainadm, domainmgr, domainop
Can run this command only for your accessible domains.
Refer to setprivileges(8) for more information.
OPTIONSThe following options are supported.
-d domain_idSpecifies only one ID of the domain to which to connect to a
domain console. domain_id can be 0–23 depending on the system
configuration.
-fForcibly connects to a writable console. The currently connected
writable console is disconnected. Only users who belong to the
platadm or domainadm privilege can specify this option.
-hDisplays usage statement. When used with other options or
operands, an error occurs.
-nAutomatically answers "n" (no) to all prompts.
-qSuppresses all messages to stdout, including prompts.
System Administration31
console(8)
-rSets up a connection to a read-only console.
-s escapeCharSpecifies an escape character. The default is "#" . The character
specified for escapeChar must be enclosed in """" (double
quotation). The following symbols can be specified for
escapeChar:
"#", "@", "^", "&", "?", "*", "=", ".", "|"
Specified escape character is available only in the session that
executed the console(8) command.
-yAutomatically answers "y" (yes) to all prompts.
EXTENDED
DESCRIPTION
■ When the command is executed, a prompt to confirm execution of the command
with the specified options is displayed. Enter "y" to execute the command or "n"
to cancel the command.
■ The domain console regards "#" used at the beginning of a line as an escape
character. An escape character is specified to instruct the console to perform
special processing. Examples of processing that can be specified in combination
with "#" are as follows.
"#" and "?"Outputs a status message.
"#" and "." (period) Disconnects the console.
■ To enter "#" at the beginning of a line, enter "#" twice.
■ To display information on the currently connected domain console, use the
showconsolepath(8) command.
EXIT STATUSThe following exit values are returned:
0Successful completion.
>0An error occurred.
SEE ALSOsendbreak(8), showconsolepath(8)
32SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
deleteboard(8)
NAMEdeleteboard - disconnect an eXtended System Board (XSB) from the domain
DESCRIPTIONThe deleteboard(8) command disconnects an XSB from the domain configuration
in which it has been configured.
The deleteboard(8) command is not available on the M3000 server.
One of the following disconnection methods can be specified:
disconnectDisconnects the XSB from the domain configuration but keeps it
assigned. Because the XSB thus remains assigned to the domain
configuration, it can be configured again in the domain by reboot
the domain or execution of the addboard(8) command.
unassignCompletely disconnects the XSB from the main configuration and
puts it in the system board pool. The XSB in the system board
pool can be incorporated into or assigned to other domain
configurations.
reserveDoes not immediately disconnects the XSB from the domain
configuration but only reserves detachment. When the domain
power is shut down, the reserved XSB is disconnected from the
domain configuration and put in the system board pool.
PrivilegesYou must have one of the following privileges to run this command:
platadmCan run this command for all domains.
domainadmCan run this command only for your managed domains.
Refer to setprivileges(8) for more information.
System Administration33
deleteboard(8)
OPTIONSThe following options are supported.
-c disconnectDetaches the XSB from the domain configuration and keeps it
assigned. If the -c option is omitted, "-c disconnect" is used.
-c resetReserves disconnect of an XSB. If the -c option is omitted, "-c
disconnect" is used.
-c unassignDisconnects the XSB completely from the domain configuration
and puts it in the system board pool. If the -c option is omitted,
"-c disconnect" is used.
-fForcibly detaches the specified XSB.
Caution – If the -f option is used to forcibly add a system
board to a domain, all the added hardware resources may not
work normally. For this reason, use of the -f option is not
recommended in normal operation. If the -f option must be
specified, verify the status of every added system board and
device.
-hDisplays usage statement. When used with other options or
operands, an error occurs.
-nAutomatically answers "n" (no) to all prompts.
-qSuppresses all messages to stdout, including prompts.
-vDisplays a detailed message. If this option is specified with the
-q option, the -v option is ignored.
-yAutomatically answers "y" (yes) to all prompts.
OPERANDSThe following operand is supported:
xsbSpecifies the XSB number to be disconnected. Multiple xsb
operands are permitted, separated by spaces. The following xsb
form is accepted:
x–y
where:
xAn integer from 00–15.
yAn integer from 0–3.
34SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised August 2009
deleteboard(8)
EXTENDED
DESCRIPTION
■ You can execute the deleteboard(8) command under the environment where
the following services, managed by the Solaris Service Management Facility
(SMF), are in operation:
■ Domain SP Communication Protocol (dscp service) is working properly and
the network with XSCF has been established
■ Domain Configuration Server (dcs service) is working properly
■ Sun cryptographic key management daemon (sckmd service) is working
properly
■ When the command is executed, a prompt to confirm execution of the command
with the specified options is displayed. Enter "y" to execute the command or "n"
to cancel the command.
■ If "-c disconnect" is specified when either the domain power has been turned
off or the XSB is already disconnected from the domain configuration, no
operation is performed. If domain power-on or power-off is in progress, the
command results in an error.
■ If "-c unassign" is specified when either the domain power has been turned
off or the XSB is already disconnected from the domain configuration, the XSB is
switched from the assigned state to a system board pool. If the XSB is already in
a system board pool, no operation is performed.
■ If "-c reserve" is specified when either the domain power has been turned off
or the XSB is already disconnected from the domain configuration, the XSB is
immediately switched from the assigned state to a system board pool. If the XSB
is already in a system board pool, no operation is performed. If domain poweron or power-off is in progress, the command results in an error.
EXAMPLES
■ When the XSB is disconnected, the hardware resource on the XSB is disconnected
from the operating system. For this reason, command execution may take time.
■ The state in which an XSB has been assigned means that configuring the XSB in
the specified domain has been reserved. The reserved XSB is configured when
the domain is rebooted or the addboard(8) command is executed. An already
assigned XSB cannot be specified for configuring or assignment from other
domains.
■ An XSB in the system board pool means that the XSB belongs to no domain and
is therefore available for configuring or assignment.
EXAMPLE 1Puts the system board XSB#00-0, #01-0, #02-0, and #03-0 in the system board
pool
XSCF> deleteboard -c unassign 00-0 01-0 02-0 03-0
EXAMPLE 2Reserves disconnection of XSB#00-0, #01-0, #02-0, and #03-0 .
XSCF> deleteboard -c reserve 00-0 01-0 02-0 03-0
System Administration35
deleteboard(8)
EXIT STATUSThe following exit values are returned:
0Successful completion.
>0An error occurred.
SEE ALSOaddboard(8), moveboard(8), replacefru(8), setdcl(8), setupfru(8),
36SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised August 2009
deletecodlicense(8)
NAMEdeletecodlicense - remove a Capacity on Demand (COD) right-to-use (RTU) license
key from the COD license database
SYNOPSISdeletecodlicense [-f] license-signature
deletecodlicense -h
DESCRIPTIONThe deletecodlicense(8) command removes the specified COD RTU license key
from the COD license database on the Service Processor.
The deletecodlicense(8) command is not available on the M3000 server.
For further information about COD RTU license keys, refer to the AdministrationGuide.
The system checks the number of COD RTU licenses against the number of COD
CPUs in use. If the license removal will result in an insufficient number of COD
RTU licenses with respect to the CPU in use, the system does not delete the license
key from the COD RTU license database. If you still want to delete the COD RTU
license key, you must reduce the number of COD CPUs in use. Power off the
appropriate number of domains or disconnect the appropriate number of the
eXtended System Boards (XSBs).
PrivilegesYou must have platadm privileges to run this command.
Refer to setprivileges(8) for more information.
OPTIONSThe following options are supported:
-fForces the specified COD RTU license key to be deleted from the
COD license database.
-hDisplays usage statement.
When used with other options or operands, an error occurs.
OPERANDSThe following operands are supported:
license-signatureSpecifies the COD RTU license key to be deleted from the
EXIT STATUSThe following exit values are returned:
0Successful completion.
>0An error occurred.
SEE ALSOaddcodlicense(8), setcod(8), showcod(8), showcodlicense(8),
showcodusage(8)
38SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
NAMEdeletefru - delete a Field Replaceable Unit (FRU)
SYNOPSISdeletefru
deletefru -h
DESCRIPTIONThe deletefru(8) command deletes an FRU.
The deletefru(8) command is available only for the M8000/M9000 servers.
The deletefru(8) command allows the user to make the settings that are required
for FRU deletion and related to selecting, confirming, and removing FRUs
interactively using menus.
The following FRUs can be deleted:
■ CPU/Memory Board unit (CMU)
■ I/O unit (IOU)
PrivilegesYou must have fieldeng privileges to run this command.
Refer to setprivileges(8) for more information.
deletefru(8)
OPTIONSThe following option is supported:
-hDisplays usage statement.
EXIT STATUSThe following exit values are returned:
0Successful completion.
>0An error occurred.
SEE ALSOaddfru(8), deleteboard(8), replacefru(8), setupfru(8), showdomainstatus(8),
showfru(8), showhardconf(8), unlockmaintenance(8)
System Administration39
deletefru(8)
40SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
deleteuser(8)
NAMEdeleteuser - delete an XSCF user account
SYNOPSISdeleteuser user
deleteuser -h
DESCRIPTIONdeleteuser(8) deletes a local XSCF user account. All local account data associated
with the user account is deleted including password and Secure Shell (SSH) keys.
The local user’s currently running XSCF shell and browser sessions are terminated
at once. The user’s account is removed from the system and they cannot log back
in. You cannot delete your own account.
PrivilegesYou must have useradm privileges to run this command.
Refer to setprivileges(8) for more information.
OPTIONSThe following option is supported:
-hDisplays usage statement.
When used with other options or operands, an error occurs.
OPERANDSThe following operands are supported:
userSpecifies a valid user name. The name of the user account to be
deleted.
EXAMPLES
EXAMPLE 1Deleting a User
XSCF> deleteuser jsmith
EXIT STATUSThe following exit values are returned:
0Successful completion.
>0An error occurred.
SEE ALSOadduser(8), disableuser(8), enableuser(8)
System Administration41
deleteuser(8)
42SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised January 2007
disableuser(8)
NAMEdisableuser - disable an XSCF user account
SYNOPSISdisableuser user
disableuser -h
DESCRIPTIONdisableuser(8) disables a local XSCF user account for subsequent logins. Current
sessions are not affected.
When an account is disabled, it cannot be used for login. This applies to console
(serial) and telnet connections, as well as the Secure Shell (SSH). XSCF Web login is
also disabled. All local XSCF account data associated with the user remains on the
system. This includes password and SSH keys. You can reenable a disabled account
using enableuser(8).
PrivilegesYou must have useradm privileges to run this command.
Refer to setprivileges(8) for more information.
OPTIONSThe following option is supported:
-hDisplays usage statement.
When used with other options or operands, an error occurs.
OPERANDSThe following operands are supported:
userSpecifies a valid user name of the user account to be disabled.
EXAMPLES
EXAMPLE 1Disabling a User Account
XSCF> disableuser jsmith
EXIT STATUSThe following exit values are returned:
0Successful completion.
>0An error occurred.
SEE ALSOadduser(8), deleteuser(8), enableuser(8), showuser(8)
System Administration43
disableuser(8)
44SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised January 2007
dumpconfig(8)
NAMEdumpconfig - save system configuration information to a file
DESCRIPTIONThe dumpconfig(8) command saves system configuration information, copying it
from the XSCF to a file specified by the user. The information can later be
downloaded from that file back to the XSCF using restoreconfig(8).
PrivilegesYou must have platadm, platop, or fieldeng privileges to run this command.
Refer to setprivileges(8) for more information.
OPTIONSThe following options are supported:
-c commentAccepts a user-provided comment in the file to distinguish
between different backup copies and is not read by the software.
This comment must be 132 chars or less in length. Special
characters are not allowed in the comment. Special characters are
not allowed in the comment.
Allowed characters are [0-9a-zA-Z] and " ". A space is also valid
but if spaces are used the entire comment must be enclosed in
double quotes.
Some examples:
-c "This is valid comment"
-c This is invalid comment
This example is invalid because spaces are included without
quotations.
-c "This! is @invalid"
This example is invalid because special characters are not allowed.
-eEncrypt the file. "-P password" option can be used to specify the
password. If a password is not specified the key will be prompted.
Once encrypted the configuration file cannot be decrypted without
the key. If the key is lost, there is no possibility of recovering the
configuration data.
-hDisplays usage statement. When used with other options or
operands, an error occurs.
-nAutomatically answers "n"(no) to all prompts.
System Administration45
dumpconfig(8)
-P passwordWith -e option, password can be provided on command line. The
command will prompt for the password if a password is not
provided on command line.
-p proxySpecifies the proxy server to be used for transfers. The default
transfer type is http, unless modified using the -t proxy_type
option. The value for proxy must be in the format servername:port.
-qSuppresses all messages to stdout, including prompts.
-t proxy_typeUsed with the -p option to specify the type of proxy. Possible
values for proxy_type are: http, socks4, and socks5. The default
value is http.
-u userSpecifies the user name when logging in to a remote ftp or http
server that requires authentication. You will be prompted for a
password.
-vDisplays verbose output. This may be helpful when diagnosing
server problems.
-VDisplays details of network activity. This may be helpful when
diagnosing network or server problems.
-yAutomatically answers "y"(yes) to all prompts.
OPERANDSThe following operands are supported:
urlSpecifies the URL where the configuration will be dumped.
Supported formats for this value include the following:
EXIT STATUSThe following exit values are returned:
0Successful completion.
>0An error occurred.
SEE ALSOrestoreconfig(8)
System Administration49
dumpconfig(8)
50SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised August 2009
enableuser(8)
NAMEenableuser - enable an XSCF user account
SYNOPSISenableuser user
enableuser -h
DESCRIPTIONenableuser(8) enables a local XSCF user account. An enabled account can be used
for login at the console, using Secure Shell (SSH). Using this command, you can
reenable accounts disabled by disableuser.
PrivilegesYou must have useradm privileges to run this command.
Refer to setprivileges(8) for more information.
OPTIONSThe following option is supported.
-hDisplays usage statement.
When used with other options or operands, an error occurs.
OPERANDSThe following operands are supported:
userSpecifies the valid user name of the account to be enabled.
EXAMPLES
EXAMPLE 1Enable a User Account
XSCF> enableuser jsmith
EXIT STATUSThe following exit values are returned:
0Successful completion.
>0An error occurred.
SEE ALSOadduser(8), deleteuser(8), disableuser(8), showuser(8)
System Administration51
enableuser(8)
52SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised January 2007
NAMEexit - exit the XSCF shell
SYNOPSISexit
DESCRIPTIONThe exit(1) command exits and closes the XSCF shell.
PrivilegesNo privileges are required to run this command.
Refer to setprivileges(8) for more information.
exit(1)
System Administration53
exit(1)
54SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised January 2007
NAMEflashupdate - update the firmware
SYNOPSISflashupdate -c check -m xcp -s version
flashupdate [[-q] -{y|n}] -c update -m xcp -s version
flashupdate -c sync
flashupdate -h
DESCRIPTIONThe flashupdate(8) command updates the firmware.
The entire firmware shown below is updated. Whether update can be performed
can be checked beforehand.
■ Update of the entire firmware (XSCF, OpenBoot PROM including Power-On Self-
Test (POST)) (xcp)
PrivilegesYou must have platadm or fieldeng privileges to run this command.
Refer to setprivileges(8) for more information.
OPTIONSThe following options are supported:.
flashupdate(8)
-c checkChecks whether the specified firmware can be updated.
-c updateUpdates the specified firmware. In the M8000/M9000 servers,
updates the firmware of both XSCF units.
-c syncSynchronizes the firmware versions of the XSCF units in the
M8000/M9000 servers. This option is used when replacing an
XSCF unit.
-hDisplays usage statement. When used with other options or
operands, an error occurs.
-m xcpSpecifies the entire firmware as a target.
-nAutomatically answers "n" (no) to all prompts.
System Administration55
flashupdate(8)
-qSuppresses all messages to stdout, including prompts.
-s versionSpecifies an XCP comprehensive firmware version. For version,
specify a major version, minor version and micro version
continuously.
The XCP version number appears as xyyz by four digits, where:
xMajor firmware release number
yyMinor release number
zMicro release number
-yAutomatically answers "y" (yes) to all prompts.
EXTENDED
DESCRIPTION
EXAMPLES
■ When the command is executed, a prompt to confirm execution of the command
with the specified options is displayed. Enter "y" to execute the command or "n"
to cancel the command.
■ When the firmware is updated, the XSCF unit is reset. Therefore, LAN
connection to the XSCF is canceled if already established.
■ When there's a faulty Field Replaceable Unit (FRU), can't update the firmware.
Resolve the FRU fault then update.
EXAMPLE 1Check whether the entire firmware can be updated to version 1082.
XSCF> flashupdate -c check -m xcp -s 1082
EXAMPLE 2Updates the entire firmware to version from 1080 to 1082.
XSCF> flashupdate -c update -m xcp -s 1082
The XSCF will be reset. Continue? [y|n] :y
XCP update is started (XCP version=1082:last version=1080)
OpenBoot PROM update is started (OpenBoot PROM version=02090000)
OpenBoot PROM update has been completed (OpenBoot PROM version=02090000)
XSCF update is started (XSCFU=0,bank=1,XCP version=1082:last version=1080)
XSCF download is started (XSCFU=0,bank=1,XCP version=1082:last
version=1080, Firmware Element ID=00:version=01080001:last
version=01080000)
XSCF download has been completed (XSCFU=0,bank=1,XCP version=1082:last
version=1080, Firmware Element ID=00:version=01080001:last
version=01080000)
:
56SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised August 2009
flashupdate(8)
:
XSCF download is started (XSCFU=0,bank=1,XCP version=1082:last
version=1080, Firmware Element ID=07:version=01080004:last
version=01080000)
XSCF download has been completed (XSCFU=0,bank=1,XCP version=1082:last
version=1080, Firmware Element ID=07:version=01080004:last
version=01080000)
XSCF update has been completed (XSCFU=0,bank=1,XCP version=1082:last
version=1080)
XCP update is started (XCP version=1082:last version=1080)
OpenBoot PROM update is started (OpenBoot PROM version=02090000)
OpenBoot PROM update has been completed (OpenBoot PROM version=02090000)
XSCF update is started (XSCFU=0,bank=0,XCP version=1082:last version=1080)
XSCF download is started (XSCFU=0,bank=0,XCP version=1082:last
version=1080, Firmware Element ID=00:version=01080001:last
version=01080000)
XSCF download has been completed (XSCFU=0,bank=0,XCP version=1082:last
version=1080, Firmware Element ID=00:version=01080001:last
version=01080000)
:
:
XSCF download is started (XSCFU=0,bank=0,XCP version=1082:last
version=1080, Firmware Element ID=07:version=01080004:last
version=01080000)
XSCF download has been completed (XSCFU=0,bank=0,XCP version=1082:last
version=1080, Firmware Element ID=07:version=01080004:last
version=01080000)
XSCF update has been completed (XSCFU=0,bank=0,XCP version=1082:last
version=1080)
XSCF is rebooting to update the reserve bank
EXAMPLE 3Synchronizes the firmware version of the replaced XSCF units in the M8000/
M9000 servers.
XSCF>
flashupdate -c sync
System Administration57
flashupdate(8)
EXIT STATUSThe following exit values are returned:
0Successful completion
>0An error occurred.
SEE ALSOversion(8)
58SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised August 2009
fmadm(8)
NAMEfmadm - fault management configuration tool
SYNOPSISfmadm [-q] config
fmadm -h
DESCRIPTIONfmadm (8) can be used to view system configuration parameters related to fault
management.
fmadm can be used to:
View the set of diagnosis engines and agents that are currently participating in
fault management
View the list of system components that have been diagnosed as faulty
The Fault Manager attempts to automate as many activities as possible, so use of
fmadm is typically not required. When the Fault Manager needs help from a human
administrator or service representative, it produces a message indicating its needs.
It also refers you to a URL containing the relevant knowledge article. The web site
might ask you to use fmadm or one of the other fault management utilities to gather
more information or perform additional tasks. The documentation for fmdump(8)
describes more about tools to observe fault management activities.
PrivilegesYou must have platop, platadm,orfieldeng privileges to run this command.
Refer to setprivileges(8) for more information.
OPTIONSThe following options are supported.
-hDisplays usage statement.
When used with other options or operands, an error occurs.
-qSets quiet mode. fmadm does not produce messages indicating the
result of successful operations to standard output.
OPERANDSThe following operands are supported:
configDisplays the configuration of the Fault Manager itself, including
the module name, version, and description of each component
module. Fault Manager modules provide services such as
automated diagnosis, self-healing, and messaging for hardware
and software present on the system.
System Administration59
fmadm(8)
EXAMPLESEXAMPLE 1Displaying the Fault Manager Configuration
XSCF> fmadm config
MODULE VERSION STATUS DESCRIPTION
case-close 1.0 active Case-Close Agent
fmd-self-diagnosis 1.0 active Fault Manager Self-Diagnosis
sysevent-transport 1.0 active SysEvent Transport Agent
syslog-msgs 1.0 active Syslog Messaging Agent
EXIT STATUSThe following exit values are returned:
0Successful completion.
>0An error occurred.
SEE ALSOfmdump(8), fmstat(8)
60SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised January 2007
DESCRIPTIONThe fmdump utility displays the contents of any of the logs associated with the Fault
Manager (fault manager daemon). The Fault Manager runs in the background on
each server. It records, in the error log, faults detected by the XSCF, and initiates
proactive self-healing activities, such as disabling faulty components.
The Fault Manager maintains two sets of logs for use by system administrators and
service personnel:
Error logRecords error telemetry, the symptoms of problems detected by
the system
Fault logRecords fault diagnosis information; the problems believed to
explain these symptoms. By default, fmdump displays the
contents of the fault log, which records the result of each
diagnosis made by the fault manager or one of its component
modules.
Each problem recorded in the fault log is identified by:
■ The time of its diagnosis
■ A Universal Unique Identifier (UUID) that can be used to uniquely identify this
particular problem across any set of systems
■ A message identifier (MSG-ID) that can be used to access a corresponding
knowledge article located at the specified website.
If a problem requires action by a system administrator or service personnel or
affects system behavior, the Fault Manager also issues a human-readable message.
This message provides a summary of the problem and a reference to the knowledge
article on the specified website.
You can use the -v and -V options to expand the display from a single-line
summary to increased levels of detail for each event recorded in the log. You can
also use the -M option to display only one screen at a time. The -c, -t, -T, and -u
options can be used to filter the output by selecting only those events that match
the specified class, range of times, or uuid. If more than one filter option is present
on the command line, the options combine to display only those events that are
selected by the logical AND of the options. If more than one instance of the same
System Administration61
fmdump(8)
PrivilegesYou must have platop, platadm,orfieldeng privileges to run this command.
OPTIONSThe following options are supported.
filter option is present on the command-line, the like options combine to display
any events selected by the logical OR of the options.
You can use the -m option to display the Fault Manager syslog contents.
Refer to setprivileges(8) for more information.
-c classSelects events that match the specified class. The class argument
can use the global pattern matching syntax, which is similar to
global pattern matching for files. For example xyz.* would match
xyz.sxc and xyz.pdf. The class represents a hierarchical
classification string indicating the type of telemetry event.
-hDisplays usage statement.
When used with other options or operands, an error occurs.
-eDisplays events from the fault management error log instead of the
fault log.
The error log contains private telemetry information used by
XSCF’s automated diagnosis software. This information is recorded
to facilitate post-mortem analysis of problems and event replay,
and should not be parsed or relied upon for the development of
scripts and other tools.
-fDisplays only lines that have been appended to the dump file since
the command was executed. Output continues until interrupted by
Ctrl-C.
-mDisplays the Fault Manager syslog message contents.
-MDisplays text by page. This option provides a function that is thesame as that of the more command.
-t timeSelects events that occurred at or after the specified time. The time
can be specified using the forms in the Time Formats following this
section. Used with -T you can specify a range.
-T timeSelects events that occurred at or before the specified time. time can
be specified using any of the time formats described for the -t
option. Used with -t you can specify a range.
62SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
fmdump(8)
-u uuidSelects fault diagnosis events that exactly match the specified uuid.
Each diagnosis is associated with a UUID for identification
purposes. The -u option can be combined with other options such
as -v to show all of the details associated with a particular
diagnosis.
If the -e option and -u option are specified at the same time,
fmdump displays the relevant error events.
-vDisplays verbose event detail. The event display is enlarged to
show additional common members of the selected events.
-VDisplays very verbose event detail. The event display is enlarged
to show every member of the name-value pair list associated with
each event. In addition, for fault logs, the event display includes a
list of cross-references to the corresponding errors that were
associated with the diagnosis.
The following are the Time Formats:
Time FormatDescription
mm/dd/yy hh:mm:ssMonth, day, year, hour in 24-hour format, minute, and
second. Any amount of whitespace can separate the
date and time. The argument should be quoted so that
the shell interprets the two strings as a single
argument.
mm/dd/yy hh:mmMonth, day, year, hour in 24-hour format, and minute.
Any amount of whitespace can separate the date and
time. The argument should be quoted so that the shell
interprets the two strings as a single argument.
mm/dd/yy12:00:00AM on the specified month, day, and year
ddMonyy hh:mm:ssDay, month name, year, hour in 24-hour format,
minute, and second. Any amount of whitespace can
separate the date and time. The argument should be
quoted so that the shell interprets the two strings as a
single argument.
Mon dd hh:mm:ssMonth, day, hour in 24-hour format, minute, and
second of the current year. Any amount of whitespace
can separate the date and time. The argument should
be quoted so that the shell interprets the two strings as
a single argument.
System Administration63
fmdump(8)
Time FormatDescription
yyyy-mm-dd[Thh:mm[:ss]]Year, month, day, and optional hour in 24-hour format,
minute, and second, where T is an integer value
specified in base 10. The second, or hour, minute, and
second, can be optionally omitted.
ddMonyy12:00:00AM on the specified day, month name, and
year.
hh:mm:ssHour in 24-hour format, minute, and second of the
current day.
hh:mmHour in 24-hour format and minute of the current day.
Tns | TnsecT nanoseconds ago where T is an integer value
specified in base 10.
Tu s | TusecT microseconds ago where T is an integer value
specified in base 10
Tms | TmsecT milliseconds ago where T is an integer value
specified in base 10.
EXAMPLES
Ts | TsecT seconds ago where T is an integer value specified in
base 10.
Tm | TminT minutes ago where T is an integer value specified in
base 10.
Th | ThourT hours ago where T is an integer value specified in
base 10.
Td | TdayT days ago where T is an integer value specified in
base 10.
You can append a decimal fraction of the form .n to any -t option argument to
indicate a fractional number of seconds beyond the specified time.
EXAMPLE 1Default fmdump Display
XSCF> fmdump
TIME UUID MSG-ID
Aug 12 16:12:13.2811 7868c1cc-23d4-c575-8659-85cdbe61842e FMD-8000-77
Aug 12 16:12:13.2985 7868c1cc-23d4-c575-8659-85cdbe61842e FMD-8000-77
DESC: A Solaris Fault Manager component generated a diagnosis for which no
message summary exists. Refer to http://www.sun.com/msg/FMD-8000-11 for
more information.
AUTO-RESPONSE: The diagnosis has been saved in the fault log for examination
by Sun.
IMPACT: The fault log will need to be manually examined using fmdump(1M)
in order to determine if any human response is required.
MSG-ID: FMD-8000-11, TYPE: Defect, VER: 1, SEVERITY: Minor
DESC: A Solaris Fault Manager component generated a diagnosis for which no
message summary exists. Refer to http://www.sun.com/msg/FMD-8000-11 for
more information.
AUTO-RESPONSE: The diagnosis has been saved in the fault log for examination
by Sun.
IMPACT: The fault log will need to be manually examined using fmdump(1M)
in order to determine if any human response is required.
EXIT STATUSThe following exit values are returned:
0Successful completion. All records in the log file were examined
successfully.
>0An error occurred.
SEE ALSOfmadm(8), fmstat(8)
68SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
DESCRIPTIONThe fmstat utility can be used by system administrators and service personnel to
report statistics associated with the Fault Manager (fault manager daemon), and its
associated set of modules. The Fault Manager runs in the background on each
system. It receives telemetry information relating to problems detected by the
system software, diagnoses these problems, and initiates proactive self-healing
activities such as disabling faulty components.
You can use fmstat to view statistics for diagnosis engines and agents that are
currently participating in fault management. The fmadm(8), and fmdump(8) man
pages describe more about tools to observe fault management activities.
If the -m option is present, fmstat reports any statistics kept by the specified fault
management module. The module list can be obtained using fmadm config.
If the -m option is not present, fmstat reports the following statistics for each of its
client modules:
moduleThe name of the fault management module as reported by
fmadm config.
ev_recvThe number of telemetry events received by the module.
ev_acptThe number of events accepted by the module as relevant to a
diagnosis.
waitThe average number of telemetry events waiting to be examined
by the module.
svc_tThe average service time for telemetry events received by the
module, in milliseconds.
%wThe percentage of time that there were telemetry events waiting
to be examined by the module.
%bThe percentage of time that the module was busy processing
telemetry events.
openThe number of active cases (open problem investigations)
owned by the module.
System Administration69
fmstat(8)
solveThe total number of cases solved by this module since it was
loaded.
memszThe amount of dynamic memory currently allocated by this
module.
bufszThe amount of persistent buffer space currently allocated by this
module.
PrivilegesYou must have platadm, platop,orfieldeng privileges to run this command.
Refer to setprivileges(8) for more information.
OPTIONSThe following options are supported.
-aPrints the default global statistics for the Fault Manager or a
module. If used without the -m module option, the default global
Fault Manager statistics are displayed. If used with the -m module
option, the global statistics for a module are displayed.
-hDisplays usage statement.
When used with other options or operands, an error occurs.
-m modulePrints a report on the statistics associated with the specified fault
management module, instead of the default statistics report.
Modules can publish an arbitrary set of statistics to help service the
fault management software itself.
If used without the -a option, displays only those statistics kept by
the module. If used with the -a option, displays statistics kept by
the module and the global statistics associated with the module.
-sPrints a report on Soft Error Rate Discrimination (SERD) engines
associated with the module instead of the default module statistics
report. A SERD engine is a construct used by fault management
software to determine if a statistical threshold measured as N
events in some time T has been exceeded. The -s option can only
be used in combination with the -m option.
-zOmits statistics with a zero value from the report associated with
the specified fault management module. The -z option can only be
used in combination with the -m option.
OPERANDSThe following operands are supported:
countPrint only count reports, and then exit.
intervalPrint a new report every interval seconds.
70SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
fmstat(8)
If neither count nor interval is specified, a single report is printed and fmstat exits.
If an interval is specified but no count is specified, fmstat prints reports every
interval seconds indefinitely until the command is interrupted by Ctrl-C.
EXAMPLES
EXAMPLE 1Displaying FM Statistics for the Syslog Module
XSCF> fmstat -a -m syslog-msgs
NAME VALUE DESCRIPTION
bad_code 0 event code has no dictionary name
bad_fmri 0 event fmri is missing or invalid
bad_time 0 event time is not properly encoded
bad_vers 0 event version is missing or invalid
fmd.accepted 0 total events accepted by module
fmd.buflimit 10M limit on total buffer space
fmd.buftotal 0 total buffer space used by module
fmd.caseclosed 0 total cases closed by module
fmd.caseopen 0 cases currently open by module
fmd.casesolved 0 total cases solved by module
fmd.ckptcnt 0 number of checkpoints taken
fmd.ckptrestore true restore checkpoints for module
fmd.ckptsave true save checkpoints for module
fmd.ckpttime 0d total checkpoint time
fmd.ckptzero false zeroed checkpoint at startup
fmd.debugdrop 4 dropped debug messages
fmd.dequeued 1 total events dequeued by module
fmd.dispatched 1 total events dispatched to module
fmd.dlastupdate 1144424838299131us hrtime of last event dequeue completion
fmd.dropped 0 total events dropped on queue overflow
fmd.dtime 0d total processing time after dequeue
fmd.loadtime 1144424251692484us hrtime at which module was loaded
fmd.memlimit 10M limit on total memory allocated
fmd.memtotal 97b total memory allocated by module
fmd.prdequeued 0 protocol events dequeued by module
fmd.snaptime 1144424838299148us hrtime of last statistics snapshot
fmd.thrlimit 8 limit on number of auxiliary threads
System Administration71
fmstat(8)
fmd.thrtotal 0 total number of auxiliary threads
fmd.wcnt 0 count of events waiting on queue
fmd.wlastupdate 1144424838299131us hrtime of last wait queue update
fmd.wlentime 30us total wait length * time product
fmd.wtime 30us total wait time on queue
fmd.xprtlimit 256 limit on number of open transports
fmd.xprtopen 0 total number of open transports
fmd.xprtqlimit 256 limit on transport event queue length
log_err 0 failed to log message to log(7D)
msg_err 0 failed to log message to sysmsg(7D)
no_msg 0 message logging suppressed
XSCF>
moduleev_recv ev_acpt wait svc_t %w %b open solve memsz bufsz
case-close00 0.00.0000000
fmd-self-diagnosis11 0.00.2001027b0
sysevent-transport00 0.0 573.2000000
syslog-msgs00 0.00.0000097b0
EXAMPLE 2Displaying FM Statistics for fmd Self-Diagnosis Module
XSCF> fmstat -z -m fmd-self-diagnosis
NAME VALUE DESCRIPTION
module 1 error events received from fmd modules
fmstat
EXIT STATUSThe following exit values are returned:
0Successful completion.
>0An error occurred.
SEE ALSOfmadm(8), fmdump(8)
72SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
getflashimage(8)
NAMEgetflashimage - download a firmware image file
DESCRIPTIONThe getflashimage(8) command downloads a firmware image file for use by the
flashupdate(8) command.
If any previous image files of the firmware are present on the XSCF unit, they are
deleted prior to downloading the new version. After successful download, the
image file is checked for integrity, and the MD5 checksum is displayed.
PrivilegesYou must have platadm or fieldeng privileges to run this command.
Refer to setprivileges(8) for more information.
OPTIONSThe following options are supported:
-dDeletes all previous firmware image files still on the XSCF unit,
then exits.
-hDisplays usage statement. When used with other options or
operands, an error occurs.
-lLists firmware image files that are still on the XSCF unit, then exits.
-nAutomatically answers "n"(no) to all prompts.
-p proxySpecifies the proxy server to be used for transfers. The default
transfer type is http, unless modified using the -t proxy_type
option. The value for proxy must be in the format servername:port.
(Refer to Example 3.)
-qSuppresses all messages to stdout, including prompts.
-t proxy_typeUsed with the -p option to specify the type of proxy. Possible
values for proxy_type are: http, socks4, and socks5. The default
value is http.
-u user
Specifies the user name when logging in to a remote ftp or http
server that requires authentication. You will be prompted for a
password.
-vDisplays verbose output. This may be helpful when diagnosing
network or server problems.
-yAutomatically answers "y"(yes) to all prompts.
System Administration73
getflashimage(8)
OPERANDSThe following operands are supported:
urlSpecifies the URL of the firmware image to download. Supported
formats for this value include the following:
http://server[:port]/path/file
https://server[:port]/path/file
ftp://server[:port]/path/file
file:///media/usb_msd/path/file
where the value for file is in one of the following formats:
XCPvvvv.tar.gz
IKXCPvvvv.tar.gz
FFXCPvvvv.tar.gz
DCXCPvvvv.tar.gz
EXAMPLES
and vvvv is the four-character version number.
EXAMPLE 1Downloading a Version from an http Server
DESCRIPTIONioxadm(8) manages External I/O Expansion Units and link cards attached to the
system.
The ioxadm(8) command is not available on the M3000 server.
For this utility, an operand with parameters and a target device must both be
specified. The target device can be a downlink card mounted in a built-in PCI slot
in the host system; an External I/O Expansion Unit; or a field replaceable unit
(FRU) in an External I/O Expansion Unit. The downlink card is identified by a
string which identifies the host path to the card. An uplink card is an FRU in the
I/O boat.
PrivilegesYou must have one of the following privileges to run these commands:
Required PrivilegesOperands
platopenv, list
platadmenv, list, locator, poweroff, poweron
fieldengAll operands
Refer to setprivileges(8) for more information.
System Administration79
ioxadm(8)
OPTIONSThe following options are supported.
-fForces command execution by ignoring warnings.
-hDisplays usage statement.
When used with other options or operands, an error occurs.
-MDisplays text by page. This option provides a function that is the
same as that of the more command.
-pParsable output. Suppresses headers in display output. Fields are
separated by single tabs.
-vSpecifies verbose output. Refer to specific operands for details.
OPERANDSThe following operands are supported:
env [-elt][target [sensors]]
Displays a summary of an External I/O Expansion Unit or link card’s
environmental state.
■ -e
Displays electrical states: measured voltage, current, fan speed, switch
settings.
■ -l
Displays LED states.
■ -t
Displays thermal readings.
If no target is specified, env displays a list of all sensors for all External I/O
Expansion Units.
If target specifies a box_id, env displays a list of sensor readings for all frus in
the specified External I/O Expansion Unit and the attached downlink cards.
If target is in the form of box_id followed by fru, then only environmentals
from that FRU will be printed. If an optional value for sensors is specified,
then only those types of sensors are displayed. These options may be used
concurrently.
If target is in the form of a host path, only the downlink card information is
displayed. See EXAMPLE 2.
80SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
ioxadm(8)
The results are listed in tabular format. Each FRU sensor is listed in the first
column. In the next column is the sensor name, such as T_AMBIENT for
ambient temperature, or V_12V_0V for the voltage reading of the 12V rail.
The third, fourth, and fifth columns display the sensor reading (Value), sensor
resolution (Res), and Units, respectively. See EXAMPLE 1.
Each FRU can have a variety of different sensors. When specifying multiple
values for sensors, use spaces to separate the values. Possible values for
sensors can be seen in the Sensor column of EXAMPLE 1. Units are given in
Celsius degrees, Volts, Amperes, SWITCH and RPM.
The sensors names are FRU-dependent and may change from FRU type to
FRU type and even among individual FRUs.
If the -v option is set, verbose output is displayed. In addition to the regular
output, the output also includes: the maximum and minimum values
supported by the sensors (Max and Min), along with the low and high
warning thresholds (Min Alarm and Max Alarm).
LED indicators do not support these fields.
led_type
Fields containing a "–" indicate an unsupported setting. For example, there
may be no minimum temperature alarm threshold.
Used with the setled operand, specifies a software-controlled FRU LED.
The following table indicates which LED states can be controlled using the
setled operand with the off, on, fast, and slow LED state settings. Y
(yes) indicates that the LED can be controlled, N (no) indicates that it cannot
be controlled.
LED Name off on fast slow
ACTIVE Power/OK Y Y Y Y
LOCATE Locate Y N Y N
SERVICE Fault/Locate Y Y Y Y
RDY2RM Ready to remove Y Y Y Y
OVERTEMP Overtemp * * * *
DCOK DC Power N N N N
POWER AC Power N N N N
DATA Data N N N N
MGMT Management N N N N
* The OVERTEMP LED and chassis ACTIVE LED may be set to each state.
However, the hardware frequently updates the LED state so changes to the
LED state may not be visible.
Note – Other LEDs are not under software control. A list of LEDs present in
the system can be displayed by using the "env -l" operand.
System Administration81
ioxadm(8)
The results are listed in tabular format. Each FRU sensor is listed in the first
column. In the next column is the sensor name, such as T_AMBIENT for
ambient temperature, or V_12V_0V for the voltage reading of the 12V rail.
The third, fourth, and fifth columns display the sensor reading (Value), sensor
resolution (Res), and Units, respectively. See EXAMPLE 1.
Each FRU can have a variety of different sensors. When specifying multiple
values for sensors, use spaces to separate the values. Possible values for
sensors can be seen in the Sensor column of EXAMPLE 1. Units are given in
Celsius degrees, Volts, Amperes, SWITCH and RPM.
The sensors names are FRU-dependent and may change from FRU type to
FRU type and even among individual FRUs.
If the -v option is set, verbose output is displayed. In addition to the regular
output, the output also includes: the maximum and minimum values
supported by the sensors (Max and Min), along with the low and high
warning thresholds (Min Alarm and Max Alarm).
LED indicators do not support these fields.
led_type
Fields containing a "–" indicate an unsupported setting. For example, there
may be no minimum temperature alarm threshold.
Used with the setled operand, specifies a software-controlled FRU LED.
The following table indicates which LED states can be controlled using the
setled operand with the off, on, fast, and slow LED state settings. Y
(yes) indicates that the LED can be controlled, N (no) indicates that it cannot
be controlled.
LED Name off on fast slow
ACTIVE Power/OK Y Y Y Y
LOCATE Locate Y N Y N
SERVICE Fault/Locate Y Y Y Y
RDY2RM Ready to remove Y Y Y Y
OVERTEMP Overtemp * * * *
DCOK DC Power N N N N
POWER AC Power N N N N
DATA Data N N N N
MGMT Management N N N N
* The OVERTEMP LED and chassis ACTIVE LED may be set to each state.
However, the hardware frequently updates the LED state so changes to the
LED state may not be visible.
Note – Other LEDs are not under software control. A list of LEDs present in
the system can be displayed by using the "env -l" operand.
82SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
list [target]
Lists the External I/O Expansion Units under system management.
If no target is specified, list displays a list of External I/O Expansion Units,
one per line. Each line contains the unique identifier for that box and the
host-specific name(s) for its downlink card(s). See EXAMPLE 3.
If an External I/O Expansion Unit argument or downlink card path is
specified, the command displays a single line with the indicated FRU. If a hostpath is specified, only the downlink card information is displayed. See
EXAMPLE 4 and EXAMPLE 6.
If the verbose option is set [-v], the output includes detailed FRU
information. See EXAMPLE 5.
locator [on |off] [target]
Sets or queries the state of the locator indicator (LED).
Without options, locator reports the current state of the LED on the
specified FRU.
ioxadm(8)
If no target is specified, locator returns the current state of all locator LEDs.
A target argument is required when using the option fields:
on
Turns the LED on.
off
Turns the LED off.
The chassis locator is a white LED. If an FRU is specified, the FRU yellow
service LED is used along with the chassis (locator) LED.
Only one FRU can have a location indicator enabled at a time in an External
I/O Expansion Unit chassis. Turning off the chassis (locator) LED will also
turn off the blinking (service) FRU LED.
poweroff target
Powers down the given FRU and lights appropriate LEDs to indicate the FRU
is ready to remove. Must be used with the -f option. Be aware that using -f
can crash the domain.
Do not remove both power supply units (PSUs) in the same External I/O
Expansion Unit. If both PSUs are powered down in this way, then the
External I/O Expansion Unit cannot be turned back on from the command
line. It must be powered on physically.
System Administration83
ioxadm(8)
Note – When a power supply is powered off, the LEDs and fan may still run
since they receive power from both supplies.
poweron target
Restores full power to an I/O boat or reenables output from the power
supply (PS) that has previously been marked ready-to-remove. When a PSU
is newly installed and the power switch is in the on position, or a boat is
connected to a powered link card, they automatically power themselves on.
However, this command can be used to power a PSU or I/O boat back on that
previously had been powered down for removal as long as the power switch
is in the on position.
reset target
Reinitializes FRU components used to monitor External I/O Expansion Unit
environmentals. If a boat or link card is specified, the bridge controllers in
the link cards are reset and re-initialized. If a box is specified, the fan
controller and demux in the box are reset and re-initialized along with all
bridge controllers associated with the External I/O Expansion Unit.
setled [on|off|slow|fast] target led_type
target
Sets LED state:
offOff.
onOn.
fastFast blink.
slowSlow blink.
Refer to the entry for led_type in this section for detailed information about
LED types.
Specifies the target device which can be a downlink card in a host slot, an
External I/O Expansion Unit, or an FRU in an External I/O Expansion Unit.
The downlink card is identified by the hostpath to the card.
hostpath is platform dependent and indicates the path to the slot on the
host system which contains the downlink card. On SPARC Enterprise
M4000/M5000/M8000/M9000 servers, the hostpath has the following
format:
IOU#0-PCI#0 IO Board 0, PCI-E slot0
84SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
ioxadm(8)
The External I/O Expansion Unit (box_id) is identified by serial number.
Use iox@nnnn, where nnnn represents the last four digits of the box serial
number.
Some commands affect only a single component of an External I/O
Expansion Unit system. For example, individual boats and power supplies
may be turned on and turned off independently.
An FRU in an External I/O Expansion Unit (fru) is identified as:
iox@nnnn/iob0 – I/O boat in the left tray (rear view)
iox@nnnn/iob1 – I/O boat in the right tray (rear view)
iox@nnnn/iob0/link – Uplink card in boat 0
iox@nnnn/iob1/link – Uplink card in boat 1
iox@nnnn/ps0 – Power supply in the left bay (front view)
iox@nnnn/ps1 – Power supply in the right bay (front view)
EXAMPLESEXAMPLE 1Displaying Temperature, Voltage, Current, and Fanspeed Sensor Readings
XSCF> ioxadm env -te iox@A3B5
Location Sensor Value Res Units
IOX@A3B5/PS0 T_AMBIENT 28.000 1.000 C
IOX@A3B5/PS0 T_CHIP 28.000 1.000 C
IOX@A3B5/PS0 T_HOTSPOT 31.000 1.000 C
IOX@A3B5/PS0 SWITCH On - SWITCH
IOX@A3B5/PS0 V_12V_ANODE 11.703 0.059 V
IOX@A3B5/PS0 V_12V_CATHODE 11.703 0.059 V
IOX@A3B5/PS0 V_ISHARE 0.632 0.040 V
IOX@A3B5/PS0 I_DC 2.316 0.289 A
IOX@A3B5/PS0 S_FAN_ACTUAL 3708.791 40.313 RPM
IOX@A3B5/PS0 S_FAN_SET 4500.000 300.000 RPM
IOX@A3B5/PS1 T_AMBIENT 28.000 1.000 C
IOX@A3B5/PS1 T_CHIP 29.000 1.000 C
IOX@A3B5/PS1 T_HOTSPOT 31.000 1.000 C
IOX@A3B5/PS1 SWITCH On - SWITCH
IOX@A3B5/PS1 V_12V_ANODE 11.762 0.059 V
IOX@A3B5/PS1 V_12V_CATHODE 11.762 0.059 V
IOX@A3B5/PS1 V_ISHARE 0.672 0.040 V
System Administration85
ioxadm(8)
IOX@A3B5/PS1 I_DC 5.211 0.289 A
IOX@A3B5/PS1 S_FAN_ACTUAL 4115.854 49.588 RPM
IOX@A3B5/PS1 S_FAN_SET 4500.000 300.000 RPM
IOX@A3B5/IOB0 T_CHIP 32.000 1.000 C
IOX@A3B5/IOB0 T_HOTSPOT 35.000 1.000 C
IOX@A3B5/IOB1 T_CHIP 33.000 1.000 C
IOX@A3B5/IOB1 T_HOTSPOT 36.000 1.000 C
IOX@A3B5/IOB1 V_12_0V 12.052 0.005 V
IOX@A3B5/IOB1 V_12V_MAIN 12.000 0.400 V
IOX@A3B5/IOB1 V_1_0V 1.030 0.001 V
IOX@A3B5/IOB1 V_1_5V 1.496 0.001 V
IOX@A3B5/IOB1 V_3_3V 3.291 0.002 V
IOX@A3B5/IOB1 V_3_3AUX 3.308 0.002 V
IOX@A3B5/IOB1 I_DC 8.600 0.200 A
IOX@A3B5/IOB1/LINK T_SIGCON0 45.000 40.000 C
IOX@A3B5/IOB1/LINK T_SIGCON1 45.000 40.000 C
IOU#1-PCI#1 T_SIGCON0 45.000 40.000 C
IOU#1-PCI#1 T_SIGCON1 45.000 40.000 C
EXAMPLE 2Display All Sensor Readings on a Link and Suppressing Headers
XSCF>
IOU#1-PCI#1 T_SIGCON0 45.000 40.000 C
IOU#1-PCI#1 T_SIGCON1 45.000 40.000 C
IOU#1-PCI#1 DATA On - LED
IOU#1-PCI#1 MGMT Flash - LED
EXAMPLE 3Display All External I/O Expansion Units or Downlink Card Paths
XSCF> ioxadm list
IOX Link 0 Link 1
IOX@0033 IOU#1-PCI#4 IOU#1-PCI#1
IOX@12B4 - IOU#1-PCI#2
ioxadm -p env iou#1-pci#1
- IOU#2-PCI#1
86SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
ioxadm(8)
In EXAMPLE 3, the list command is used to display the connections between
External I/O Expansion Units and downlink cards in the host. IOX@0033 (which
includes boats, uplink cards, and power supplies) is connected to the host through
two downlink cards. The Link 0 column shows which host downlink card is
attached to boat0. The Link 1 column shows which host downlink card is
attached to boat1. IOX@12B4 is connected to the host through one downlink card.
This card is connected to boat1.A"–" shows that there is no host link connection
to the box. It may have a boat and uplink card installed in the bay, or the bay could
be empty. If the boat is installed, either it is not connected to the host, or the host
downlink card slot is powered off.
EXAMPLE 4Displaying a Single External I/O Expansion Unit
XSCF> ioxadm list iox@12B4
IOX Link 0 Link 1
IOX@12B4 - IOU#1-PCI#2
EXAMPLE 5Displaying a Single External I/O Expansion Unit Using Verbose Output
XSCF> ioxadm -v list IOU#1-PCI#1
Location Type FW Ver Serial Num Part Num State
IOX@X07A IOX 2.1 XCX07A CF005016937/5016937-03 On
IOX@X07A/PS0 A195 - DD0579 CF003001701/3001701-04 On
IOX@X07A/PS1 A195 - DD0588 CF003001701/3001701-04 On
IOX@X07A/IOB0 PCIE - XE00E5 CF005016939/5016939-05 On
IOX@X07A/IOB0/LINK CU 2.0 XF01HJ CF005017040/5017040-04 On
IOU#0-PCI#3 CU 2.0 XF01AD CF005017040/5017040-03 On
EXAMPLE 6Displaying a Downlink Card Using Hostpath in Verbose Mode With Headers
Suppressed
XSCF> ioxadm -p -v list IOU#0-PCI#2
IOU#0-PCI#2 OP 2.0 XF01A1 CF005017040/5017040-03 on
EXAMPLE 7Powering On the Locator LED for Power Supply 0 in External I/O Expansion
Unit 12B4
XSCF> ioxadm locator on iox@12B4/ps0
System Administration87
ioxadm(8)
EXAMPLE 8Displaying Locator LED Status for the External I/O Expansion Unit
XSCF> ioxadm locator iox@12B4
Location Sensor Value Resolution Units
IOX@12B4 LOCATE Fast - LED
IOX@12B4/PS0 SERVICE Fast - LED
If the FRU service indicator is already on due to a detected fault condition, only the
box locator LED will be set to fast.
EXAMPLE 9Enabling the Indicator for Power Supply 1 When Power Supply 1 Has a Fault
Indication
XSCF>
XSCF> ioxadm locator
Location Sensor Value Resolution Units
IOX@X031 LOCATE Fast - LED
XSCF> ioxadm env -1 iox@x031/ps1 SERVICE
Location Sensor Value Resolution Units
IOX@X031/PS1 SERVICE On - LED
ioxadm locator on iox@x031/ps1
The External I/O Expansion Unit chassis white LED has an integrated push button.
The button can be used to toggle the state of the chassis white locator LED between
off and fast. If the push button is used to turn off the locator LED, fast blink FRU
service LEDs are cleared.
EXIT STATUSThe following exit values are returned:
0Successful completion.
>0An error occurred.
88SPARC Enterprise Mx000 Servers XSCF Reference Manual • Last Revised September 2008
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.