ucodeadm(1m)

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

NAME

6       ucodeadm - update processor microcode
7

SYNOPSIS

9       /usr/sbin/ucodeadm -v
10
11
12       /usr/sbin/ucodeadm -umicrocode-text-file
13
14
15       /usr/sbin/ucodeadm -i [-R path] microcode-text-file
16
17

DESCRIPTION

19       The  ucodeadm  utility can be used to report running microcode revision
20       on the processors, update microcode, or install microcode on the target
21       system to be used during the boot process.
22
23
24       The microcode-text-file can be obtained from processor vendors.
25

OPTIONS

27       -v                        Report microcode revision.
28
29
30       -u microcode-text-file    Update  microcode on all cross-call interrupt
31                                 ready processors.
32
33
34       -i microcode-text-file    Install microcode files on target  system  to
35                                 be used during the next  boot cycle. The text
36                                 file name must have the vendor  name  prefix,
37                                  such as "intel" or "amd".
38
39                                 By   default  the  microcode  files  will  be
40                                 installed at:
41
42                                    /platform/i86pc/ucode/$VENDORSTR/
43
44
45                                 where VENDORSTR is either  "GenuineIntel"  or
46                                 "AuthenticAMD".
47
48
49       -R alternate path         Install microcode path in the alternate path.
50
51

EXAMPLES

53       Example 1 Reporting the Microcode Revision
54
55
56       The following example displays the microcode revision that is currently
57       running:
58
59
60         # ucodeadm -v
61
62
63
64       Example 2 Updating the Processor Microcode
65
66
67       The  following  example  updates  the  processor  microcode  to  intel-
68       ucode.txt:
69
70
71         # ucodeadm -u intel-ucode.txt
72
73
74
75       Example 3 Installing the Microcode on the Target System
76
77
78       The  following  example  installs  the  microcode on the target system,
79       /export/ucode-path:
80
81
82         # ucodeadm -i -R /export/ucode-path intel-ucode.txt
83
84
85
86
87       If an alternate path is used when installing the microcode on the  tar‐
88       get  system,  the installed microcode file is not used on the next boot
89       cycle.
90
91

EXIT STATUS

93       The following exit values are returned:
94
95       0     Successful completion.
96
97
98       >0    An error occurred.
99
100

ATTRIBUTES

102       See attributes(5) for descriptions of the following attributes:
103
104
105
106
107       ┌─────────────────────────────┬─────────────────────────────┐
108       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
109       ├─────────────────────────────┼─────────────────────────────┤
110       │Availability                 │SUNWcsu                      │
111       ├─────────────────────────────┼─────────────────────────────┤
112       │Interface Stability          │Stable                       │
113       └─────────────────────────────┴─────────────────────────────┘
114