usr/src/man/man1m/fruadm.1m

   1 '\" te
   2 .\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH FRUADM 1M "Feb 22, 2002"
   7 .SH NAME
   8 fruadm \- prints and updates customer data associated with FRUs
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/platform/sun4u/sbin/fruadm\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 \fB/usr/platform/sun4u/sbin/fruadm\fR \fB-l\fR
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fB/usr/platform/sun4u/sbin/fruadm\fR [\fB-r\fR] \fIpath\fR [\fItext\fR]
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .sp
  27 .LP
  28 \fBfruadm\fR prints or sets the customer data for Field-Replaceable Units
  29 (\fBFRU\fRs).
  30 .sp
  31 .LP
  32 Without arguments, \fBfruadm\fR prints the paths of all \fBFRU ID\fR-capable
  33 \fBFRU\fRs (containers) in the system, along with the contents of the customer
  34 data record, if present, for each such \fBFRU\fR; for \fBFRU\fRs without
  35 customer data, \fBfruadm\fR prints only the container's path.
  36 .sp
  37 .LP
  38  Only a privileged user can create or update data in containers. The privileges
  39 required to perform these write operations are hardware dependent. Typically, a
  40 default system configuration restricts write operations to the superuser or to
  41 the platform-administrator user.
  42 .SH OPTIONS
  43 .sp
  44 .LP
  45 The following options are supported:
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fB-l\fR\fR
  50 .ad
  51 .RS 6n
  52 List the system's frutree paths.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fB-r\fR\fR
  59 .ad
  60 .RS 6n
  61 Recursively display or update the data for all containers rooted at the
  62 argument \fIpath\fR.
  63 .RE
  64
  65 .SH OPERANDS
  66 .sp
  67 .LP
  68 The following operands are supported:
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fIpath\fR\fR
  73 .ad
  74 .RS 8n
  75 A full or partial system frutree path for or under which to print or set the
  76 customer data. The first field of each line of output of \fBfruadm \fR\fB-l\fR
  77 gives the valid full \fBfrutree\fR paths for the system.
  78 .sp
  79 Paths can include shell meta-characters; such paths should be quoted
  80 appropriately for the user's shell. For partial paths, the first matching full
  81 path is selected for display or update. Without the \fB-r\fR option, the path
  82 must be that of a container; with the \fB-r\fR option, all containers (if any)
  83 under \fIpath\fR will be selected.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fItext\fR\fR
  90 .ad
  91 .RS 8n
  92 Up to 80 characters of text set as the customer data. If the text contains
  93 white space or shell metacharacters, it should be quoted appropriately for the
  94 user's shell.
  95 .RE
  96
  97 .SH EXAMPLES
  98 .LP
  99 \fBExample 1 \fRDisplaying All Customer Data
 100 .sp
 101 .LP
 102 The following example prints all customer data available from \fBFRU\fRs on the
 103 system. For containers with no customer data, only the containers' paths will
 104 be listed.
 105
 106 .sp
 107 .in +2
 108 .nf
 109 example% fruadm
 110 .fi
 111 .in -2
 112 .sp
 113
 114 .LP
 115 \fBExample 2 \fRDisplaying Customer Data For a Single FRU
 116 .sp
 117 .LP
 118 The following command prints the customer data, if present, for the specified
 119 \fBFRU\fR:
 120
 121 .sp
 122 .in +2
 123 .nf
 124 example% fruadm /frutree/chassis/system-board
 125 .fi
 126 .in -2
 127 .sp
 128
 129 .LP
 130 \fBExample 3 \fRDisplaying Customer Data For a Single FRU
 131 .sp
 132 .LP
 133 The following command prints the customer data, if present, for the first
 134 \fBmem-module\fR found:
 135
 136 .sp
 137 .in +2
 138 .nf
 139 example% fruadm mem-module
 140 .fi
 141 .in -2
 142 .sp
 143
 144 .LP
 145 \fBExample 4 \fR Setting Customer Data
 146 .sp
 147 .LP
 148 The following example sets the customer data for a \fBFRU\fR:
 149
 150 .sp
 151 .in +2
 152 .nf
 153 example# fruadm system-board 'Asset Tag 123456'
 154 .fi
 155 .in -2
 156 .sp
 157
 158 .LP
 159 \fBExample 5 \fRSetting Customer Data
 160 .sp
 161 .LP
 162 The following command sets the customer data for all \fBFRU\fRs under
 163 \fBchassis\fR:
 164
 165 .sp
 166 .in +2
 167 .nf
 168 example# fruadm -r /frutree/chassis "Property of XYZ, Inc."
 169 .fi
 170 .in -2
 171 .sp
 172
 173 .SH EXIT STATUS
 174 .sp
 175 .LP
 176 The following exit values are returned:
 177 .sp
 178 .ne 2
 179 .na
 180 \fB\fB0\fR \fR
 181 .ad
 182 .RS 6n
 183 Successful completion.
 184 .RE
 185
 186 .sp
 187 .ne 2
 188 .na
 189 \fB>\fB0\fR\fR
 190 .ad
 191 .RS 6n
 192 An error occurred.
 193 .RE
 194
 195 .SH ATTRIBUTES
 196 .sp
 197 .LP
 198 See \fBattributes\fR(5) for descriptions of the following attributes:
 199 .sp
 200
 201 .sp
 202 .TS
 203 box;
 204 c | c
 205 l | l .
 206 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 207 _
 208 Interface Stability     Unstable
 209 .TE
 210
 211 .SH SEE ALSO
 212 .sp
 213 .LP
 214 \fBprtfru\fR(1M), \fBattributes\fR(5)