1LSMCLI(1)                       libStorageMgmt                       LSMCLI(1)
2
3
4

NAME

6       lsmcli - libStorageMgmt command line interface
7
8

SYNOPSIS

10       lsmcli command [GLOBAL OPTIONS]...[COMMAND OPTIONS]...
11
12

DESCRIPTION

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

PREREQUISITES

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

GLOBAL OPTIONS

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

COMMANDS

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                      certain filesystem.  Optional for type EXPORTS, list the
129                      NFS export for certain filesystem.
130
131       --sys <SYS_ID> Optional.   Search  resources  from  system with SYS_ID.
132                      Only supported when querying these types  of  resources:
133                      VOLUMES,  POO,LSB,ATTFESR,IESS.NAPSHOTS,  DISKS, ACCESS_GROUPS,
134                      TARGET_PORTS
135
136       --pool <POOL_ID>
137                      Optional.  Search resources from pool with POOL_ID. Only
138                      supported  by  these types of resources: VOLUMES, POOLS,
139                      FS.
140
141       --vol <VOL_ID> Search resources from volume with VOL_ID. Only supported
142                      by these types of resources: VOLUMES, ACCESS_GROUPS.
143                      To query volume masking status, please use this command:
144                         lsmcli list --type ACCESS_GROUPS --vol <VOL_ID>
145
146       --disk <DISK_ID>
147                      Search  resources from disk with DISK_ID. Only supported
148                      by these types of resources: DISK.
149
150       --ag <AG_ID>   Search resources from access group with AG_ID. Only sup‐
151                      ported  by these types of resources: ACCESS_GROUPS, VOL‐
152                      UMES.
153                      To query volume masking status, please use this command:
154                         lsmcli list --type VOLUMES --ag <AG_ID>
155
156       --nfs-export <NFS_EXPORT_ID>
157                      Search resources from  NFS  export  with  NFS_EXPORT_ID.
158                      Only supported by these types of resources: EXPORTS.
159
160       --tgt <TGT_ID> Search  resources  from target port with target port ID.
161                      Only  supported  by  these  types  of  resources:   TAR‐
162                      GET_PORTS.
163
164
165   job-status
166       Retrieve information about a job.  Please see user guide on how to use.
167
168       --job <JOB_ID>
169
170
171   capabilities
172       Retrieves array capabilities.
173
174       --sys <SYS_ID> Required. ID of the system to query for capabilities.
175
176
177   plugin-info
178       Retrieves plugin description and version for current URI.
179
180
181   volume-create
182       Creates a volume (AKA., logical volume, virtual disk, LUN).
183
184       --name <NAME>  Required. Volume name.
185
186       --size <SIZE>  Required.  Volume size (See SIZE OPTION for allowed for‐
187                      mats).
188
189       --pool <POOL_ID>
190                      Required. ID of pool.
191
192       --provisioning <THINP_TYPE>
193                      Optional. Provisioning type. Valid values are:  DEFAULT,
194                      THIN, FULL.  DEFAULT means let plugin choose. THIN means
195                      requiring a Thin Provisioning enabled volume. FULL means
196                      requiring a fully allocated volume.
197
198
199   volume-raid-create
200       Creates a volume on hardware RAID on given disks.
201
202       --name <NAME>  Required.  Volume  name. Might be altered or ignored due
203                      to hardware RAID card vendor limitation.
204
205       --raid-type <RAID_TYPE>
206                      Required. Could be one of these  values:  RAID0,  RAID1,
207                      RAID5, RAID6, RAID10, RAID50, RAID60. The supported RAID
208                      types of current RAID card could be queried via  command
209                      "volume-raid-create-cap".
210
211       --disk <DISK_ID>
212                      Required. Repeatable. The disk ID for new RAID group.
213
214       --strip-size <STRIP_SIZE>
215                      Optional.  The  size in bytes of strip on each disks. If
216                      not defined, will let hardware card to  use  the  vendor
217                      default value. The supported stripe size of current RAID
218                      card could be queried via  command  "volume-raid-create-
219                      cap".
220
221
222   volume-raid-create-cap
223       Query support status of volume-raid-create command for current hardware
224       RAID card.
225
226       --sys <SYS_ID> Required. ID of the system to query for capabilities.
227
228
229   volume-ident-led-on
230       Enable the IDENT LEDs for all physical disks  that  compose  a  logical
231       volume.
232
233       --vol <VOL_ID> Required. ID of the volume being targeted.
234
235
236   volume-ident-led-off
237       Disable  the  IDENT  LEDs for all physical disks that compose a logical
238       volume.
239
240       --vol <VOL_ID> Required. ID of the volume being targeted.
241
242
243   volume-delete
244       Delete a volume given its ID
245
246       --vol <VOL_ID> Required. The ID of volume to delete.
247
248
249   volume-resize
250       Re-sizes a volume, requires:
251
252       --vol <VOL_ID> Required. The ID of volume to resize.
253
254       --size <NEW_SIZE>
255                      Required. The new size of volume.(See  SIZE  OPTION  for
256                      allowed  formats).   Due  to boundary alignment concern,
257                      array might return a volume with  slightly  bigger  size
258                      than requested.
259
260
261   volume-replicate
262       Creates a new volume and replicates provided volume to it.
263
264       --vol <VOL_ID> Required. The ID of volume to replicate.
265
266       --name <NAME>  Required.  The  name  for  new volume to hold replicated
267                      data.
268
269       --rep-type <REPL_TYPE> (see VOLUME REPLICATION TYPES)
270                      Required. Valid types of replication are:
271                      CLONE, COPY, MIRROR_ASYNC, MIRROR_SYNC.
272
273       --pool <POOL_ID>
274                      Optional. The ID of pool where the new volume should  be
275                      created  from.  If  not  specified, plugin or array will
276                      choose appropriate pool.
277
278
279   volume-replicate-range
280       Replicates a portion of a volume to the same volume or to  a  different
281       volume.
282
283       --src-vol <SRC_VOL_ID>
284                      Required. The ID of replication source volume.
285
286       --dst-vol <DST_VOL_ID>
287                      Required. The ID of replication destination volume.
288
289       --rep-type <REPL_TYPE> (see VOLUME REPLICATION TYPES)
290                      Required. Appropriate types of replication are:
291                      CLONE, COPY.
292
293       --src-start <SRC_START_BLK>
294                      Required.  Replication source volume start block number.
295                      Must in pair with --count and --dst-start.  If you  have
296                      several  non-continuous  block  ranges,  you  can define
297                      repeatly define  this  arugument,  like  '--src-start  0
298                      --dst-start  0 --count 1024 --src-start 2048 --dst-start
299                      2048 --count 2048'
300
301       --dst-start <DST_START_BLK>
302                      Required. Replication  destination  volume  start  block
303                      number. Must in pair with --count and --src-start.
304
305       --count <BLK_COUNT>
306                      Required.  The  count of replicated block startting from
307                      --src-startblock.  Must in  pair  with  --src-start  and
308                      --dst-start.
309
310
311   volume-replicate-range-block-size
312       Size of each replicated block on a system in bytes.
313
314       --sys <SYS_ID> Required. ID of the system to query for replicated block
315                      size.
316
317
318   volume-dependants
319       Returns True if volume has a dependant child, like replication.
320
321       --vol <VOL_ID> Required. The ID of volume to query dependency.
322
323
324   volume-dependants-rm
325       Removes volume dependencies(like replication).
326
327       --vol <VOL_ID> Required. The ID of volume to remove dependency.
328
329
330   volume-access-group
331       Lists the access group(s) that have access to the provided volume.
332
333       --vol <VOL_ID> Required. The ID of volume to query access.
334
335
336   volume-mask
337       Grant access group RW access to certain volume. Like LUN masking
338                      or NFS export.
339
340       --vol <VOL_ID> Required. The ID of volume to access.
341
342       --ag <AG_ID>   Required. The ID of access group to grant.
343
344
345   volume-unmask
346       Revoke access group RW access to specified volume.
347
348       --vol <VOL_ID> Required. The ID of volume to revoke.
349
350       --ag <AG_ID>   Required. The ID of access group to revoke.
351
352
353   volume-raid-info
354       Query RAID information for given volume.
355
356       --vol <VOL_ID> Required. The ID of volume to query.
357
358
359   pool-member-info
360       Query RAID information for given pool.
361
362       --pool <POOL_ID>
363                      Required. The ID of pool to query.
364
365
366   access-group-create
367       Create an access group.
368
369       --name <AG_NAME>
370                      Required. The human friendly name for new access group.
371
372       --init <INIT_ID>
373                      Required. The first initiator ID of  new  access  group.
374                      WWPN or iSCSI IQN.
375
376       --sys <SYS_ID> Required.  The  ID  of  system  where  this access group
377                      should reside on.
378
379
380   access-group-add
381       Adds an initiator to an access group.
382
383       --ag <AG_ID>   Required. ID of access group.
384
385       --init <INIT_ID>
386                      Required. ID of initiator to add. WWPN or iSCSI IQN.
387
388
389   access-group-remove
390       Removes an initiator from an access group.
391
392       --ag <AG_ID>   Required. ID of access group.
393
394       --init <INIT_ID>
395                      Required. ID of initiator to remove.
396
397
398   access-group-delete
399       Delete an access group.
400
401       --ag <AG_ID>   Required. ID of access group to delete.
402
403
404   access-group-volumes
405       Lists the volumes that the access group has been granted access to.
406
407       --ag <AG_ID>   Required. The ID of access group to query.
408
409
410   iscsi-chap
411       Configures ISCSI inbound/outbound CHAP authentication.
412
413       --init <INIT_ID>
414                      Required. The ID of iSCSI initiator to configure.
415
416       --in-user <IN_USER>
417                      Optional. Inbound CHAP user name.
418
419       --in-pass <IN_PASS>
420                      Optional. Inbound CHAP password.
421
422       --out-user <OUT_USER>
423                      Optional. Outbound CHAP user name.
424
425       --out-pass <OUT_PASS>
426                      Optional. Outbound CHAP password.
427
428
429   fs-create
430       Creates a filesystem.
431
432       --name <NAME>  Required. Human friendly name for new filesystem.
433
434       --size <SIZE>  Required. Volume size(See SIZE OPTION for  allowed  for‐
435                      mats).
436
437       --pool <POOL_ID>
438                      Required. ID of pool to hold the new filesystem.
439
440
441   fs-delete
442       Delete a filesystem.
443
444       --fs <FS_ID>   Required. ID of the filesystem to delete.
445
446
447   fs-resize
448       Resizes a filesystem.
449
450       --fs <FS_ID>   Required. ID of the filesystem to resize.
451
452       --size <NEW_SIZE>
453                      Required.  New  size  of filesystem. See SIZE OPTION for
454                      allowed formats.
455
456
457   fs-export
458       Export a filesystem via NFS.
459
460       --fs <FS_ID>   Required. ID of the filesystem to export.
461
462       --exportpath <EXPORT_PATH>
463                      Optional. NFS server export path. e.g. '/foo/bar'.
464
465       --anonuid <ANONY_UID>
466                      Optional. The UID(User ID) to map to anonymous user.
467
468       --anongid <ANONY_GID>
469                      Optional. The GID(Group ID) to map to anonymous user.
470
471       --auth-type <AUTH_TYPE>
472                      Optional. NFS client authentication type. This is just a
473                      place holder, not supported yet.
474
475       --root-host <ROOT_HOST>
476                      Optional.  Repeatable.  The host/IP has root access. For
477                      two or more hosts/IPs:
478
479       --ro-host <RO_HOST>
480                      Optional. Repeatable. The host/IP has read only  access.
481                      For  two  or  more hosts/IPs: '--ro-host hostA --ro-host
482                      hostB'.
483
484       --rw-host <RW_HOST>
485                      Optional. The host/IP has read/write access. For two  or
486                      more hosts/IPs:
487
488
489   fs-unexport
490       Remove an NFS export.
491
492       --export <EXPORT_ID>
493                      Required. ID of the export to unexport.
494
495
496   fs-clone
497       Creates  a  file  system  clone.  The  'clone' means point in time read
498       writeable space efficient copy of data, AKA. read-writable snapshot.
499
500       --src-fs <SRC_FS_ID>
501                      Required. The ID of the filesystem to clone.
502
503       --dst-name <DST_FS_NAME>
504                      Required. The name for newly  created  destination  file
505                      system.
506
507       --backing-snapshot <BE_SS_ID>
508                      Optional.  Make  a  FS  clone using a previously created
509                      snapshot.
510
511
512   fs-snap-create
513       Creates a snapshot of specified filesystem.  A snapshot is defined as a
514       read  only  space  efficient  point in time copy (PIT) of a filesystem.
515       The source filesystem remains modifiable.
516
517       --name <SNAP_NAME>
518                      Required. The human friendly name of new snapshot.
519
520       --fs <FS_ID>   Required.  The  ID  of  filesystem  to  create  snapshot
521                      against.
522
523
524   fs-snap-delete
525       Deletes a snapshot.
526
527       --snap <SNAP_ID>
528                      Required. The ID of snapshot to delete.
529
530       --fs <FS_ID>   Required. The ID of filesystem.
531
532
533   fs-snap-restore
534       Restores  a FS or specified files to previous snapshot state. This will
535       discard all the changes to filesystem since snapshot if specific  files
536       are not specified in restore.
537
538       --fs <FS_ID>   Required. The ID of filesystem to restore.
539
540       --snap <SNAP_ID>
541                      Required. The ID of snapshot to restore.
542
543       --file <FILE_PATH>
544                      Optional.  Repeatable.  With  this  option defined, will
545                      only restore the defined file(s).
546
547       --fileas <NEW_FILE_PATH>
548                      Optional. Repeatable.  With  this  option  defined,  the
549                      restored  file will be saved to specified path and file‐
550                      name, eg. '--file fileA --fileas old_fileA '.
551
552
553   fs-dependants
554       Returns True if a child dependency (snapshot or clone) exists.
555
556       --fs <FS_ID>   Required. The ID of filesystem to query.
557
558       --file <FILE_PATH>
559                      Optional. Repeatable. Only  check  for  dependencies  on
560                      specific file(s), eg. '--file fileA --file pathB'.
561
562
563   fs-dependants-rm
564       Removes filesystem dependencies(snapshot or clone).
565
566       --fs <FS_ID>   Required. The ID of filesystem to remove dependency.
567
568       --file <FILE_PATH>
569                      Optional.  Repeatable.  Only remove dependencies on spe‐
570                      cific file(s), eg. '--file fileA --file pathB'.
571
572
573   file-clone
574       Creates a clone of a file (thin provisioned).  Note:  --src  and  --dst
575       need to be paired
576        eg. '--src fileA --src fileB --dst fileA_clone --dst fileB_clone'.
577
578       --fs <FS_ID>   Required. The ID of filesystem to clone.
579
580       --src <SRC_FILE_PATH>
581                      Required.  Repeatable.  Source  file  to clone (relative
582                      path).
583
584       --dst <DST_FILE_PATH>
585                      Required. Repeatable. Destination file for clone  (rela‐
586                      tive path).
587
588       --backing-snapshot <SNAP_ID>
589                      Optional.  Use  the  source file from previously created
590                      snapshot.
591
592
593   system-read-cache-pct-update
594       Change the read cache percentage for a system.
595
596       --sys <SYS_ID> Required. ID of the system being targeted.
597
598       --read-pct <READ_PCT>
599                      The desired percentage of read cache  for  the  targeted
600                      system. Write cache will be automatically changed to the
601                      remaining percentage available after updating  the  read
602                      cache (if supported by the system).
603
604
605   local-disk-list
606       List  all  disks found on current local operating system.  Require per‐
607       mission to open /dev/sdX as read-only, normally root user or disk group
608       would have sufficient permission.
609
610
611   volume-cache-info
612       Query RAM cache information for the desired volume.
613
614       --vol <VOL_ID> Required. ID of the volume to query cache information.
615
616
617   volume-phy-disk-cache-update
618       Disable or enable RAM physical disk cache of certain volume.
619
620       --vol <VOL_ID> Required. ID of the volume to change.
621
622       --policy <POLICY>
623                      Required. Enable or Disable.
624
625
626   volume-read-cache-policy-update
627       Disable or enable RAM read cache of certain volume.
628
629       --vol <VOL_ID> Required. ID of the volume to change.
630
631       --policy <POLICY>
632                      Required. Enable or Disable.
633
634
635   volume-write-cache-policy-update
636       Change volume write cache policy.
637
638       --vol <VOL_ID> Required. ID of the volume to change.
639
640       --policy <POLICY>
641                      Required.  WB  for write back mode, WT for write through
642                      mode, AUTO for auto mode which use WB mode when any bat‐
643                      tery is OK and use WT mode else.
644
645
646   local-disk-ident-led-on
647       Turn  on  the identification LED for specified disk path.  Require per‐
648       mission to open disk path as read-write, normally  root  user  or  disk
649       group would have sufficient permission.
650
651       --path <DISK_PATH>
652                      Required. Disk path, like /dev/sdb.
653
654
655   local-disk-ident-led-off
656       Turn  off the identification LED for specified disk path.  Require per‐
657       mission to open disk path as read-write, normally  root  user  or  disk
658       group would have sufficient permission.
659
660       --path <DISK_PATH>
661                      Required. Disk path, like /dev/sdb.
662
663
664   local-disk-fault-led-on
665       Turn  on  the fault LED for specified disk path.  Require permission to
666       open disk path as read-write, normally root user or  disk  group  would
667       have sufficient permission.
668
669       --path <DISK_PATH>
670                      Required. Disk path, like /dev/sdb.
671
672
673   local-disk-fault-led-off
674       Turn  off the fault LED for specified disk path.  Require permission to
675       open disk path as read-write, normally root user or  disk  group  would
676       have sufficient permission.
677
678       --path <DISK_PATH>
679                      Required. Disk path, like /dev/sdb.
680
681

ALIAS

683   ls
684       Alias of 'list --type systems'
685
686   lp
687       Alias of 'list --type pools'
688
689   lv
690       Alias of 'list --type volumes'
691
692   ld
693       Alias of 'list --type disks'
694
695   la
696       Alias of 'list --type access_groups'
697
698   lf
699       Alias of 'list --type fs'
700
701   lt
702       Alias of 'list --type target_ports'
703
704   lb
705       Alias of 'list --type batteries'
706
707   c
708        Alias of 'capabilities'
709
710   p
711        Alias of 'plugin-info'
712
713   vc
714       Alias of 'volume-create'
715
716   vrc
717       Alias of 'volume-raid-create'
718
719   vrcc
720       Alias of 'volume-raid-create-cap'
721
722   vilon
723       Alias of 'volume-ident-led-on'
724
725   viloff
726       Alias of 'volume-ident-led-off'
727
728   vd
729       Alias of 'volume-delete'
730
731   vr
732       Alias of 'volume-resize'
733
734   vm
735       Alias of 'volume-mask'
736
737   vu
738       Alias of 'volume-unmask'
739
740   vri
741       Alias of 'volume-raid-info'
742
743   pmi
744       Alias of 'pool-member-info'
745
746   ac
747       Alias of 'access-group-create'
748
749   aa
750       Alias of 'access-group-add'
751
752   ar
753       Alias of 'access-group-remove'
754
755   ad
756       Alias of 'access-group-delete'
757
758   srcps
759       Alias of 'system-read-cache-pct-update'
760
761   ldl
762       Alias of 'local-disk-list'
763
764   vci
765       Alias of 'volume-cache-info'
766
767   vpdcu
768       Alias of 'volume-phy-disk-cache-update'
769
770   vrcpu
771       Alias of 'volume-read-cache-policy-update'
772
773   vwcpu
774       Alias of 'volume-write-cache-policy-update'
775
776   ldilon
777       Alias of 'local-disk-ident-led-on'
778
779   ldiloff
780       Alias of 'local-disk-ident-led-off'
781
782   ldflon
783       Alias of 'local-disk-fault-led-on'
784
785   ldfloff
786       Alias of 'local-disk-fault-led-off'
787
788

SIZE OPTION

790   --size <SIZE>
791       Storage  space  size.  Format  is  '<number>'  +  '<prefix>'.  Example:
792       "10GiB", "20.5MB". No postfix indicates bytes. Valid prefixes are:
793           KiB,                    # 2^10 Bytes
794           MiB,                    # 2^20 Bytes
795           GiB,                    # 2^30 Bytes
796           TiB,                    # 2^40 Bytes
797           PiB,                    # 2^50 Bytes
798           EiB,                    # 2^60 Bytes
799           KB,                     # 10^3 Bytes
800           MB,                     # 10^6 Bytes
801           GB,                     # 10^9 Bytes
802           TB,                     # 10^12 Bytes
803           PB,                     # 10^15 Bytes
804           EB,                     # 10^17 Bytes
805
806       These prefixes are supported also, but not recommended:
807           K, M, G, T, P, E,       # equal to KiB, MiB, and etc
808           k, m, g, t, p, e,       # equal to KiB, MiB, and etc
809
810

FILES

812       ~/.lsmcli      lsmcli configuration file, containing  name-value  pairs
813                      separated  by '='. The only currently supported configu‐
814                      ration      option      is      'uri',      such      as
815                      'uri=ontap://user@filer.example.com'.
816
817                      Configuration  options  in  .lsmcli are only used if not
818                      overridden by command-line option or  environment  vari‐
819                      able.
820
821

EXAMPLES (command output omitted for brevity)

823       Simulator, list pools (no password required)
824                      $ lsmcli -u sim:// -l POOLS
825
826       NetApp, list volumes (prompting for password)
827                      $ lsmcli -u ontap://root@host/ -l VOLUMES -P
828
829       SMI-S, list systems (prompting for password)
830                      $ lsmcli -u smispy://username@host:5988/?namespace=root/interop \
831                              -l SYSTEMS -P
832
833       Targetd, list pools (using env variables for URI and password)
834                      $ export LSMCLI_URI=targetd://username@host:18700
835                      $ export LSMCLI_PASSWORD=<password>
836                      $ lsmcli -l POOLS
837
838       NexentaStor,  create  volume  (using  environment variables for URI and
839       password)
840                      $ export LSMCLI_URI='nstor://user@host'
841                      $ export LSMCLI_PASSWORD=<password>
842                      $ lsmcli volume-create --name volume_name --size 1TiB --pool default
843
844       SMI-S, create volume (using environment variables for URI and password)
845                      $ export LSMCLI_URI='smispy+ssl://user@host:5989?namespace=root/emc'
846                      $ export LSMCLI_PASSWORD=<password>
847                      $ lsmcli volume-create --name volume_name --size 1TiB --pool default
848
849

ENVIRONMENT

851       LSMCLI_URI       The URI for the storage array in question.
852
853       LSMCLI_PASSWORD  The password to use for the array.
854
855

VOLUME REPLICATION TYPES

857       CLONE            A point in time, read writeable, space  efficent  copy
858                        of data.
859
860       COPY             A  full bitwise copy of the data. It occupies the full
861                        space.
862
863       MIRROR_SYNC      Continously updated, realtime with both copies  having
864                        identical data.
865
866       MIRROR_ASYNC     Continously  updated,  with  a varying amount of delay
867                        and data delta between the source and target.
868
869
870

NOTES

872       Plugin installation
873               Plugins are installed individually except  for  the  simulators
874               which are always included.
875
876
877       Secure sockets layer (SSL)
878               All of the plugins (except the simulator) support SSL when com‐
879               municating from the plugin to the array.  This is  accomplished
880               by  adding "+ssl" to the plugin and usually by selecting a dif‐
881               ferent port number from non-SSL communications.
882               $ lsmcli -u smispy+ssl://username@host:5989/?namespace=interop \
883                       list --type SYSTEMS -P
884
885
886       SSL error: certificate verify failed
887               When using SMI-S plugin  with  SSL  against  self-signed  SMI-S
888               provider,  lsmcli  normally  quit  with 'SSL error: certificate
889               verify failed'. Please contact SMI-S provider support to  setup
890               the  self-signed  certificate  in your system. If you prefer to
891               bypass the certificate check, add  'no_ssl_verify=yes'  at  the
892               end of URI, for example:
893                   smispy+ssl://admin@emc-smi:5989?namespace=root/emc&no_ssl_verify=yes
894
895

BUGS

897       Please report bugs to <libstoragemgmt-devel@lists.fedorahosted.org>
898

AUTHOR

900       Tony Asleson <tasleson@redhat.com>
901       Gris Ge <fge@redhat.com>
902
903
904
905lsmcli 1.6.2                    September 2014                       LSMCLI(1)
Impressum