.TH SMACLIENT 1
.SH NAME
smaclient \- tool for accessing z/VM System Management functions
.SH SYNOPSIS
.B smaclient
[FUNCTION]
[OPTION]
[PARAMETER]
.br
.B smaclient
[\-?|\-\-help]
.br
.B smaclient
[-T \fItarget\fR] [-H \fIhost\fR] [-U \fIuser\fR] [-P \fIpass\fR] <function>
.SH DESCRIPTION
.B smaclient
is a tool which provides a line-mode interface to the z/VM System Management
API (SMAPI) for most Unix-compatible systems such as Linux.  Smaclient can
exercise all the VM management interfaces to create, modify and destroy virtual
machines without ever logging into z/VM.
.TP
Executing smaclient without any arguments will print a list of available arguments and options.
.SH REQUIRED OPTIONS
.TP
.BR \-T ", " \-\-target = \fITARGET\fR
set the target image or authorization entry name
.SH GENERAL OPTIONS
.TP
.BR \-H ", " \-\-smhost = \fIHOST\fR
hostname/port of SMAPI server. Specify IUCV if SMAPI IUCV is desired
.TP
.BR \-U ", " \-\-smuser = \fIUSER\fR
authorized SMAPI userid
.TP
.BR \-P ", " \-\-smpass = \fIPASS\fR
authorized SMAPI password
.TP
.BR \-? ", " \-\-help
output usage information
.SH FUNCTIONS
.TP
supported long function names MUST match SMAPI function name. For a list of supported functions, execute smaclient without arguments.
.SH FILES
.PP
/etc/smaclient.conf
.br
~/.smaclient
.TP
For /etc/smaclient.conf and ~/.smaclient, you can specify any or all of the following variables:
.PP
.BR smhost
.br
.RS
For TCP/IP, specify the SMAPI host and port number.  The format is:
.RS
hostname/portnumber
.RE
.br
For IUCV, specify the literal "IUCV".
.RE
.TP
.BR smuser
.br
For TCP/IP, specify the userid authorized to use SMAPPI.
.br
For IUCV, there's no need to specify this, but it doesn't hurt.
.TP
.BR smpass
.br
For TCP/IP, specify the corresponding password.
.br
For IUCV, there's no need to specify this, but it doesn't hurt.
.TP
An example ~/.smaclient:
.PP
smhost="myzvm/44444"
.br
smuser="vsmuser"
.br
smpass="secret"
.SH AUTHOR
smaclient written by Leland Lucius one fun week in the snowy winter of 2011. Manpage written by Rafael Fonseca.
.SH LICENSE
Released under the Artistic License 2.0. Full license text can be found at http://opensource.org/licenses/artistic-license-2.0