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