1
2RAS-MC-CTL(8)         RAS memory controller admin utility        RAS-MC-CTL(8)
3
4
5

NAME

7       ras-mc-ctl - RAS memory controller admin utility
8
9

SYNOPSIS

11       ras-mc-ctl [OPTION]...
12
13

DESCRIPTION

15       The  ras-mc-ctl  program is a perl(1) script which performs some useful
16       RAS administration tasks on EDAC (Error Detection and Correction) driv‐
17       ers.
18
19

OPTIONS

21       --help Display a brief usage message.
22
23       --mainboard
24              Print  mainboard  vendor  and model for this hardware, if avail‐
25              able.  The method used by ras-mc-ctl  to  obtain  the  mainboard
26              vendor and model information for the current system is described
27              below in the MAINBOARD CONFIGURATION section.
28
29       --status
30              Print the status of EDAC drivers (loaded or unloaded).
31
32       --quiet
33              Be less verbose when executing an operation.
34
35       --register-labels
36              Register motherboard DIMM labels into EDAC driver  sysfs  files.
37              This  option  uses the detected mainboard manufacturer and model
38              number in combination with a "labels database" found in  any  of
39              the  files  under  /etc/ras/dimm_labels.d/*  or in the labels.db
40              file at /etc/ras/dimm_labels.db. An entry for the current  hard‐
41              ware  must  exist  in  the labels database for this option to do
42              anything.
43
44       --print-labels
45              Display the configured labels for the current hardware, as  well
46              as the current labels registered with EDAC.
47
48       --guess-labels
49              Print  DMI labels, when bank locator is available in the DMI ta‐
50              ble.  It helps to fill the labels database at  /etc/ras/dimm_la‐
51              bels.d/.
52
53       --labeldb=DB
54              Specify an alternate location for the labels database.
55
56       --delay=time
57              Specify  a delay of time seconds before registering DIMM labels.
58              Only meaninful if used together with --register-labels.
59
60       --layout
61              Prints the memory layout as detected by the EDAC driver.  Useful
62              to  check  if  the  EDAC driver is properly detecting the memory
63              controller architecture.
64
65       --summary
66              Presents a summary of the logged errors.
67
68       --errors
69              Shows the errors stored at the error database.
70
71       --error-count
72              Shows the corrected and uncorrected error counts using sysfs.
73
74       --vendor-errors-summary=platform-id
75              Pressents a summary of the vendor-specific logged errors.
76
77       --vendor-errors=platform-id
78              Shows the vendor-specific errors stored in the error database.
79
80       --vendor-platforms
81              Shows the supported platforms with platform-ids for the  vendor-
82              specific errors.
83
84

MAINBOARD CONFIGURATION

86       The  ras-mc-ctl  script uses the following method to determine the cur‐
87       rent system's mainboard vendor and model information:
88
89
90       1.  If the config file /etc/edac/mainboard exists, then it is parsed by
91           ras-mc-ctl. The mainboard config file has the following simple syn‐
92           tax:
93
94                  vendor = <mainboard vendor string>
95                  model =  <mainboard model string>
96                  script = <script to gather mainboard information>
97
98           Where anything after a '#' character on a line is considered a com‐
99           ment.  If the keyword script is specified, then that script or exe‐
100           cutable is run by ras-mc-ctl to gather  the  mainboard  vendor  and
101           model  information.  The script should write the resulting informa‐
102           tion on stdout in the same format as the mainboard config file.
103
104
105       2.  If no mainboard config file exists, then ras-mc-ctl will attempt to
106           read DMI information from the sysfs files
107
108                /sys/class/dmi/id/board_vendor
109                /sys/class/dmi/id/board_name
110
111
112
113       3.  If  the  sysfs  files above do not exist, then ras-mc-ctl will fall
114           back to parsing output of the dmidecode(8)  utility.  Use  of  this
115           utility will most often require that ras-mc-ctl be run as root.
116
117

SEE ALSO

119       rasdaemon(1)
120
121
122
123                                                                 RAS-MC-CTL(8)
Impressum