11621 fmadm and fmstat document privileges incorrectly
1 FMADM(1M) Maintenance Commands FMADM(1M) 2 3 4 5 NAME 6 fmadm - fault management configuration tool 7 8 SYNOPSIS 9 fmadm [-q] [subcommand [arguments]] 10 11 12 DESCRIPTION 13 The fmadm utility can be used by administrators and service personnel 14 to view and modify system configuration parameters maintained by the 15 Fault Manager, fmd(1M). fmd receives telemetry information relating to 16 problems detected by the system software, diagnoses these problems, and 17 initiates proactive self-healing activities such as disabling faulty 18 components. 19 20 21 fmadm can be used to: 22 23 o view the set of diagnosis engines and agents that are 24 currently participating in fault management, 25 26 o view the list of system components that have been diagnosed 27 as faulty, and 28 29 o perform administrative tasks related to these entities. 30 31 32 The Fault Manager attempts to automate as many activities as possible, 33 so use of fmadm is typically not required. When the Fault Manager needs 34 help from a human administrator, it produces a message indicating its 35 needs. It also refers you to a knowledge article on 36 http://illumos.org/msg/. This web site might ask you to use fmadm or 37 one of the other fault management utilities to gather more information 38 or perform additional tasks. The documentation for fmd(1M), fmdump(1M), 39 and fmstat(1M) describe more about tools to observe fault management 40 activities. 41 42 43 The fmadm utility requires the user to possess the SYS_CONFIG 44 privilege. Refer to the for more information about how to configure 45 privileges. The fmadm load subcommand requires that the user possess 46 all privileges. 47 48 SUBCOMMANDS 49 fmadm accepts the following subcommands. Some of the subcommands accept 50 or require additional options and operands: 51 52 fmadm acquit fmri | label [uuid] 53 54 Notify the Fault Manager that the specified resource is not to be 55 considered to be a suspect in the fault event identified by uuid, 56 or if no UUID is specified, then in any fault or faults that have 57 been detected. The fmadm acquit subcommand should be used only at 58 the direction of a documented repair procedure. Administrators 59 might need to apply additional commands to re-enable a previously 60 faulted resource. 61 62 63 fmadm acquit uuid 64 65 Notify the Fault Manager that the fault event identified by uuid 66 can be safely ignored. The fmadm acquit subcommand should be used 67 only at the direction of a documented repair procedure. 68 Administrators might need to apply additional commands to re-enable 69 any previously faulted resources. 70 71 72 fmadm config 73 74 Display the configuration of the Fault Manager itself, including 75 the module name, version, and description of each component module. 76 Fault Manager modules provide services such as automated diagnosis, 77 self-healing, and messaging for hardware and software present on 78 the system. 79 80 81 fmadm faulty [-afgiprsv] [-n max] [-u uid] 82 83 Display status information for resources that the Fault Manager 84 currently believes to be faulty. 85 86 The following options are supported: 87 88 -a 89 Display all faults. By default, the fmadm faulty command 90 only lists output for resources that are currently 91 present and faulty. If you specify the -a option, all 92 resource information cached by the Fault Manager is 93 listed, including faults which have been automatically 94 corrected or where no recovery action is needed. The 95 listing includes information for resources that might no 96 longer be present in the system. 97 98 99 -f 100 Display faulty fru's (Field replaceable units). 101 102 103 -g 104 Group together faults which have the same fru, class and 105 fault message. 106 107 108 -i 109 Display persistent cache identifier for each resource in 110 the Fault Manager. 111 112 113 -n max 114 If faults or resources are grouped together with the -a 115 or -g options, limit the output to max entries. 116 117 118 -p 119 Pipe output through pager with form feed between each 120 fault. 121 122 123 -r 124 Display Fault Management Resource with their Identifier 125 (FMRI) and their fault management state. 126 127 128 -s 129 Display 1 line fault summary for each fault event. 130 131 132 -u uid 133 Only display fault with given uid. 134 135 136 -v 137 Display full output. 138 139 The percentage certainty is displayed if a fault has multiple 140 suspects, either of different classes or on different fru's. If 141 more than one resource is on the same fru and it is not 100% 142 certain that the fault is associated with the fru, the maximum 143 percentage certainty of the possible suspects on the fru is 144 displayed. 145 146 147 148 The Fault Manager associates the following states with every resource 149 for which telemetry information has been received: 150 151 ok 152 153 The resource is present and in use and has no known problems so far 154 as the Fault Manager is concerned. 155 156 157 unknown 158 159 The resource is not present or not usable but has no known 160 problems. This might indicate the resource has been disabled or 161 deconfigured by an administrator. Consult appropriate management 162 tools for more information. 163 164 165 faulted 166 167 The resource is present but is not usable because one or more 168 problems have been diagnosed by the Fault Manager. The resource has 169 been disabled to prevent further damage to the system. 170 171 172 degraded 173 174 The resource is present and usable, but one or more problems have 175 been diagnosed in the resource by the Fault Manager. 176 177 If all affected resources are in the same state, this is reflected 178 in the message at the end of the list. Otherwise the state is given 179 after each affected resource. 180 181 182 fmadm flush fmri 183 184 Flush the information cached by the Fault Manager for the specified 185 resource, named by its FMRI. This subcommand should only be used 186 when indicated by a documented repair procedure. Typically, the use 187 of this command is not necessary as the Fault Manager keeps its 188 cache up-to-date automatically. If a faulty resource is flushed 189 from the cache, administrators might need to apply additional 190 commands to enable the specified resource. 191 192 193 fmadm load path 194 195 Load the specified Fault Manager module. path must be an absolute 196 path and must refer to a module present in one of the defined 197 directories for modules. Typically, the use of this command is not 198 necessary as the Fault Manager loads modules automatically when the 199 operating system initially boots or as needed. 200 201 202 fmadm unload module 203 204 Unload the specified Fault Manager module. Specify module using the 205 basename listed in the fmadm config output. Typically, the use of 206 this command is not necessary as the Fault Manager loads and 207 unloads modules automatically based on the system configuration 208 209 210 fmadm repaired fmri | label 211 212 Notify the Fault Manager that a repair procedure has been carried 213 out on the specified resource. The fmadm repaired subcommand should 214 be used only at the direction of a documented repair procedure. 215 Administrators might need to apply additional commands to re-enable 216 a previously faulted resource. 217 218 219 fmadm replaced fmri | label 220 221 Notify the Fault Manager that the specified resource has been 222 replaced. This command should be used in those cases where the 223 Fault Manager is unable to automatically detect the replacement. 224 The fmadm replaced subcommand should be used only at the direction 225 of a documented repair procedure. Administrators might need to 226 apply additional commands to re-enable a previously faulted 227 resource. 228 229 230 fmadm reset [-s serd] module 231 232 Reset the specified Fault Manager module or module subcomponent. If 233 the -s option is present, the specified Soft Error Rate 234 Discrimination (SERD) engine is reset within the module. If the -s 235 option is not present, the entire module is reset and all 236 persistent state associated with the module is deleted. The fmadm 237 reset subcommand should only be used at the direction of a 238 documented repair procedure. The use of this command is typically 239 not necessary as the Fault Manager manages its modules 240 automatically. 241 242 243 fmadm rotate errlog | fltlog 244 245 The rotate subcommand is a helper command for logadm(1M), so that 246 logadm can rotate live log files correctly. It is not intended to 247 be invoked directly. Use one of the following commands to cause the 248 appropriate logfile to be rotated, if the current one is not zero 249 in size: 250 251 # logadm -p now -s 1b /var/fm/fmd/errlog 252 # logadm -p now -s 1b /var/fm/fmd/fltlog 253 254 255 256 257 OPTIONS 258 The following options are supported: 259 260 -q 261 Set quiet mode. fmadm does not produce messages indicating the 262 result of successful operations to standard output. 263 264 265 OPERANDS 266 The following operands are supported: 267 268 cmd 269 The name of a subcommand listed in SUBCOMMANDS. 270 271 272 args 273 One or more options or arguments appropriate for the selected 274 subcommand, as described in SUBCOMMANDS. 275 276 277 EXIT STATUS 278 The following exit values are returned: 279 280 0 281 Successful completion. 282 283 284 1 285 An error occurred. Errors include a failure to communicate with 286 fmd or insufficient privileges to perform the requested operation. 287 288 289 2 290 Invalid command-line options were specified. 291 292 293 ATTRIBUTES 294 See attributes(5) for descriptions of the following attributes: 295 296 297 298 299 +--------------------+-----------------+ 300 | ATTRIBUTE TYPE | ATTRIBUTE VALUE | 301 +--------------------+-----------------+ 302 |Interface Stability | See below. | 303 +--------------------+-----------------+ 304 305 306 The command-line options are Committed. The human-readable output is 307 not-an-interface. 308 309 SEE ALSO 310 fmd(1M), fmdump(1M), fmstat(1M), logadm(1M), syslogd(1M), attributes(5) 311 312 313 314 315 http://illumos.org/msg/ 316 317 318 319 October 22, 2008 FMADM(1M) --- EOF ---