.TH LSMCLI "1" "May 2013" "lsmcli 0.0.20" "libStorageMgmt"
.SH NAME
lsmcli \- LibStorageMgmt command line interface
.SH SYNOPSIS
.B lsmcli
[\fIoptions\fR]... [\fIcommand\fR]... [\fIcommand options\fR]...
.SH 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.
.SH "OPTIONS (global)"
.TP
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-u\fR URI, \fB\-\-uri\fR=\fIURI\fR
uniform resource identifier (env LSMCLI_URI)
.TP
\fB\-P\fR, \fB\-\-prompt\fR
prompt for password (env LSMCLI_PASSWORD)
.TP
\fB\-H\fR, \fB\-\-human\fR
print sizes in human readable format
(e.g., MiB, GiB, TiB)
.TP
\fB\-t\fR SEP, \fB\-\-terse\fR=\fISEP\fR
print output in terse form with "SEP" as a record
separator
.TP
\fB\-e\fR, \fB\-\-enum\fR
display enumerated types as numbers instead of text
.TP
\fB\-f\fR, \fB\-\-force\fR
bypass confirmation prompt for data loss operations
.TP
\fB\-w\fR WAIT, \fB\-\-wait\fR=\fIWAIT\fR
command timeout value in ms (default = 30s)
.TP
\fB\-\-header\fR
include the header with terse
.TP
\fB\-b\fR
run the command asynchronously instead of waiting for
completion.  lsmcli command will exit with exit code(7) and job id will be 
written to stdout when a command is still executing on the storage array.  
Use --job-status <job id> to inquire on the progress of the command.

.SH ENVIRONMENT
.TP
LSMCLI_URI
	The URI for the storage array in question.
.TP
LSMCLI_PASSWORD
	The password to use for the array.
.IP
.SH COMMANDS
.TP
\fB\-l\fR <type>, \fB\-\-list=\fR<type>
.TP 
List records of type:
[VOLUMES|INITIATORS|POOLS|FS|SNAPSHOTS|EXPORTS
.br
|NFS_CLIENT_AUTH|ACCESS_GROUPS|SYSTEMS]
.TP
Note: SNAPSHOTS listing requires: \fB\-\-fs\fR <fs id>
.TP
\fB\-\-capabilities=\fR<system id>
Retrieves array capabilities
.TP
\fB\-\-plugin\-info\fR
Retrieves plugin description and version
.TP
\fB\-\-delete\-fs=\fR<fs id>
Delete a filesystem
.TP
\fB\-\-delete\-access\-group=\fR<group id>
Deletes an access group
.TP
\fB\-\-access\-group\-add=\fR<access group id>
Adds an initiator to an access group, requires:
.br
\fB\-\-id\fR <initiator id
.br
\fB\-\-type\fR <initiator type>
.TP
\fB\-\-access\-group\-remove=\fR<access group id>
Removes an initiator from an access group, requires:
.br
\fB\-\-id\fR <initiator id>
.TP
\fB\-\-create\-volume=\fR<volume name>
Creates a volume (logical unit) requires:
.br
\fB\-\-size\fR <volume size>
.br
\fB\-\-pool\fR <pool id>
.br
\fB\-\-provisioning\fR (optional) [DEFAULT|THIN|FULL]
.TP
\fB\-\-create\-fs=\fR<fs name>
Creates a file system requires:
.br
\fB\-\-size\fR <fs size>
.br
\fB\-\-pool\fR <pool id>
.TP
\fB\-\-create\-ss=\fR<snapshot name>
Creates a snapshot requires:
.br
\fB\-\-file\fR <repeat for each file> (default is all files)
.br
\fB\-\-fs\fR <file system id>
.TP
\fB\-\-create\-access\-group=\fR<Access group name>
Creates an access group, requires:
.br
\fB\-\-id\fR <initiator id>
.br
\fB\-\-type\fR [WWPN|WWNN|ISCSI|HOSTNAME]
.br
\fB\-\-system\fR <system id>
.TP
\fB\-\-access\-group\-volumes=\fR<access group id>
Lists the volumes that the access group has been
granted access to
.TP
\fB\-\-volume\-access\-group=\fR<volume id>
Lists the access group(s) that have access to volume
.TP
\fB\-\-volumes\-accessible\-initiator=\fR<initiator id>
Lists the volumes that are accessible by the initiator
.TP
\fB\-\-initiators\-granted\-volume=\fR<volume id>
Lists the initiators that have been granted access to
specified volume
.TP
\fB\-\-restore\-ss=\fR<snapshot id>
Restores a FS or specified files to previous snapshot
state, requires:
.br
\fB\-\-fs\fR <file system>
.br
\fB\-\-file\fR <repeat for each file (optional)>
.br
\fB\-\-fileas\fR <restore file name (optional)>
.br
\fB\-\-all\fR (optional, exclusive option, restores all files
in snapshot other options must be absent)
.TP
\fB\-\-clone\-fs=\fR<source file system id>
Creates a file system clone requires:
.br
\fB\-\-name\fR <file system clone name>
.br
\fB\-\-backing\-snapshot\fR <backing snapshot id> (optional)
.TP
\fB\-\-clone\-file=\fR<file system>
Creates a clone of a file (thin provisioned) requires:
.br
\fB\-\-src\fR  <source file to clone (relative path)>
.br
\fB\-\-dest\fR <destination file (relative path)>
.br
\fB\-\-backing\-snapshot\fR <backing snapshot id> (optional)
.TP
\fB\-\-delete\-volume=\fR<volume id>
Deletes a volume given its id
.TP
\fB\-\-delete\-ss=\fR<snapshot id>
Deletes a snapshot requires \fB\-\-fs\fR
.TP
\fB\-r\fR <volume id>, \fB\-\-replicate\-volume=\fR<volume id>
replicates a volume, requires:
.br
\fB\-\-type\fR [SNAPSHOT|CLONE|COPY|MIRROR_ASYNC|MIRROR_SYNC]
.br
\fB\-\-name\fR <human name>
.br
Optional:
.br
\fB\-\-pool\fR <pool id> (Plugin choice if absent)
.br
.TP
\fB\-\-replicate\-volume\-range\-block\-size=\fR<system id>
size of each replicated block in bytes
.TP
\fB\-\-replicate\-volume\-range=\fR<volume id>
Replicates a portion of a volume, requires:
.br
\fB\-\-type\fR [SNAPSHOT|CLONE|COPY|MIRROR]
.br
\fB\-\-dest\fR <destination volume>
.br
\fB\-\-src_start\fR <source block start number>
.br
\fB\-\-dest_start\fR <destination block start>
.br
\fB\-\-count\fR <number of blocks to replicate>
.TP
\fB\-\-iscsi\-chap=\fR<initiator id>
configures ISCSI inbound/outbound CHAP authentication
.br
Optional:
.br
\fB\-\-in\-user\fR <inbound CHAP user name>
.br
\fB\-\-in\-password\fR <inbound CHAP password>
.br
\fB\-\-out\-user\fR <outbound CHAP user name>
.br
\fB\-\-out\-password\fR <inbound CHAP user password
.TP
\fB\-\-access\-grant=\fR<initiator id>
Grants access to an initiator to a volume
requires:
.br
\fB\-\-type\fR <initiator id type>
.br
\fB\-\-volume\fR <volume id>
.br
\fB\-\-access\fR [RO|RW], read\-only or read\-write
.TP
\fB\-\-access\-grant\-group=\fR<access group id>
Grants access to an access group to a volume
requires:
.br
\fB\-\-volume\fR <volume id>
.br
\fB\-\-access\fR [RO|RW], read\-only or read\-write
.TP
\fB\-\-access\-revoke=\fR<initiator id>
Removes access for an initiator to a volume
requires:
.br
\fB\-\-volume\fR <volume id>
.TP
\fB\-\-access\-revoke\-group=\fR<access group id>
Removes access for access group to a volume
requires:
.br
\fB\-\-volume\fR <volume id>
.br
.TP
\fB\-\-resize\-volume=\fR<volume id>
Re\-sizes a volume, requires:
.br
\fB\-\-size\fR <new size>
.TP
\fB\-\-resize\-fs=\fR<fs id>
Re\-sizes a file system, requires:
.br
\fB\-\-size\fR <new size>
.TP
\fB\-\-nfs\-export\-remove=\fR<nfs export id>
Removes a nfs export
.TP
\fB\-\-nfs\-export\-fs=\fR<file system id>
creates a nfs export
.br
Optional:
.br
\fB\-\-exportpath\fR e.g. /foo/bar.
.br
Note: root, ro, rw are to be repeated for each host
.br
\fB\-\-root\fR <no_root_squash host>
.br
\fB\-\-ro\fR <read only host>
.br
\fB\-\-rw\fR <read/write host>
.br
\fB\-\-anonuid\fR <uid to map to anonymous>
.br
\fB\-\-anongid\fR <gid to map to anonymous>
.br
\fB\-\-auth\-type\fR <NFS client authentication type>
.TP
\fB\-\-job\-status=\fR<job status id>
retrieve information about job
.TP
\fB\-\-volume\-dependants=\fR<volume id>
Returns True if volume has a dependant child
.TP
\fB\-\-volume\-dependants\-rm=\fR<volume id>
Removes dependencies
.TP
\fB\-\-fs\-dependants=\fR<fs id>
Returns true if a child dependency exists.
.br
\fB\-\-file\fR <file> for File check (optional)
.TP
\fB\-\-fs\-dependants\-rm=\fR<fs id>
Removes dependencies
.br
\fB\-\-file\fR <file> for File check (optional)
.IP
.SH COMMAND OPTIONS
.TP
\fB\-\-size\fR=\fIsize\fR
size (Can use B, K, M, G, T, P postfix, IEC sizing) No postfix indicates bytes
.TP
\fB\-\-pool\fR=\fIpool\fR id
pool ID
.TP
\fB\-\-provisioning\fR=\fIPROVISIONING\fR
[DEFAULT|THIN|FULL]
.TP
\fB\-\-type\fR=\fItype\fR
type specifier
.TP
\fB\-\-name\fR=\fIname\fR
human readable name
.TP
\fB\-\-volume\fR=\fIvolume\fR
volume ID
.TP
\fB\-\-access\fR=\fIaccess\fR
[RO|RW], read\-only or read\-write access
.TP
\fB\-\-id\fR=\fIinitiator\fR id
initiator id
.TP
\fB\-\-system\fR=\fIsystem\fR id
system id
.TP
\fB\-\-backing\-snapshot=\fR<backing snapshot>
backing snap shot name for operation
.TP
\fB\-\-src=\fR<source file>
source of operation
.TP
\fB\-\-dest=\fR<source file>
destination of operation
.TP
\fB\-\-file=\fR<file>
file to include in operation, option can be repeated
.TP
\fB\-\-fileas=\fR<fileas>
file to be renamed as, option can be repeated
.TP
\fB\-\-fs=\fR<file system>
file system of interest
.TP
\fB\-\-exportpath=\fR<path for export>
desired export path on array
.TP
\fB\-\-root=\fR<no_root_squash_host>
list of hosts with no_root_squash
.TP
\fB\-\-ro=\fR<read only host>
list of hosts with read/only access
.TP
\fB\-\-rw=\fR<read/write host>
list of hosts with read/write access
.TP
\fB\-\-anonuid=\fR<anonymous uid>
uid to map to anonymous
.TP
\fB\-\-anongid=\fR<anonymous uid>
gid to map to anonymous
.TP
\fB\-\-authtype=\fR<type>
NFS client authentication type
.TP
\fB\-\-all\fR
specify all in an operation
.TP
\fB\-\-src_start=\fR<source block start>
source block address to replicate
.TP
\fB\-\-dest_start=\fR<dest. block start>
destination block address to replicate
.TP
\fB\-\-count=\fR<block count>
number of blocks to replicate
.TP
\fB\-\-in\-user=\fR<username>
CHAP inbound user name
.TP
\fB\-\-in\-password=\fR<password>
CHAP inbound password
.TP
\fB\-\-out\-user=\fR<out_user>
CHAP outbound user name
.TP
\fB\-\-out\-password=\fR<out_password>
CHAP outbound password
.PP
.SH FILES
.TP
~/.lsmcli
lsmcli configuration file, containing name-value pairs separated
by '='. The only currently supported configuration 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 variable.
.SH BUGS
Please report bugs to 
<libstoragemgmt\-devel@lists.sourceforge.net>
.SH AUTHOR
Tony Asleson <tasleson@redhat.com>

.PP