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              show [-all|-a] [-display|-d (Attributes)] [-help|-h] [-output|-o
45              (text|nvmxml)] -firmware -dimm [(DimmIDs)]
46
47       Update Firmware:
48              load  -source (path) [-force|-f] [-examine|-x] [-help|-h] [-out‐
49              put|-o (text|nvmxml)] -dimm [(DimmIDs)]
50
51       Show Device Performance:
52              show [-help|-h]  [-output|-o  (text|nvmxml)]  -dimm  [(DimmIDs)]
53              -performance            [(BytesRead|BytesWritten|HostReads|Host‐
54              Writes|BlockWrites|BlockReads)]
55
56       Run Diagnostic:
57              start   [-help|-h]   [-output|-o   (text|nvmxml)]    -diagnostic
58              [(Quick|Config|PM|Security|FW)] [-dimm (DimmIDs)]
59
60       Create Support Snapshot:
61              create  [-help|-h]  [-output|-o  (text|nvmxml)] -support [Name =
62              (string)]
63
64       Dump Support Data:
65              dump -destination (path) [-help|-h]  [-output|-o  (text|nvmxml)]
66              -support
67
68       Delete Support Data:
69              delete [-help|-h] [-output|-o (text|nvmxml)] -support
70
71       Toggle Software Logging:
72              set  [-help|-h]  [-output|-o  (text|nvmxml)]  -system LogLevel =
73              (0|1)
74
75       Version:
76              version [-help|-h] [-output|-o (text|nvmxml)]
77
78       Acknowledge event:
79              set  [-help|-h]  [-output|-o  (text|nvmxml)]  -event   (EventID)
80              ActionRequired = (false|0)
81
82       Show Events:
83              show      [-starttime      (MM:dd:yyyy:hh:mm:ss)]      [-endtime
84              (MM:dd:yyyy:hh:mm:ss)]  [-help|-h]  [-output|-o   (text|nvmxml)]
85              -event  [(EventID)]  [-dimm (DimmID)] [-namespace (NamespaceID)]
86              [Severity    =    (Info|Warn|Critical|Fatal)]    [Category     =
87              (Diag|FW|PlatformConfig|PM|Quick|Security|Health|Mgmt)] [Action‐
88              Required = (1|0)]
89
90       Show Preferences:
91              show [-help|-h] [-output|-o (text|nvmxml)] -preferences
92
93       Change Preferences:
94              set   [-help|-h]   [-output|-o    (text|nvmxml)]    -preferences
95              [CLI_DEFAULT_DIMM_ID   =   (HANDLE|UID)]   [CLI_DEFAULT_SIZE   =
96              (Auto|B|MiB|GiB)] [PERFORMANCE_MONITOR_ENABLED = (0|1)] [PERFOR‐
97              MANCE_MONITOR_INTERVAL_MINUTES    =    (minutes)]   [EVENT_MONI‐
98              TOR_ENABLED =  (0|1)]  [EVENT_MONITOR_INTERVAL_MINUTES  =  (min‐
99              utes)]  [EVENT_LOG_MAX  =  (count)]  [LOG_MAX  =  (count)] [SUP‐
100              PORT_SNAPSHOT_MAX = (count)]
101
102       Help:
103              help [-help|-h] [-output|-o (text|nvmxml)]  [Name  =  (command)]
104              [verb = (verb)]
105
106       Show Namespace:
107              show  [-all|-a]  [-display|-d  (Attributes)] [-units [(GB|GiB)]]
108              [-help|-h]  [-output|-o   (text|nvmxml)]   -namespace   [(Names‐
109              paceIDs)] [-pool (PoolIDs)] [Type = (Unknown|AppDirect|Storage)]
110              [HealthState = (Unknown|Healthy|Warning|Critical|BrokenMirror)]
111
112       Create Namespace:
113              create [-force|-f] [-units  [(GB|GiB)]]  [-help|-h]  [-output|-o
114              (text|nvmxml)]  -namespace  [-pool  [(PoolIDs)]]  Type = (AppDi‐
115              rect|Storage) [BlockSize = (size)] [BlockCount = (count)]  [Name
116              =   (string)]   [Optimize   =   (CopyOnWrite|None)]  [Enabled  =
117              (0|1|False|True)] [Encryption = (0|1|False|True)]  [EraseCapable
118              =  (0|1|False|True)]  [AppDirectSetting  =  (value)] [Capacity =
119              (capacity)] [MemoryPageAllocation = (None|DRAM|AppDirect)]
120
121       Modify Namespace:
122              set [-force|-f] [-help|-h] [-output|-o (text|nvmxml)] -namespace
123              [(NamespaceIDs)]   [Name  =  (string)]  [BlockCount  =  (count)]
124              [Enabled = (0|1)] [Capacity = (capacity)]
125
126       Delete Namespace:
127              delete [-force|-f] [-help|-h] [-output|-o (text|nvmxml)] -names‐
128              pace [(NamespaceIDs)]
129
130       Show Memory Allocation Goal:
131              show [-all|-a] [-display|-d (Attributes)] [-help|-h] [-output|-o
132              (text|nvmxml)] [-dimm (DimmIDs)] -goal [-socket (SocketIDs)]
133
134       Delete Memory Allocation Goal:
135              delete [-help|-h] [-output|-o (text|nvmxml)]  [-dimm  (DimmIDs)]
136              -goal [-socket (SocketIDs)]
137
138       Create Memory Allocation Goal:
139              create  [-force|-f] [-help|-h] [-output|-o (text|nvmxml)] [-dimm
140              (DimmIDs)] [-socket  (SocketIDs)]  -goal  [MemorySize  =  (GiB)]
141              [AppDirectSize  =  (GiB)]  [AppDirectSetting  = (value)] [AppDi‐
142              rect1Size = (GiB)] [AppDirect1Setting = (value)] [AppDirect2Size
143              =  (GiB)]  [AppDirect2Setting  =  (value)] [ReserveDimm = (0|1)]
144              [StorageCapacity = (Remaining)]
145
146       Show Persistent Memory:
147              show [-display|-d (Attributes)]  [-all|-a]  [-units  [(GB|GiB)]]
148              [-help|-h] [-output|-o (text|nvmxml)] -pool [(PoolIDs)] [-socket
149              (SocketIDs)]
150
151       Dump Memory Allocation Settings:
152              dump -destination (path) [-help|-h]  [-output|-o  (text|nvmxml)]
153              -system -config
154
155       Load Memory Allocation Goal:
156              load   [-force|-f]   -source   (path)   [-help|-h]   [-output|-o
157              (text|nvmxml)] -goal [-dimm (DimmIDs)] [-socket (SocketIDs)]
158
159       Show Sensor:
160              show [-display|-d (Attributes)] [-all|-a] [-help|-h] [-output|-o
161              (text|nvmxml)]   -sensor   [(MediaTemperature|ControllerTempera‐
162              ture|SpareCapacity|WearLevel|UnsafeShutdowns|PowerOn‐
163              Time|UpTime|PowerCycles|FWErrorCount|PowerLimited|MediaErrorsUn‐
164              correctable|MediaErrorsCorrected|MediaErrorsErasureCoded|Write‐
165              CountMax|WriteCountAvg|MediaErrorsHost|MediaErrorsNonHost)]
166              [-dimm (DimmIDs)]
167
168       Change Sensor Settings:
169              set [-force|-f] [-help|-h]  [-output|-o  (text|nvmxml)]  -sensor
170              (MediaTemperature|ControllerTemperature|SpareCapacity)    [-dimm
171              (DimmIDs)]  [NonCriticalThreshold  =  (value)]  [EnabledState  =
172              (0|1)]
173
174       Load Simulator:
175              load  [-source  (path)]  [-help|-h]  [-output|-o  (text|nvmxml)]
176              -system [unload = (0|1)]
177
178       Show Host Server:
179              show [-all|-a] [-display|-d (Attributes)] [-help|-h] [-output|-o
180              (text|nvmxml)] -system
181
182       Show Device:
183              show [-display|-d (Attributes)] [-all|-a] [-help|-h] [-output|-o
184              (text|nvmxml)] -dimm [(DimmIDs)] [-socket (SocketIDs)]
185
186       Modify Device:
187              set  [-force|-f]  [-help|-h]  [-output|-o  (text|nvmxml)]  -dimm
188              [(DimmIDs)] [FirstFastRefresh = (0|1)] [ViralPolicy = (0|1)]
189
190       Set Firmware Logging:
191              set  [-help|-h]  [-output|-o  (text|nvmxml)]  -dimm  [(DimmIDs)]
192              FwLogLevel = (Disabled|Error|Warning|Info|Debug)
193
194       Change Device Passphrase:
195              set [-source (path)] [-help|-h] [-output|-o (text|nvmxml)] -dimm
196              [(DimmIDs)]  Passphrase  = [(string)] NewPassphrase = [(string)]
197              ConfirmPassphrase = [(string)]
198
199       Enable Device Security:
200              set [-source (path)] [-help|-h] [-output|-o (text|nvmxml)] -dimm
201              [(DimmIDs)]   NewPassphrase  =  [(string)]  ConfirmPassphrase  =
202              [(string)]
203
204       Change Device Security:
205              set [-source (path)] [-help|-h] [-output|-o (text|nvmxml)] -dimm
206              [(DimmIDs)]   LockState   =   (Unlocked|Disabled)  Passphrase  =
207              [(string)]
208
209       Erase Device Data:
210              delete  [-source  (path)]  [-force|-f]  [-help|-h]   [-output|-o
211              (text|nvmxml)] -dimm [(DimmIDs)] Passphrase = [(string)]
212
213       Show Memory Resources:
214              show [-help|-h] [-output|-o (text|nvmxml)] -memoryresources
215
216       Show System Capabilities:
217              show [-display|-d (Attributes)] [-all|-a] [-help|-h] [-output|-o
218              (text|nvmxml)] -system -capabilities
219
220       Show Topology:
221              show [-display|-d (Attributes)] [-all|-a] [-help|-h] [-output|-o
222              (text|nvmxml)] -topology [-dimm (DimmIDs)] [-socket (SocketIDs)]
223
224       Inject Error:
225              set  [-help|-h]  [-output|-o  (text|nvmxml)]  -dimm  [(DimmIDs)]
226              [Clear = 1 [Temperature = (degrees)] [Poison = (address)] [DieS‐
227              paring = 1 [SpareAlarm = 1 [FatalMediaError = 1
228
229

OPTIONS

231       -all|-a
232              Show  all  attributes.  Note:  The  all  and display options are
233              exclusive and may not be used together.
234
235       -display|-d (Attributes)
236              Filter the returned attributes by explicitly specifying a  comma
237              separated  list  of  any of the attributes defined in the Return
238              Data section. Note: The all and display  options  are  exclusive
239              and may not be used together.
240
241       -help|-h
242              Display help for the command.
243
244       -output|-o text|nvmxml
245              Change the output format. One of: "text" (default) or "nvmxml".
246
247
248

EXIT CODES

250       0      The operation succeeded.
251
252       1      A general error occurred when executing the operation.
253
254       2      There was not enough memory to complete the requested operation.
255
256       3      The command is not supported in the current context.
257
258

EXAMPLE

260       ixpdimm-cli show -dimm
261              Show default information about all DIMMs
262
263       ixpdimm-cli show -a -dimm 1234
264              Show all information about DIMM 1234.
265
266       ixpdimm-cli show -d HealthState,LockState -dimm
267              Show HealthState and LockState information for all DIMMs.
268
269       ixpdimm-cli set -source mypassphrase.file -dimm 1234
270       NewPassphrase="" ConfirmPassphrase=""
271              Set a passphrase on DIMM 1234 by supplying the passphrase in the
272              file mypassphrase.file.  The format of the file would be:
273                     #ascii
274                     NewPassphrase=myNewPassphrase
275
276       ixpdimm-cli create -goal VolatileSize=32 PersistentSize=Remaining  Per‐
277       sistentSettings=4KB_4KB
278              Configure the capacity on each DIMM with 32 GiB of volatile mem‐
279              ory, and the  remaining  persistent  memory  with  specific  QoS
280              attributes.
281
282       nvncli  set  -sensor  MediaTemperature  -dimm 1234 CriticalThreshold=51
283       EnabledState=1
284              Change the media temperature threshold to 51  on  the  specified
285              DIMM and enable the alarm.
286
287       ixpdimm-cli show -dimm -performance BytesRead
288              Show the number of bytes read for all DIMMs in the server.
289
290       nvncli  set  -sensor  MediaTemperature  -dimm 1234 CriticalThreshold=51
291       EnabledState=1
292              Change the media temperature threshold to 51  on  the  specified
293              DIMM and enable the alarm.
294
295       ixpdimm-cli show -a -namspace 12345678-1234-1234-1234-123456789012
296              Show all attributes for the specified namespace
297
298       ixpdimm-cli             create             -namespace             -pool
299       12345678-1234-1234-1234-123456789012
300       Type=Storage BlockSize=512 BlockCount=2097152
301              Create    a    1    GB     Storage     namespace     on     pool
302              12345678-1234-1234-1234-123456789012 with a block size of 512
303
304

FILES

306       /usr/share/nvdimm-mgmt/apss.dat
307       /usr/share/nvdimm-mgmt/public.rev0.pem
308
309
310

AUTHOR

316       Created by Intel Corporation.
317
318
319
320                               November 11, 2016                ixpdimm-cli(8)