fruadm(1m) - osol9

1fruadm(1M)              System Administration Commands              fruadm(1M)
2
3
4

NAME

6       fruadm - prints and updates customer data associated with FRUs
7

SYNOPSIS

9       /usr/platform/sun4u/sbin/fruadm
10
11
12       /usr/platform/sun4u/sbin/fruadm -l
13
14
15       /usr/platform/sun4u/sbin/fruadm [-r] path [text]
16
17

DESCRIPTION

19       fruadm  prints  or  sets  the customer data for Field-Replaceable Units
20       (FRUs).
21
22
23       Without arguments, fruadm prints the paths of all FRU  ID-capable  FRUs
24       (containers)  in  the  system,  along with the contents of the customer
25       data record, if present, for each such FRU; for FRUs  without  customer
26       data, fruadm prints only the container's path.
27
28
29        Only  a  privileged  user can create or update data in containers. The
30       privileges required to perform  these  write  operations  are  hardware
31       dependent.  Typically,  a  default system configuration restricts write
32       operations to the superuser or to the platform-administrator user.
33

OPTIONS

35       The following options are supported:
36
37       -l    List the system's frutree paths.
38
39
40       -r    Recursively display or update the data for all containers  rooted
41             at the argument path.
42
43

OPERANDS

45       The following operands are supported:
46
47       path    A  full  or  partial  system frutree path for or under which to
48               print or set the customer data. The first field of each line of
49               output  of fruadm -l gives the valid full frutree paths for the
50               system.
51
52               Paths can include shell meta-characters; such paths  should  be
53               quoted  appropriately  for the user's shell. For partial paths,
54               the first matching full path is selected for display or update.
55               Without  the  -r  option, the path must be that of a container;
56               with the -r option, all containers (if any) under path will  be
57               selected.
58
59
60       text    Up  to  80  characters of text set as the customer data. If the
61               text contains white space or shell metacharacters, it should be
62               quoted appropriately for the user's shell.
63
64

EXAMPLES

66       Example 1 Displaying All Customer Data
67
68
69       The  following  example prints all customer data available from FRUs on
70       the system. For containers with no customer data, only the  containers'
71       paths will be listed.
72
73
74         example% fruadm
75
76
77
78       Example 2 Displaying Customer Data For a Single FRU
79
80
81       The  following  command  prints  the customer data, if present, for the
82       specified FRU:
83
84
85         example% fruadm /frutree/chassis/system-board
86
87
88
89       Example 3 Displaying Customer Data For a Single FRU
90
91
92       The following command prints the customer data,  if  present,  for  the
93       first mem-module found:
94
95
96         example% fruadm mem-module
97
98
99
100       Example 4  Setting Customer Data
101
102
103       The following example sets the customer data for a FRU:
104
105
106         example# fruadm system-board 'Asset Tag 123456'
107
108
109
110       Example 5 Setting Customer Data
111
112
113       The  following  command sets the customer data for all FRUs under chas‐
114       sis:
115
116
117         example# fruadm -r /frutree/chassis "Property of XYZ, Inc."
118
119
120

EXIT STATUS

122       The following exit values are returned:
123
124       0     Successful completion.
125
126
127       >0    An error occurred.
128
129

ATTRIBUTES

131       See attributes(5) for descriptions of the following attributes:
132
133
134
135
136       ┌─────────────────────────────┬─────────────────────────────┐
137       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
138       ├─────────────────────────────┼─────────────────────────────┤
139       │Availability                 │SUNWfruip.u                  │
140       ├─────────────────────────────┼─────────────────────────────┤
141       │Interface Stability          │Unstable                     │
142       └─────────────────────────────┴─────────────────────────────┘
143