1SMACLIENT(1)                General Commands Manual               SMACLIENT(1)
2
3
4

NAME

6       smaclient - tool for accessing z/VM System Management functions
7

SYNOPSIS

9       smaclient [FUNCTION] [OPTION] [PARAMETER]
10       smaclient [-?|--help]
11       smaclient [-T target] [-H host] [-U user] [-P pass] <function>
12

DESCRIPTION

14       smaclient  is  a  tool which provides a line-mode interface to the z/VM
15       System Management API (SMAPI) for most Unix-compatible systems such  as
16       Linux.  Smaclient can exercise all the VM management interfaces to cre‐
17       ate, modify and destroy virtual  machines  without  ever  logging  into
18       z/VM.
19
20       Executing  smaclient  without any arguments will print a list of avail‐
21       able arguments and options.
22

REQUIRED OPTIONS

24       -T, --target=TARGET
25              set the target image or authorization entry name
26

GENERAL OPTIONS

28       -H, --smhost=HOST
29              hostname/port of SMAPI server. Specify IUCV  if  SMAPI  IUCV  is
30              desired
31
32       -U, --smuser=USER
33              authorized SMAPI userid
34
35       -P, --smpass=PASS
36              authorized SMAPI password
37
38       -?, --help
39              output usage information
40

FUNCTIONS

42       supported  long  function  names  MUST match SMAPI function name. For a
43       list of supported functions, execute smaclient without arguments.
44

FILES

46       /etc/smaclient.conf
47       ~/.smaclient
48
49       For /etc/smaclient.conf and ~/.smaclient, you can specify any or all of
50       the following variables:
51
52       smhost
53              For  TCP/IP, specify the SMAPI host and port number.  The format
54              is:
55                     hostname/portnumber
56              For IUCV, specify the literal "IUCV".
57
58       smuser
59              For TCP/IP, specify the userid authorized to use SMAPPI.
60              For IUCV, there's no need to specify this, but it doesn't hurt.
61
62       smpass
63              For TCP/IP, specify the corresponding password.
64              For IUCV, there's no need to specify this, but it doesn't hurt.
65
66       An example ~/.smaclient:
67
68       smhost="myzvm/44444"
69       smuser="vsmuser"
70       smpass="secret"
71

AUTHOR

73       smaclient written by Leland Lucius one fun week in the snowy winter  of
74       2011. Manpage written by Rafael Fonseca.
75

LICENSE

77       Released under the Artistic License 2.0. Full license text can be found
78       at http://opensource.org/licenses/artistic-license-2.0
79
80
81
82                                                                  SMACLIENT(1)