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