1LSMCLI(1) libStorageMgmt LSMCLI(1)
2
3
4
6 lsmcli - libStorageMgmt command line interface
7
8
10 lsmcli command [GLOBAL OPTIONS]...[COMMAND OPTIONS]...
11
12
14 lsmcli is the command line tool for the libStorageMgmt library. This
15 tool allows users to do one off storage related management operations
16 or to script management of their storage.
17
18
20 * libStorageMgmt daemon.
21 The daemon 'lsmd' is required by lsmcli.
22
23 * URI(Uniform Resource Identifier)
24 URI is used to identify which plugin to use and how the plugin
25 should communicate with the storage array. The valid URI format
26 is:
27 plugin://<username>@host:<port>?<query_string_parameters>
28 plugin+ssl://<username>@host:<port>?<query_string_parameters>
29 Examples, please refer to "LibStorageMgmt User Guide" for more
30 details:
31 * Simulator:
32 sim://
33 simc://
34 * SMI-S supported arrays (eg. EMC CX/VNX, HDS AMS, IBM
35 SVC/DS, LSI MegaRAID and others):
36 smis://username@host:<port>?namespace=<namespace>
37 smis+ssl://username@host:<port>?namespace=<namespace>
38 You can pass URI to lsmcli via one of these methods:
39 * Using '-u, --uri' argument.
40 * Using 'LSMCLI_URI' environment variable.
41 * Add this line into $HOME/.lsmcli:
42 uri=<URI>
43
44 * Password
45 For storage array password authentication you can pass it to
46 lsmcli via one of the following methods:
47 * '-P, --prompt' argument to prompt for password.
48 * 'LSMCLI_PASSWORD' environment variable.
49
51 --version Show program's version number and exit
52
53 -h, --help Show this help message and exit. Will show help message
54 of specific command if specified.
55
56 -u <URI>, --uri <URI>
57 Uniform Resource Identifier (env LSMCLI_URI)
58
59 -P, --prompt Prompt for password (env LSMCLI_PASSWORD)
60
61 -H, --human Print sizes in human readable format (e.g., KiB, MiB,
62 GiB, TiB, PiB, EiB)
63
64 -t <SEP>, --terse <SEP>
65 Print output in terse form with "SEP" as a record sepa‐
66 rator without header unless '--header' defined.
67
68 --header Include the header with terse
69
70 -e, --enum Display enumerated types as numbers instead of text
71
72 -f, --force Bypass confirmation prompt for data loss operations
73
74 -w <WAIT>, --wait=<WAIT>
75 Command timeout value in ms (default = 30s)
76
77 -b Run the command asynchronously instead of waiting for
78 completion. The lsmcli command will exit with exit
79 code(7) and job id will be written to STDOUT when a com‐
80 mand is still executing on the storage array. Use 'job-
81 status --id <job id>' to inquire on the progress of the
82 command. Some arrays or plugins might not support asyn‐
83 chronous operations, in those circumstances, -b will be
84 ineffective. Command will wait until finished.
85
86 -s, --script Displaying data in script friendly way.
87 Without this option, data is displayed in this manner
88 (default):
89
90 ID | Name | Element Type ...
91 ------------------------------------------ ...
92 aggr0 | aggr0 | FS,SYSTEM_RESERVED,POOL ...
93 iscsi | iscsi | FS,POOL ...
94
95
96 With this option, data is displayed in this manner.
97
98 -----------------------------------------------
99 ID | aggr0
100 Name | aggr0
101 Element Type | FS,SYSTEM_RESERVED,POOL
102 ...
103 -----------------------------------------------
104 ID | iscsi
105 Name | iscsi
106 Element Type | FS,POOL
107 ...
108
109 Please note:
110 To reduce the width of output, NOT all properties will
111 be displayed in default column display.
112
113
115 list
116 List information on LSM objects
117
118 --type <TYPE> Required. Valid values are (case insensitive):
119 VOLUMES, POOLS, FS, SNAPSHOTS, EXPORTS, NFS_CLIENT_AUTH,
120 ACCESS_GROUPS, SYSTEMS, DISKS, PLUGINS, TARGET_PORTS,
121 BATTERIES.
122
123
124 --fs <FS_ID> Required for --type=SNAPSHOTS, list the snapshots of
125 specific filesystem. Optional for type EXPORTS, list
126 the NFS export for specific filesystem. Optional for
127 type FS, list specific filesystem.
128
129 --sys <SYS_ID> Optional. Search resources from system with SYS_ID.
130 Only supported when querying these types of resources:,
131 VOLUMES, POOLS, FS, DISKS, ACCESS_GROUPS, TARGET_PORTS
132 BATTERIES.
133
134 --pool <POOL_ID>
135 Optional. Search resources from pool with POOL_ID. Only
136 supported by these types of resources: VOLUMES, POOLS,
137 FS.
138
139 --vol <VOL_ID> Search resources from volume with VOL_ID. Only supported
140 by these types of resources: VOLUMES, ACCESS_GROUPS.
141 To query volume masking status, please use this command:
142 lsmcli list --type ACCESS_GROUPS --vol <VOL_ID>
143
144 --disk <DISK_ID>
145 Search resources from disk with DISK_ID. Only supported
146 by these types of resources: DISK.
147
148 --ag <AG_ID> Search resources from access group with AG_ID. Only sup‐
149 ported by these types of resources: ACCESS_GROUPS, VOL‐
150 UMES.
151 To query volume masking status, please use this command:
152 lsmcli list --type VOLUMES --ag <AG_ID>
153
154 --nfs-export <NFS_EXPORT_ID>
155 Search resources from NFS export with NFS_EXPORT_ID.
156 Only supported by these types of resources: EXPORTS.
157
158 --tgt <TGT_ID> Search resources from target port with target port ID.
159 Only supported by these types of resources: TAR‐
160 GET_PORTS.
161
162
163 job-status
164 Retrieve information about a job. Please see user guide on how to use.
165
166 --job <JOB_ID>
167
168
169 capabilities
170 Retrieves array capabilities.
171
172 --sys <SYS_ID> Required. ID of the system to query for capabilities.
173
174
175 plugin-info
176 Retrieves plugin description and version for current URI.
177
178
179 volume-create
180 Creates a volume (AKA., logical volume, virtual disk, LUN).
181
182 --name <NAME> Required. Volume name.
183
184 --size <SIZE> Required. Volume size (See SIZE OPTION for allowed for‐
185 mats).
186
187 --pool <POOL_ID>
188 Required. ID of pool.
189
190 --provisioning <THINP_TYPE>
191 Optional. Provisioning type. Valid values are: DEFAULT,
192 THIN, FULL. DEFAULT means let plugin choose. THIN means
193 requiring a Thin Provisioning enabled volume. FULL means
194 requiring a fully allocated volume.
195
196
197 volume-raid-create
198 Creates a volume on hardware RAID on given disks.
199
200 --name <NAME> Required. Volume name. Might be altered or ignored due
201 to hardware RAID card vendor limitation.
202
203 --raid-type <RAID_TYPE>
204 Required. Could be one of these values: RAID0, RAID1,
205 RAID5, RAID6, RAID10, RAID50, RAID60. The supported RAID
206 types of current RAID card could be queried via command
207 "volume-raid-create-cap".
208
209 --disk <DISK_ID>
210 Required. Repeatable. The disk ID for new RAID group.
211
212 --strip-size <STRIP_SIZE>
213 Optional. The size in bytes of strip on each disks. If
214 not defined, will let hardware card to use the vendor
215 default value. The supported stripe size of current RAID
216 card could be queried via command "volume-raid-create-
217 cap".
218
219
220 volume-raid-create-cap
221 Query support status of volume-raid-create command for current hardware
222 RAID card.
223
224 --sys <SYS_ID> Required. ID of the system to query for capabilities.
225
226
227 volume-ident-led-on
228 Enable the IDENT LEDs for all physical disks that compose a logical
229 volume.
230
231 --vol <VOL_ID> Required. ID of the volume being targeted.
232
233
234 volume-ident-led-off
235 Disable the IDENT LEDs for all physical disks that compose a logical
236 volume.
237
238 --vol <VOL_ID> Required. ID of the volume being targeted.
239
240
241 volume-delete
242 Delete a volume given its ID
243
244 --vol <VOL_ID> Required. The ID of volume to delete.
245
246
247 volume-resize
248 Re-sizes a volume, requires:
249
250 --vol <VOL_ID> Required. The ID of volume to resize.
251
252 --size <NEW_SIZE>
253 Required. The new size of volume.(See SIZE OPTION for
254 allowed formats). Due to boundary alignment concern,
255 array might return a volume with slightly bigger size
256 than requested.
257
258
259 volume-replicate
260 Creates a new volume and replicates provided volume to it.
261
262 --vol <VOL_ID> Required. The ID of volume to replicate.
263
264 --name <NAME> Required. The name for new volume to hold replicated
265 data.
266
267 --rep-type <REPL_TYPE> (see VOLUME REPLICATION TYPES)
268 Required. Valid types of replication are:
269 CLONE, COPY, MIRROR_ASYNC, MIRROR_SYNC.
270
271 --pool <POOL_ID>
272 Optional. The ID of pool where the new volume should be
273 created from. If not specified, plugin or array will
274 choose appropriate pool.
275
276
277 volume-replicate-range
278 Replicates a portion of a volume to the same volume or to a different
279 volume.
280
281 --src-vol <SRC_VOL_ID>
282 Required. The ID of replication source volume.
283
284 --dst-vol <DST_VOL_ID>
285 Required. The ID of replication destination volume.
286
287 --rep-type <REPL_TYPE> (see VOLUME REPLICATION TYPES)
288 Required. Appropriate types of replication are:
289 CLONE, COPY.
290
291 --src-start <SRC_START_BLK>
292 Required. Replication source volume start block number.
293 Must in pair with --count and --dst-start. If you have
294 several non-continuous block ranges, you can define
295 repeatly define this arugument, like '--src-start 0
296 --dst-start 0 --count 1024 --src-start 2048 --dst-start
297 2048 --count 2048'
298
299 --dst-start <DST_START_BLK>
300 Required. Replication destination volume start block
301 number. Must in pair with --count and --src-start.
302
303 --count <BLK_COUNT>
304 Required. ThRe cboluonctk.of rMeupslticiantepdaibrlowcikth s-t-asrrtct-isntgartfraonmd
305 --src-start
306 --dst-start.
307
308
309 volume-replicate-range-block-size
310 Size of each replicated block on a system in bytes.
311
312 --sys <SYS_ID> Required. ID of the system to query for replicated block
313 size.
314
315
316 volume-dependants
317 Returns True if volume has a dependant child, like replication.
318
319 --vol <VOL_ID> Required. The ID of volume to query dependency.
320
321
322 volume-dependants-rm
323 Removes volume dependencies(like replication).
324
325 --vol <VOL_ID> Required. The ID of volume to remove dependency.
326
327
328 volume-access-group
329 Lists the access group(s) that have access to the provided volume.
330
331 --vol <VOL_ID> Required. The ID of volume to query access.
332
333
334 volume-mask
335 Grant access group RW access to specific volume. Like LUN masking
336 or NFS export.
337
338 --vol <VOL_ID> Required. The ID of volume to access.
339
340 --ag <AG_ID> Required. The ID of access group to grant.
341
342
343 volume-unmask
344 Revoke access group RW access to specified volume.
345
346 --vol <VOL_ID> Required. The ID of volume to revoke.
347
348 --ag <AG_ID> Required. The ID of access group to revoke.
349
350
351 volume-enable
352 Enable block access of specified volume.
353
354 --vol <VOL_ID> Required. The ID of volume to enable access.
355
356
357 volume-disable
358 Disable block access of specified volume.
359
360 --vol <VOL_ID> Required. The ID of volume to disable access.
361
362
363 volume-raid-info
364 Query RAID information for given volume.
365
366 --vol <VOL_ID> Required. The ID of volume to query.
367
368
369 pool-member-info
370 Query RAID information for given pool.
371
372 --pool <POOL_ID>
373 Required. The ID of pool to query.
374
375
376 access-group-create
377 Create an access group.
378
379 --name <AG_NAME>
380 Required. The human friendly name for new access group.
381
382 --init <INIT_ID>
383 Required. The first initiator ID of new access group.
384 WWPN or iSCSI IQN.
385
386 --sys <SYS_ID> Required. The ID of system where this access group
387 should reside on.
388
389
390 access-group-add
391 Adds an initiator to an access group.
392
393 --ag <AG_ID> Required. ID of access group.
394
395 --init <INIT_ID>
396 Required. ID of initiator to add. WWPN or iSCSI IQN.
397
398
399 access-group-remove
400 Removes an initiator from an access group.
401
402 --ag <AG_ID> Required. ID of access group.
403
404 --init <INIT_ID>
405 Required. ID of initiator to remove.
406
407
408 access-group-delete
409 Delete an access group.
410
411 --ag <AG_ID> Required. ID of access group to delete.
412
413
414 access-group-volumes
415 Lists the volumes that the access group has been granted access to.
416
417 --ag <AG_ID> Required. The ID of access group to query.
418
419
420 iscsi-chap
421 Configures ISCSI inbound/outbound CHAP authentication.
422
423 --init <INIT_ID>
424 Required. The ID of iSCSI initiator to configure.
425
426 --in-user <IN_USER>
427 Optional. Inbound CHAP user name.
428
429 --in-pass <IN_PASS>
430 Optional. Inbound CHAP password.
431
432 --out-user <OUT_USER>
433 Optional. Outbound CHAP user name.
434
435 --out-pass <OUT_PASS>
436 Optional. Outbound CHAP password.
437
438
439 fs-create
440 Creates a filesystem.
441
442 --name <NAME> Required. Human friendly name for new filesystem.
443
444 --size <SIZE> Required. Volume size(See SIZE OPTION for allowed for‐
445 mats).
446
447 --pool <POOL_ID>
448 Required. ID of pool to hold the new filesystem.
449
450
451 fs-delete
452 Delete a filesystem.
453
454 --fs <FS_ID> Required. ID of the filesystem to delete.
455
456
457 fs-resize
458 Resizes a filesystem.
459
460 --fs <FS_ID> Required. ID of the filesystem to resize.
461
462 --size <NEW_SIZE>
463 Required. New size of filesystem. See SIZE OPTION for
464 allowed formats.
465
466
467 fs-export
468 Export a filesystem via NFS.
469
470 --fs <FS_ID> Required. ID of the filesystem to export.
471
472 --exportpath <EXPORT_PATH>
473 Optional. NFS server export path. e.g. '/foo/bar'.
474
475 --anonuid <ANONY_UID>
476 Optional. The UID(User ID) to map to anonymous user.
477
478 --anongid <ANONY_GID>
479 Optional. The GID(Group ID) to map to anonymous user.
480
481 --auth-type <AUTH_TYPE>
482 Optional. NFS client authentication type. This is just a
483 place holder, not supported yet.
484
485 --root-host <ROOT_HOST>
486 Optional. Repeatable. The host/IP has root access. For
487 two or more hosts/IPs: --root-host hostA --root-host
488 hostB.
489
490 --ro-host <RO_HOST>
491 Optional. Repeatable. The host/IP has read only access.
492 For two or more hosts/IPs: '--ro-host hostA --ro-host
493 hostB'.
494
495 --rw-host <RW_HOST>
496 Optional. The host/IP has read/write access. For two or
497 more hosts/IPs: --rw-host hostA --rw-host hostB.
498
499
500 fs-unexport
501 Remove an NFS export.
502
503 --export <EXPORT_ID>
504 Required. ID of the export to unexport.
505
506
507 fs-clone
508 Creates a file system clone. The 'clone' means point in time read
509 writeable space efficient copy of data, AKA. read-writable snapshot.
510
511 --src-fs <SRC_FS_ID>
512 Required. The ID of the filesystem to clone.
513
514 --dst-name <DST_FS_NAME>
515 Required. The name for newly created destination file
516 system.
517
518 --backing-snapshot <BE_SS_ID>
519 Optional. Make a FS clone using a previously created
520 snapshot.
521
522
523 fs-snap-create
524 Creates a snapshot of specified filesystem. A snapshot is defined as a
525 read only space efficient point in time copy (PIT) of a filesystem.
526 The source filesystem remains modifiable.
527
528 --name <SNAP_NAME>
529 Required. The human friendly name of new snapshot.
530
531 --fs <FS_ID> Required. The ID of filesystem to create snapshot
532 against.
533
534
535 fs-snap-delete
536 Deletes a snapshot.
537
538 --snap <SNAP_ID>
539 Required. The ID of snapshot to delete.
540
541 --fs <FS_ID> Required. The ID of filesystem.
542
543
544 fs-snap-restore
545 Restores a FS or specified files to previous snapshot state. This will
546 discard all the changes to filesystem since snapshot if specific files
547 are not specified in restore.
548
549 --fs <FS_ID> Required. The ID of filesystem to restore.
550
551 --snap <SNAP_ID>
552 Required. The ID of snapshot to restore.
553
554 --file <FILE_PATH>
555 Optional. Repeatable. With this option defined, will
556 only restore the defined file(s). --file fileA --file
557 pathB.
558
559 --fileas <NEW_FILE_PATH>
560 Optional. Repeatable. With this option defined, the
561 restored file will be saved to specified path and file‐
562 name, eg. '--file fileA --fileas old_fileA '.
563
564
565 fs-dependants
566 Returns True if a child dependency (snapshot or clone) exists.
567
568 --fs <FS_ID> Required. The ID of filesystem to query.
569
570 --file <FILE_PATH>
571 Optional. Repeatable. Only check for dependencies on
572 specific file(s), eg. '--file fileA --file pathB'.
573
574
575 fs-dependants-rm
576 Removes filesystem dependencies(snapshot or clone).
577
578 --fs <FS_ID> Required. The ID of filesystem to remove dependency.
579
580 --file <FILE_PATH>
581 Optional. Repeatable. Only remove dependencies on spe‐
582 cific file(s), eg. '--file fileA --file pathB'.
583
584
585 file-clone
586 Creates a clone of a file (thin provisioned). Note: --src and --dst
587 need to be paired
588 eg. '--src fileA --src fileB --dst fileA_clone --dst fileB_clone'.
589
590 --fs <FS_ID> Required. The ID of filesystem to clone.
591
592 --src <SRC_FILE_PATH>
593 Required. Repeatable. Source file to clone (relative
594 path).
595
596 --dst <DST_FILE_PATH>
597 Required. Repeatable. Destination file for clone (rela‐
598 tive path).
599
600 --backing-snapshot <SNAP_ID>
601 Optional. Use the source file from previously created
602 snapshot.
603
604
605 system-read-cache-pct-update
606 Change the read cache percentage for a system.
607
608 --sys <SYS_ID> Required. ID of the system being targeted.
609
610 --read-pct <READ_PCT>
611 The desired percentage of read cache for the targeted
612 system. Write cache will be automatically changed to the
613 remaining percentage available after updating the read
614 cache (if supported by the system).
615
616
617 local-disk-list
618 List all disks found on current local operating system. Require per‐
619 mission to open /dev/sdX as read-only, normally root user or disk group
620 would have sufficient permission.
621
622
623 volume-cache-info
624 Query RAM cache information for the desired volume.
625
626 --vol <VOL_ID> Required. ID of the volume to query cache information.
627
628
629 volume-phy-disk-cache-update
630 Disable or enable RAM physical disk cache of specific volume.
631
632 --vol <VOL_ID> Required. ID of the volume to change.
633
634 --policy <POLICY>
635 Required. Enable or Disable.
636
637
638 volume-read-cache-policy-update
639 Disable or enable RAM read cache of specific volume.
640
641 --vol <VOL_ID> Required. ID of the volume to change.
642
643 --policy <POLICY>
644 Required. Enable or Disable.
645
646
647 volume-write-cache-policy-update
648 Change volume write cache policy.
649
650 --vol <VOL_ID> Required. ID of the volume to change.
651
652 --policy <POLICY>
653 Required. WB for write back mode, WT for write through
654 mode, AUTO for auto mode which use WB mode when any bat‐
655 tery is OK and use WT mode else.
656
657
658 local-disk-ident-led-on
659 Turn on the identification LED for specified disk path. Require per‐
660 mission to open disk path as read-write, normally root user or disk
661 group would have sufficient permission.
662
663 --path <DISK_PATH>
664 Required. Disk path, like /dev/sdb.
665
666
667 local-disk-ident-led-off
668 Turn off the identification LED for specified disk path. Require per‐
669 mission to open disk path as read-write, normally root user or disk
670 group would have sufficient permission.
671
672 --path <DISK_PATH>
673 Required. Disk path, like /dev/sdb.
674
675
676 local-disk-fault-led-on
677 Turn on the fault LED for specified disk path. Require permission to
678 open disk path as read-write, normally root user or disk group would
679 have sufficient permission.
680
681 --path <DISK_PATH>
682 Required. Disk path, like /dev/sdb.
683
684
685 local-disk-fault-led-off
686 Turn off the fault LED for specified disk path. Require permission to
687 open disk path as read-write, normally root user or disk group would
688 have sufficient permission.
689
690 --path <DISK_PATH>
691 Required. Disk path, like /dev/sdb.
692
693
695 ls
696 Alias of 'list --type systems'
697
698 lp
699 Alias of 'list --type pools'
700
701 lv
702 Alias of 'list --type volumes'
703
704 ld
705 Alias of 'list --type disks'
706
707 la
708 Alias of 'list --type access_groups'
709
710 lf
711 Alias of 'list --type fs'
712
713 lt
714 Alias of 'list --type target_ports'
715
716 lb
717 Alias of 'list --type batteries'
718
719 c
720 Alias of 'capabilities'
721
722 p
723 Alias of 'plugin-info'
724
725 vc
726 Alias of 'volume-create'
727
728 vrc
729 Alias of 'volume-raid-create'
730
731 vrcc
732 Alias of 'volume-raid-create-cap'
733
734 vilon
735 Alias of 'volume-ident-led-on'
736
737 viloff
738 Alias of 'volume-ident-led-off'
739
740 vd
741 Alias of 'volume-delete'
742
743 vr
744 Alias of 'volume-resize'
745
746 vm
747 Alias of 'volume-mask'
748
749 vu
750 Alias of 'volume-unmask'
751
752 ve
753 Alias of 'volume-enable'
754
755 vi
756 Alias of 'volume-disable'
757
758 vri
759 Alias of 'volume-raid-info'
760
761 pmi
762 Alias of 'pool-member-info'
763
764 ac
765 Alias of 'access-group-create'
766
767 aa
768 Alias of 'access-group-add'
769
770 ar
771 Alias of 'access-group-remove'
772
773 ad
774 Alias of 'access-group-delete'
775
776 srcps
777 Alias of 'system-read-cache-pct-update'
778
779 ldl
780 Alias of 'local-disk-list'
781
782 vci
783 Alias of 'volume-cache-info'
784
785 vpdcu
786 Alias of 'volume-phy-disk-cache-update'
787
788 vrcpu
789 Alias of 'volume-read-cache-policy-update'
790
791 vwcpu
792 Alias of 'volume-write-cache-policy-update'
793
794 ldilon
795 Alias of 'local-disk-ident-led-on'
796
797 ldiloff
798 Alias of 'local-disk-ident-led-off'
799
800 ldflon
801 Alias of 'local-disk-fault-led-on'
802
803 ldfloff
804 Alias of 'local-disk-fault-led-off'
805
806
808 --size <SIZE>
809 Storage space size. Format is '<number>' + '<prefix>'. Example:
810 "10GiB", "20.5MB". No postfix indicates bytes. Valid prefixes are:
811 KiB, # 2^10 Bytes
812 MiB, # 2^20 Bytes
813 GiB, # 2^30 Bytes
814 TiB, # 2^40 Bytes
815 PiB, # 2^50 Bytes
816 EiB, # 2^60 Bytes
817 KB, # 10^3 Bytes
818 MB, # 10^6 Bytes
819 GB, # 10^9 Bytes
820 TB, # 10^12 Bytes
821 PB, # 10^15 Bytes
822 EB, # 10^17 Bytes
823
824 These prefixes are supported also, but not recommended:
825 K, M, G, T, P, E, # equal to KiB, MiB, and etc
826 k, m, g, t, p, e, # equal to KiB, MiB, and etc
827
828
830 ~/.lsmcli lsmcli configuration file, containing name-value pairs
831 separated by '='. The only currently supported configu‐
832 ration option is 'uri', such as 'uri=tar‐
833 getd://user@storage.example.com'.
834
835 Configuration options in .lsmcli are only used if not
836 overridden by command-line option or environment vari‐
837 able.
838
839
841 Simulator, list pools (no password required)
842 $ lsmcli -u sim:// -l POOLS
843
844 Targetd, list volumes (prompting for password)
845 $ lsmcli -u targetd://root@host/ -l VOLUMES -P
846
847 SMI-S, list systems (prompting for password)
848 $ lsmcli -u smispy://username@host:5988/?namespace=root/interop \
849 -l SYSTEMS -P
850
851 Targetd, list pools (using env variables for URI and password)
852 $ export LSMCLI_URI=targetd://username@host:18700
853 $ export LSMCLI_PASSWORD=<password>
854 $ lsmcli -l POOLS
855
856 SMI-S, create volume (using environment variables for URI and password)
857 $ export LSMCLI_URI='smispy+ssl://user@host:5989?namespace=root/emc'
858 $ export LSMCLI_PASSWORD=<password>
859 $ lsmcli volume-create --name volume_name --size 1TiB --pool default
860
861
863 LSMCLI_URI The URI for the storage array in question.
864
865 LSMCLI_PASSWORD The password to use for the array.
866
867
869 CLONE A point in time, read writeable, space efficent copy
870 of data.
871
872 COPY A full bitwise copy of the data. It occupies the full
873 space.
874
875 MIRROR_SYNC Continously updated, realtime with both copies having
876 identical data.
877
878 MIRROR_ASYNC Continously updated, with a varying amount of delay
879 and data delta between the source and target.
880
881
882
884 Optional search argument
885 When specifying an optional search argument, it's not consid‐
886 ered an error if no search results are found, eg. specifying a
887 non-existent system id. The exit code will be 0.
888
889
890 Plugin installation
891 Plugins are installed individually except for the simulators
892 which are always included.
893
894
895 Secure sockets layer (SSL)
896 All of the plugins (except the simulator) support SSL when com‐
897 municating from the plugin to the array. This is accomplished
898 by adding "+ssl" to the plugin and usually by selecting a dif‐
899 ferent port number from non-SSL communications.
900 $ lsmcli -u smispy+ssl://username@host:5989/?namespace=interop \
901 list --type SYSTEMS -P
902
903
904 SSL error: certificate verify failed
905 When using SMI-S plugin with SSL against self-signed SMI-S
906 provider, lsmcli normally quit with 'SSL error: certificate
907 verify failed'. Please contact SMI-S provider support to setup
908 the self-signed certificate in your system. If you prefer to
909 bypass the certificate check, add 'no_ssl_verify=yes' at the
910 end of URI, for example:
911 smispy+ssl://admin@emc-smi:5989?namespace=root/emc&no_ssl_verify=yes
912
913
915 Please report bugs to <libstoragemgmt-devel@lists.fedorahosted.org>
916
918 Tony Asleson <tasleson@redhat.com>
919 Gris Ge <fge@redhat.com>
920
921
922
923lsmcli 1.9.0 December 2018 LSMCLI(1)