ixpdimm-cli(8)

1ixpdimm-cli(8)                   Intel(R) DIMM                  ixpdimm-cli(8)
2
3
4

NAME

6       ixpdimm-cli - CLI to manage Intel(R) DIMMs
7
8

SYNOPSIS

10       ixpdimm-cli <verb> [<options>] [<targets>] [<properties>]
11
12
13       verb
14              A  command  has  a single verb which represents the action to be
15              taken.  Verb choices are create, delete, dump, help, load,  set,
16              show, start, and version.  Use
17                     <verb> -help
18              to see available commands for a specific verb.
19
20       options
21              Following  the  verb  are  zero or more options which modify the
22              action of the verb; overriding the default behavior with explic‐
23              itly requested behavior.
24
25       targets
26              Generally  one  or  more  targets  are  required to indicate the
27              object of the action.  Use
28                     <verb> -help <target>
29              to see available commands for a verb/target pair.
30
31       properties
32              Finally, zero or more properties defined as a key/value pair can
33              be used to modify the target.
34
35

DESCRIPTION

37       Command  line  access  to  DIMM  Management  functionality is available
38       through the ixpdimm-cli component. The  NVMCLI  exposes  all  available
39       management  features of the underlying DIMM. The Command Line Interface
40       is an end-user, manufacturing and validation utility.
41
42
43       Show Device Firmware:
44
45       Update Firmware:
46              load -source (path) [-force|-f] [-examine|-x] [-help|-h]  [-out‐
47              put|-o (text|nvmxml|verbose)] -dimm [(DimmIDs)]
48
49       Show Device Performance:
50              show  [-help|-h] [-output|-o (text|nvmxml|verbose)] -dimm [(Dim‐
51              mIDs)]   -performance   [(BytesRead|BytesWritten|HostReads|Host‐
52              Writes|BlockReads|BlockWrites)]
53
54       Run Diagnostic:
55              start  [-help|-h] [-output|-o (text|nvmxml|verbose)] -diagnostic
56              [(Quick|Config|Security|FW)] [-dimm (DimmIDs)]
57
58       Create Support Snapshot:
59              create [-help|-h]  [-output|-o  (text|nvmxml|verbose)]  -support
60              [Name = (string)]
61
62       Dump Support Data:
63              dump      -destination     (path)     [-help|-h]     [-output|-o
64              (text|nvmxml|verbose)] -support
65
66       Delete Support Data:
67              delete [-help|-h] [-output|-o (text|nvmxml|verbose)] -support
68
69       Toggle Software Logging:
70              set  [-help|-h]   [-output|-o   (text|nvmxml|verbose)]   -system
71              LogLevel = (0|1)
72
73       Version:
74              version [-help|-h] [-output|-o (text|nvmxml|verbose)]
75
76       Acknowledge event:
77              set  [-help|-h] [-output|-o (text|nvmxml|verbose)] -event (Even‐
78              tID) ActionRequired = 0
79
80       Show Events:
81              show      [-starttime      (MM:dd:yyyy:hh:mm:ss)]      [-endtime
82              (MM:dd:yyyy:hh:mm:ss)]  [-help|-h] [-output|-o (text|nvmxml|ver‐
83              bose)] -event [(EventID)] [-dimm (DimmID)]  [-namespace  (Names‐
84              paceID)]  [Severity  =  (Info|Warn|Critical|Fatal)]  [Category =
85              (Diag|FW|PlatformConfig|PM|Quick|Security|Health|Mgmt)] [Action‐
86              Required = (1|0)]
87
88       Show Preferences:
89              show [-help|-h] [-output|-o (text|nvmxml|verbose)] -preferences
90
91       Change Preferences:
92              set  [-help|-h]  [-output|-o (text|nvmxml|verbose)] -preferences
93              [CLI_DEFAULT_DIMM_ID   =   (HANDLE|UID)]   [CLI_DEFAULT_SIZE   =
94              (AUTO|AUTO_10|B|MiB|MB|GiB|GB|TiB|TB)]        [PERFORMANCE_MONI‐
95              TOR_ENABLED  =  (0|1)]  [PERFORMANCE_MONITOR_INTERVAL_MINUTES  =
96              (minutes)] [EVENT_MONITOR_ENABLED = (0|1)] [EVENT_MONITOR_INTER‐
97              VAL_MINUTES = (minutes)] [EVENT_LOG_MAX =  (count)]  [LOG_MAX  =
98              (count)]  [SUPPORT_SNAPSHOT_MAX = (count)] [APPDIRECT_SETTINGS =
99              (RECOMMENDED|(IMCSize)_(ChannelSize))] [APPDIRECT_GRANULARITY  =
100              (RECOMMENDED|1)]
101
102       Show Logs:
103              show [-help|-h] [-output|-o (text|nvmxml|verbose)] -log [Count =
104              (count)]
105
106       Show Device Platform Configuration Data:
107              show [-help|-h] [-output|-o (text|nvmxml|verbose)] -dimm  [(Dim‐
108              mIDs)] -pcd
109
110       Format Device:
111              start  [-force|-f] [-help|-h] [-output|-o (text|nvmxml|verbose)]
112              -format -dimm [(DimmIDs)]
113
114       Dump Device Support Data:
115              dump     -destination     (path)     [-help|-h]      [-output|-o
116              (text|nvmxml|verbose)] -dimm [(DimmIDs)] -support
117
118       Delete Device Platform Configuration Data:
119              delete [-force|-f] [-help|-h] [-output|-o (text|nvmxml|verbose)]
120              -dimm [(DimmIDs)] -pcd (LSA)
121
122       Help:
123              help [-help|-h] [-output|-o (text|nvmxml|verbose)] [Name = (com‐
124              mand)] [verb = (verb)]
125
126       Show Namespace:
127              show [-all|-a] [-display|-d (Attributes)] [-units|-u] [-help|-h]
128              [-output|-o (text|nvmxml|verbose)]  -namespace  [(NamespaceIDs)]
129              [-pool  (PoolID)] [HealthState = (Unknown|Healthy|Warning|Criti‐
130              cal|BrokenMirror)]
131
132       Create Namespace:
133              create   [-force|-f]    [-units|-u]    [-help|-h]    [-output|-o
134              (text|nvmxml|verbose)]  -namespace  [-pool  [(PoolID)]] [Persis‐
135              tentMemoryType =  (AppDirect|AppDirectNotInterleaved)]  [Name  =
136              (string)]  [Optimize  =  (CopyOnWrite|None)]  [Enabled  = (0|1)]
137              [Encryption = (No|Yes|Ignore)] [EraseCapable =  (No|Yes|Ignore)]
138              [Capacity  =  (GiB)]  [MemoryPageAllocation  = (None|DRAM|AppDi‐
139              rect)]
140
141       Modify Namespace:
142              set    [-force|-f]    [-units|-u]     [-help|-h]     [-output|-o
143              (text|nvmxml|verbose)]   -namespace   [(NamespaceIDs)]  [Name  =
144              (string)] [Enabled = (0|1)] [Capacity = (GiB)]
145
146       Delete Namespace:
147              delete [-force|-f] [-help|-h] [-output|-o (text|nvmxml|verbose)]
148              -namespace [(NamespaceIDs)]
149
150       Show Memory Allocation Goal:
151              show    [-all|-a]    [-display|-d    (Attributes)]    [-units|-u
152              (B|MB|MiB|GB|GiB|TB|TiB)]         [-help|-h]         [-output|-o
153              (text|nvmxml|verbose)]  [-dimm  (DimmIDs)] [-socket (SocketIDs)]
154              -goal
155
156       Delete Memory Allocation Goal:
157              delete  [-help|-h]  [-output|-o  (text|nvmxml|verbose)]   [-dimm
158              (DimmIDs)] -goal [-socket (SocketIDs)]
159
160       Create Memory Allocation Goal:
161              create    [-force|-f]    [-units|-u    (B|MB|MiB|GB|GiB|TB|TiB)]
162              [-help|-h] [-output|-o (text|nvmxml|verbose)] [-dimm  (DimmIDs)]
163              -goal [-socket (SocketIDs)] [MemoryMode = (0|%)] [PersistentMem‐
164              oryType  =  (AppDirect|AppDirectNotInterleaved)]   [Reserved   =
165              (0|%)]   [Config   =   (MM|AD|MM+AD)]  [NamespaceLabelVersion  =
166              (1.1|1.2)]
167
168       Show Persistent Memory:
169              show [-display|-d (Attributes)] [-all|-a] [-units|-u] [-help|-h]
170              [-output|-o  (text|nvmxml|verbose)]  -pool  [(PoolID)]  [-socket
171              (SocketIDs)]
172
173       Dump Memory Allocation Settings:
174              dump     -destination     (path)     [-help|-h]      [-output|-o
175              (text|nvmxml|verbose)] -system -config
176
177       Load Memory Allocation Goal:
178              load  [-force|-f]  -source  (path) [-units|-u] [-help|-h] [-out‐
179              put|-o (text|nvmxml|verbose)] -goal [-dimm  (DimmIDs)]  [-socket
180              (SocketIDs)]
181
182       Show Sensor:
183              show [-display|-d (Attributes)] [-all|-a] [-help|-h] [-output|-o
184              (text|nvmxml|verbose)] -sensor [(MediaTemperature|ControllerTem‐
185              perature|SpareCapacity|WearLevel|UnsafeShutdowns|PowerOn‐
186              Time|UpTime|PowerCycles|PowerLimited|Health)] [-dimm (DimmIDs)]
187
188       Change Sensor Settings:
189              set [-force|-f]  [-help|-h]  [-output|-o  (text|nvmxml|verbose)]
190              -sensor   (MediaTemperature|ControllerTemperature|SpareCapacity)
191              [-dimm (DimmIDs)] [NonCriticalThreshold = (value)] [EnabledState
192              = (0|1)]
193
194       Show Host Server:
195              show [-all|-a] [-display|-d (Attributes)] [-help|-h] [-output|-o
196              (text|nvmxml|verbose)] -system
197
198       Show Device:
199              show [-display|-d (Attributes)] [-all|-a] [-units|-u] [-help|-h]
200              [-output|-o  (text|nvmxml|verbose)]  -dimm  [(DimmIDs)] [-socket
201              (SocketIDs)]
202
203       Modify Device:
204              set [-force|-f]  [-help|-h]  [-output|-o  (text|nvmxml|verbose)]
205              -dimm  [(DimmIDs)]  [FirstFastRefresh  =  (0|1)]  [ViralPolicy =
206              (0|1)]
207
208       Set Firmware Log Level:
209              set [-help|-h] [-output|-o (text|nvmxml|verbose)]  -dimm  [(Dim‐
210              mIDs)] FwLogLevel = (Disabled|Error|Warning|Info|Debug)
211
212       Change Device Passphrase:
213              set  [-source  (path)]  [-help|-h] [-output|-o (text|nvmxml|ver‐
214              bose)] -dimm [(DimmIDs)] Passphrase = [(string)] NewPassphrase =
215              [(string)] ConfirmPassphrase = [(string)]
216
217       Enable Device Security:
218              set  [-source  (path)]  [-help|-h] [-output|-o (text|nvmxml|ver‐
219              bose)] -dimm [(DimmIDs)]  NewPassphrase  =  [(string)]  Confirm‐
220              Passphrase = [(string)]
221
222       Change Device Security:
223              set  [-source  (path)]  [-help|-h] [-output|-o (text|nvmxml|ver‐
224              bose)] -dimm [(DimmIDs)] LockState =  (Unlocked|Disabled|Frozen)
225              [Passphrase = [(string)] ]
226
227       Erase Device Data:
228              delete   [-source  (path)]  [-force|-f]  [-help|-h]  [-output|-o
229              (text|nvmxml|verbose)] -dimm [(DimmIDs)] Passphrase = [(string)]
230
231       Show Memory Resources:
232              show [-units|-u] [-help|-h]  [-output|-o  (text|nvmxml|verbose)]
233              -memoryresources
234
235       Show System Capabilities:
236              show [-display|-d (Attributes)] [-all|-a] [-units|-u] [-help|-h]
237              [-output|-o (text|nvmxml|verbose)] -system -capabilities
238
239       Show Topology:
240              show [-display|-d (Attributes)] [-all|-a] [-units|-u] [-help|-h]
241              [-output|-o  (text|nvmxml|verbose)]  -topology [-dimm (DimmIDs)]
242              [-socket (SocketIDs)]
243
244       Show Socket:
245              show [-display|-d (Attributes)]  [-units|-u]  [-help|-h]  [-out‐
246              put|-o (text|nvmxml|verbose)] -socket [(SocketIDs)]
247
248       Inject Error:
249              set  [-help|-h]  [-output|-o (text|nvmxml|verbose)] -dimm [(Dim‐
250              mIDs)]  [Clear  =  1]  [Temperature  =  (degrees)]   [Poison   =
251              (address)]   [PoisonType  =  (PatrolScrub|MemoryMode|AppDirect)]
252              [DieSparing = 1]  [SpareCapacity  =  1]  [FatalMediaError  =  1]
253              [DirtyShutdown = 1]
254
255

OPTIONS

257       -all|-a
258              Show  all  attributes.  Note:  The  all  and display options are
259              exclusive and may not be used together.
260
261       -display|-d (Attributes)
262              Filter the returned attributes by explicitly specifying a  comma
263              separated  list  of  any of the attributes defined in the Return
264              Data section. Note: The all and display  options  are  exclusive
265              and may not be used together.
266
267       -help|-h
268              Display help for the command.
269
270       -output|-o text|nvmxml
271              Change the output format. One of: "text" (default) or "nvmxml".
272
273
274

EXIT CODES

276       0      The operation succeeded.
277
278       1      A general error occurred when executing the operation.
279
280       2      There was not enough memory to complete the requested operation.
281
282       3      The command is not supported in the current context.
283
284       201    Syntax error.
285
286

EXAMPLE

288       ixpdimm-cli show -dimm
289              Show default information about all DIMMs
290
291       ixpdimm-cli show -a -dimm 1234
292              Show all information about DIMM 1234.
293
294       ixpdimm-cli show -d HealthState,LockState -dimm
295              Show HealthState and LockState information for all DIMMs.
296
297       ixpdimm-cli set -source mypassphrase.file -dimm 1234
298       NewPassphrase="" ConfirmPassphrase=""
299              Set a passphrase on DIMM 1234 by supplying the passphrase in the
300              file mypassphrase.file.  The format of the file would be:
301                     #ascii
302                     NewPassphrase=myNewPassphrase
303
304       ixpdimm-cli create -goal -dimm 1234 PersistentMemoryType=AppDirect
305              Configure the capacity on a specific DIMM in AppDirect Mode.
306
307       ixpdimm-cli set -sensor MediaTemperature -dimm 1234  NonCriticalThresh‐
308       old=51 EnabledState=1
309              Change  the  media  temperature threshold to 51 on the specified
310              DIMM and enable the alarm.
311
312       ixpdimm-cli show -dimm -performance BytesRead
313              Show the number of bytes read for all DIMMs in the server.
314
315       ixpdimm-cli show -a -namspace 12345678-1234-1234-1234-123456789012
316              Show all attributes for the specified namespace
317
318       ixpdimm-cli             create             -namespace             -pool
319       12345678-1234-1234-1234-123456789012
320       Type=Storage BlockSize=512 BlockCount=2097152
321              Create     a     1     GB     Storage    namespace    on    pool
322              12345678-1234-1234-1234-123456789012 with a block size of 512
323
324

FILES

326       /usr/share/nvdimm-mgmt/apss.dat
327       /usr/share/nvdimm-mgmt/public.rev0.pem
328
329
330

AUTHOR

336       Created by Intel Corporation.
337
338
339
340                                 May 29, 2018                   ixpdimm-cli(8)