Manual Pages for Linux CentOS command on man lsmcli

LSMCLI(1) libStorageMgmt LSMCLI(1)

NAME

lsmcli - libStorageMgmt command line interface SYNOPSIS lsmcli command [GLOBAL OPTIONS]...[COMMAND OPTIONS]... DESCRIPTION lsmcli is the command line tool for the libStorageMgmt library. This tool allows users to do one off storage related management operations or to script management of their storage. PREREQUISITES * libStorageMgmt daemon. The daemon 'lsmd' is required by lsmcli. * URI(Uniform Resource Identifier) URI is used to identify which plugin to use and how the plugin should communicate with the storage array. The valid URI format is: plugin://@host:? plugin+ssl://@host:? Examples, please refer to "LibStorageMgmt User Guide" for more details: * Simulator: sim:// simc:// * NetApp ONTAP: ontap://username@host ontap+ssl://username@host

* SMI-S supported arrays (eg. EMC CX/VNX, HDS AMS, IBM SVC/DS, LSI MegaRAID and others): smis://username@host:?namespace= smis+ssl://username@host:?namespace= You can pass URI to lsmcli via one of these methods:

* Using '-u, uri' argument. * Using 'LSMCLIURI' environment variable.

* Add this line into $HOME/.lsmcli: uri= * Password For storage array password authentication you can pass it to lsmcli via one of the following methods:

* '-P, prompt' argument to prompt for password. * 'LSMCLIPASSWORD' environment variable. GLOBAL OPTIONS version Show program's version number and exit

-h, help Show this help message and exit. Will show help message of specific command if specified.

-u , uri Uniform Resource Identifier (env LSMCLIURI)

-P, prompt Prompt for password (env LSMCLIPASSWORD)

-H, human Print sizes in human readable format (e.g., KiB, MiB, GiB, TiB, PiB, EiB)

-t , terse Print output in terse form with "SEP" as a record sepa‐ rator without header unless 'header' defined. header Include the header with terse

-e, enum Display enumerated types as numbers instead of text

-f, force Bypass confirmation prompt for data loss operations

-w , wait= Command timeout value in ms (default = 30s)

-b Run the command asynchronously instead of waiting for completion. The lsmcli command will exit with exit code(7) and job id will be written to STDOUT when a com‐

mand is still executing on the storage array. Use 'job- status id ' to inquire on the progress of the command. Some arrays or plugins might not support asyn‐

chronous operations, in those circumstances, -b will be ineffective. Command will wait until finished.

- ID | aggr0 Name | aggr0 Element Type | FS,SYSTEMRESERVED,POOL ...

- ID | iscsi Name | iscsi Element Type | FS,POOL ... Please note: To reduce the width of output, NOT all properties will be displayed in default column display. COMMANDS list List information on LSM objects type Required. Valid values are (case insensitive): VOLUMES, POOLS, FS, SNAPSHOTS, EXPORTS, NFSCLIENTAUTH, ACCESSGROUPS, SYSTEMS, DISKS, PLUGINS, TARGETPORTS, BATTERIES. fs Required for type=SNAPSHOTS, list the snapshots of certain filesystem. Optional for type EXPORTS, list the NFS export for certain filesystem. sys Optional. Search resources from system with SYSID. Only supported when querying these types of resources: VOLUMES, PO,LBATTERIES.NAPSHOTS, DISKS, ACCESSGROUPS, TARGETPORTS pool Optional. Search resources from pool with POOLID. Only supported by these types of resources: VOLUMES, POOLS, FS. vol Search resources from volume with VOLID. Only supported by these types of resources: VOLUMES, ACCESSGROUPS. To query volume masking status, please use this command: lsmcli list type ACCESSGROUPS vol disk Search resources from disk with DISKID. Only supported by these types of resources: DISK. ag Search resources from access group with AGID. Only sup‐ ported by these types of resources: ACCESSGROUPS, VOL‐ UMES. To query volume masking status, please use this command: lsmcli list type VOLUMES ag

nfs-export Search resources from NFS export with NFSEXPORTID. Only supported by these types of resources: EXPORTS. tgt Search resources from target port with target port ID. Only supported by these types of resources: TAR‐ GETPORTS.

job-status Retrieve information about a job. Please see user guide on how to use. job capabilities Retrieves array capabilities. sys Required. ID of the system to query for capabilities.

plugin-info Retrieves plugin description and version for current URI.

volume-create Creates a volume (AKA., logical volume, virtual disk, LUN). name Required. Volume name. size Required. Volume size (See SIZE OPTION for allowed for‐ mats). pool Required. ID of pool. provisioning Optional. Provisioning type. Valid values are: DEFAULT, THIN, FULL. DEFAULT means let plugin choose. THIN means requiring a Thin Provisioning enabled volume. FULL means requiring a fully allocated volume.

volume-raid-create Creates a volume on hardware RAID on given disks. name Required. Volume name. Might be altered or ignored due to hardware RAID card vendor limitation.

raid-type Required. Could be one of these values: RAID0, RAID1, RAID5, RAID6, RAID10, RAID50, RAID60. The supported RAID types of current RAID card could be queried via command

"volume-raid-create-cap". disk Required. Repeatable. The disk ID for new RAID group.

strip-size Optional. The size in bytes of strip on each disks. If not defined, will let hardware card to use the vendor default value. The supported stripe size of current RAID

card could be queried via command "volume-raid-create- cap".

volume-raid-create-cap

Query support status of volume-raid-create command for current hardware RAID card. sys Required. ID of the system to query for capabilities.

volume-ident-led-on Enable the IDENT LEDs for all physical disks that compose a logical volume. vol Required. ID of the volume being targeted.

volume-ident-led-off Disable the IDENT LEDs for all physical disks that compose a logical volume. vol Required. ID of the volume being targeted.

volume-delete Delete a volume given its ID vol Required. The ID of volume to delete.

volume-resize

Re-sizes a volume, requires: vol Required. The ID of volume to resize. size Required. The new size of volume.(See SIZE OPTION for allowed formats). Due to boundary alignment concern, array might return a volume with slightly bigger size than requested.

volume-replicate Creates a new volume and replicates provided volume to it. vol Required. The ID of volume to replicate. name Required. The name for new volume to hold replicated data.

rep-type (see VOLUME REPLICATION TYPES) Required. Valid types of replication are: CLONE, COPY, MIRRORASYNC, MIRRORSYNC. pool Optional. The ID of pool where the new volume should be created from. If not specified, plugin or array will choose appropriate pool.

volume-replicate-range Replicates a portion of a volume to the same volume or to a different volume.

src-vol Required. The ID of replication source volume.

dst-vol Required. The ID of replication destination volume.

rep-type (see VOLUME REPLICATION TYPES) Required. Appropriate types of replication are: CLONE, COPY.

src-start Required. Replication source volume start block number.

Must in pair with count and dst-start. If you have

several non-continuous block ranges, you can define

repeatly define this arugument, like 'src-start 0

dst-start 0 count 1024 src-start 2048 dst-start 2048 count 2048'

dst-start Required. Replication destination volume start block

number. Must in pair with count and src-start. count Required. The count of replicated block startting from

src-startblock. Must in pair with src-start and

dst-start.

volume-replicate-range-block-size Size of each replicated block on a system in bytes. sys Required. ID of the system to query for replicated block size.

volume-dependants Returns True if volume has a dependant child, like replication. vol Required. The ID of volume to query dependency.

volume-dependants-rm Removes volume dependencies(like replication). vol Required. The ID of volume to remove dependency.

volume-access-group Lists the access group(s) that have access to the provided volume. vol Required. The ID of volume to query access.

volume-mask Grant access group RW access to certain volume. Like LUN masking or NFS export. vol Required. The ID of volume to access. ag Required. The ID of access group to grant.

volume-unmask Revoke access group RW access to specified volume. vol Required. The ID of volume to revoke. ag Required. The ID of access group to revoke.

volume-raid-info Query RAID information for given volume. vol Required. The ID of volume to query.

pool-member-info Query RAID information for given pool. pool Required. The ID of pool to query.

access-group-create Create an access group. name Required. The human friendly name for new access group. init Required. The first initiator ID of new access group. WWPN or iSCSI IQN. sys Required. The ID of system where this access group should reside on.

access-group-add Adds an initiator to an access group. ag Required. ID of access group. init Required. ID of initiator to add. WWPN or iSCSI IQN.

access-group-remove Removes an initiator from an access group. ag Required. ID of access group. init Required. ID of initiator to remove.

access-group-delete Delete an access group. ag Required. ID of access group to delete.

access-group-volumes Lists the volumes that the access group has been granted access to. ag Required. The ID of access group to query.

iscsi-chap Configures ISCSI inbound/outbound CHAP authentication. init Required. The ID of iSCSI initiator to configure.

in-user Optional. Inbound CHAP user name.

in-pass Optional. Inbound CHAP password.

out-user Optional. Outbound CHAP user name.

out-pass Optional. Outbound CHAP password.

fs-create Creates a filesystem. name Required. Human friendly name for new filesystem. size Required. Volume size(See SIZE OPTION for allowed for‐ mats). pool Required. ID of pool to hold the new filesystem.

fs-delete Delete a filesystem. fs Required. ID of the filesystem to delete.

fs-resize Resizes a filesystem. fs Required. ID of the filesystem to resize. size Required. New size of filesystem. See SIZE OPTION for allowed formats.

fs-export Export a filesystem via NFS. fs Required. ID of the filesystem to export. exportpath Optional. NFS server export path. e.g. '/foo/bar'. anonuid Optional. The UID(User ID) to map to anonymous user. anongid Optional. The GID(Group ID) to map to anonymous user.

auth-type Optional. NFS client authentication type. This is just a place holder, not supported yet.

root-host Optional. Repeatable. The host/IP has root access. For two or more hosts/IPs:

ro-host Optional. Repeatable. The host/IP has read only access.

For two or more hosts/IPs: 'ro-host hostA ro-host hostB'.

rw-host Optional. The host/IP has read/write access. For two or more hosts/IPs:

fs-unexport Remove an NFS export. export Required. ID of the export to unexport.

fs-clone Creates a file system clone. The 'clone' means point in time read

writeable space efficient copy of data, AKA. read-writable snapshot.

src-fs Required. The ID of the filesystem to clone.

dst-name Required. The name for newly created destination file system.

backing-snapshot Optional. Make a FS clone using a previously created snapshot.

fs-snap-create Creates a snapshot of specified filesystem. A snapshot is defined as a read only space efficient point in time copy (PIT) of a filesystem. The source filesystem remains modifiable. name Required. The human friendly name of new snapshot. fs Required. The ID of filesystem to create snapshot against.

fs-snap-delete Deletes a snapshot. snap Required. The ID of snapshot to delete. fs Required. The ID of filesystem.

fs-snap-restore Restores a FS or specified files to previous snapshot state. This will discard all the changes to filesystem since snapshot if specific files are not specified in restore. fs Required. The ID of filesystem to restore. snap Required. The ID of snapshot to restore. file Optional. Repeatable. With this option defined, will only restore the defined file(s). fileas Optional. Repeatable. With this option defined, the restored file will be saved to specified path and file‐ name, eg. 'file fileA fileas oldfileA '.

fs-dependants Returns True if a child dependency (snapshot or clone) exists. fs Required. The ID of filesystem to query. file Optional. Repeatable. Only check for dependencies on specific file(s), eg. 'file fileA file pathB'.

fs-dependants-rm Removes filesystem dependencies(snapshot or clone). fs Required. The ID of filesystem to remove dependency. file Optional. Repeatable. Only remove dependencies on spe‐ cific file(s), eg. 'file fileA file pathB'.

file-clone Creates a clone of a file (thin provisioned). Note: src and dst need to be paired eg. 'src fileA src fileB dst fileAclone dst fileBclone'. fs Required. The ID of filesystem to clone. src Required. Repeatable. Source file to clone (relative path). dst Required. Repeatable. Destination file for clone (rela‐ tive path).

backing-snapshot Optional. Use the source file from previously created snapshot.

system-read-cache-pct-update Change the read cache percentage for a system. sys Required. ID of the system being targeted.

read-pct The desired percentage of read cache for the targeted system. Write cache will be automatically changed to the remaining percentage available after updating the read cache (if supported by the system).

local-disk-list List all disks found on current local operating system. Require per‐

mission to open /dev/sdX as read-only, normally root user or disk group would have sufficient permission.

volume-cache-info Query RAM cache information for the desired volume. vol Required. ID of the volume to query cache information.

volume-phy-disk-cache-update Disable or enable RAM physical disk cache of certain volume. vol Required. ID of the volume to change. policy Required. Enable or Disable.

volume-read-cache-policy-update Disable or enable RAM read cache of certain volume. vol Required. ID of the volume to change. policy Required. Enable or Disable.

volume-write-cache-policy-update Change volume write cache policy. vol Required. ID of the volume to change. policy Required. WB for write back mode, WT for write through mode, AUTO for auto mode which use WB mode when any bat‐ tery is OK and use WT mode else.

local-disk-ident-led-on Turn on the identification LED for specified disk path. Require per‐

mission to open disk path as read-write, normally root user or disk group would have sufficient permission. path Required. Disk path, like /dev/sdb.

local-disk-ident-led-off Turn off the identification LED for specified disk path. Require per‐

mission to open disk path as read-write, normally root user or disk group would have sufficient permission. path Required. Disk path, like /dev/sdb.

local-disk-fault-led-on Turn on the fault LED for specified disk path. Require permission to

open disk path as read-write, normally root user or disk group would have sufficient permission. path Required. Disk path, like /dev/sdb.

local-disk-fault-led-off Turn off the fault LED for specified disk path. Require permission to

open disk path as read-write, normally root user or disk group would have sufficient permission. path Required. Disk path, like /dev/sdb. ALIAS ls Alias of 'list type systems' lp Alias of 'list type pools' lv Alias of 'list type volumes' ld Alias of 'list type disks' la Alias of 'list type accessgroups' lf Alias of 'list type fs' lt Alias of 'list type targetports' lb Alias of 'list type batteries' c Alias of 'capabilities' p

Alias of 'plugin-info' vc

Alias of 'volume-create' vrc

Alias of 'volume-raid-create' vrcc

Alias of 'volume-raid-create-cap' vilon

Alias of 'volume-ident-led-on' viloff

Alias of 'volume-ident-led-off' vd

Alias of 'volume-delete' vr

Alias of 'volume-resize' vm

Alias of 'volume-mask' vu

Alias of 'volume-unmask' vri

Alias of 'volume-raid-info' pmi

Alias of 'pool-member-info' ac

Alias of 'access-group-create' aa

Alias of 'access-group-add' ar

Alias of 'access-group-remove' ad

Alias of 'access-group-delete' srcps

Alias of 'system-read-cache-pct-update' ldl

Alias of 'local-disk-list' vci

Alias of 'volume-cache-info' vpdcu

Alias of 'volume-phy-disk-cache-update' vrcpu

Alias of 'volume-read-cache-policy-update' vwcpu

Alias of 'volume-write-cache-policy-update' ldilon

Alias of 'local-disk-ident-led-on' ldiloff

Alias of 'local-disk-ident-led-off' ldflon

Alias of 'local-disk-fault-led-on' ldfloff

Alias of 'local-disk-fault-led-off' SIZE OPTION size Storage space size. Format is '' + ''. Example: "10GiB", "20.5MB". No postfix indicates bytes. Valid prefixes are:

KiB, # 2^10 Bytes

MiB, # 2^20 Bytes

GiB, # 2^30 Bytes

TiB, # 2^40 Bytes

PiB, # 2^50 Bytes

EiB, # 2^60 Bytes

KB, # 10^3 Bytes

MB, # 10^6 Bytes

GB, # 10^9 Bytes

TB, # 10^12 Bytes

PB, # 10^15 Bytes

EB, # 10^17 Bytes These prefixes are supported also, but not recommended:

K, M, G, T, P, E, # equal to KiB, MiB, and etc

k, m, g, t, p, e, # equal to KiB, MiB, and etc FILES

~/.lsmcli lsmcli configuration file, containing name-value pairs separated by '='. The only currently supported configu‐ ration option is 'uri', such as 'uri=ontap://user@filer.example.com'. Configuration options in .lsmcli are only used if not

overridden by command-line option or environment vari‐ able. EXAMPLES (command output omitted for brevity) Simulator, list pools (no password required)

$ lsmcli -u sim:// -l POOLS NetApp, list volumes (prompting for password)

$ lsmcli -u ontap://root@host/ -l VOLUMES -P

SMI-S, list systems (prompting for password)

$ lsmcli -u smispy://username@host:5988/?namespace=root/interop \

-l SYSTEMS -P Targetd, list pools (using env variables for URI and password)

$ export LSMCLIURI=targetd://username@host:18700

$ export LSMCLIPASSWORD=

$ lsmcli -l POOLS NexentaStor, create volume (using environment variables for URI and password)

$ export LSMCLIURI='nstor://user@host'

$ export LSMCLIPASSWORD=

$ lsmcli volume-create name volumename size 1TiB pool default

SMI-S, create volume (using environment variables for URI and password)

$ export LSMCLIURI='smispy+ssl://user@host:5989?namespace=root/emc'

$ export LSMCLIPASSWORD=

$ lsmcli volume-create name volumename size 1TiB pool default ENVIRONMENT LSMCLIURI The URI for the storage array in question. LSMCLIPASSWORD The password to use for the array. VOLUME REPLICATION TYPES CLONE A point in time, read writeable, space efficent copy of data. COPY A full bitwise copy of the data. It occupies the full space. MIRRORSYNC Continously updated, realtime with both copies having identical data. MIRRORASYNC Continously updated, with a varying amount of delay and data delta between the source and target. NOTES Plugin installation Plugins are installed individually except for the simulators which are always included. Secure sockets layer (SSL) All of the plugins (except the simulator) support SSL when com‐ municating from the plugin to the array. This is accomplished by adding "+ssl" to the plugin and usually by selecting a dif‐

ferent port number from non-SSL communications.

$ lsmcli -u smispy+ssl://username@host:5989/?namespace=interop \

list type SYSTEMS -P SSL error: certificate verify failed

When using SMI-S plugin with SSL against self-signed SMI-S provider, lsmcli normally quit with 'SSL error: certificate

verify failed'. Please contact SMI-S provider support to setup

the self-signed certificate in your system. If you prefer to bypass the certificate check, add 'nosslverify=yes' at the end of URI, for example:

smispy+ssl://admin@emc-smi:5989?namespace=root/emc&nosslverify=yes BUGS

Please report bugs to AUTHOR Tony Asleson Gris Ge lsmcli 1.6.2 September 2014 LSMCLI(1)