.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "VMM 1"
.TH VMM 1 "2020-04-05" "perl v5.30.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
vwm \- Manage VMware virtual machines
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        vwm <command> [options]
.Ve
.IP "\fBGlobal syntax:\fR" 4
.IX Item "Global syntax:"
.Vb 1
\&        vwm <command> [\-f] [\-v+] [\-w seconds] [@profile]
.Ve
.IP "\fBCommand specific syntax:\fR" 4
.IX Item "Command specific syntax:"
.Vb 12
\&        vwm clone [\-o pool] [\-c count] [\-a datastore...] [\-l folder] <source vm> <new vm name>
\&        vwm deploy [synonym of \*(Aqclone\*(Aq]
\&        vwm df [\-h] [datastore...]
\&        vwm host [maintenance|restore|restart|shutdown|disconnect|reconnect] <hosts...>
\&        vwm list [\-d col1,col2... | perl string] [\-t title] [vm|datastore|host|pool|template][s] [patterns...]
\&        vwm migrate [\-p low|normal|high] [\-o pool] <vms...> <host>
\&        vwm move [\-o pool] <vms...> <datastore>
\&        vwm setpool <low|normal|high> <cpu|mem|all> <pools...>
\&        vwm show [vm|datastore|host|pool] [items...]
\&        vwm snapshot [\-t title] <vms...>
\&        vwm state <on|off|suspend|reboot|shutdown|restart|standby> <vms...>
\&        vwm version
.Ve
.SH "COMMANDS"
.IX Header "COMMANDS"
.IP "\fBclone\fR" 8
.IX Item "clone"
Clone a given \s-1VM\s0 or template to another \s-1VM\s0 name.
If \-c is specified multiple copies are made. Each \s-1VM\s0 name will be incremented in the usual Perlish way. e.g.: \s-1DB1, DB2, DB3\s0 etc.
.Sp
If \-a is unspcified the datastore of the source \s-1VM\s0 is copied as the new clones datastore.
If \-a is specified the data store will be set during cloning. If \-a contains a comma denoted list the datastores will be alternated during cloning. e.g. \-a 1,2 copies to datastore 1 then 2 then starts again at 1. Patterns of repeating datastores can be specified \- e.g. '\-a 1,2,3,2,1'.
.IP "\fBdeploy\fR" 8
.IX Item "deploy"
Synonym of 'clone'.
.IP "\fBdf\fR" 8
.IX Item "df"
Display disk usage information about datastores.
If a list of matches is provided, the data store list is filtered for those items.
.IP "\fBlist\fR" 8
.IX Item "list"
Display a list of the given items matching a pattern.
.Sp
Possible lists include (selection can be plural or singular):
.Sp
.Vb 4
\&        vms (default if unspecified)
\&        datastores
\&        hosts
\&        pools
.Ve
.Sp
If '\-d' is specified without any containing '$' marks the string is evaluated as a \s-1CSV\s0 with each line extracting the requisite information that would be shown with the 'show' command. See the \s-1EXAMPLES\s0 section for further information.
.Sp
If '\-d' is specified and contains a '$' it is evaluated as a perl expression with \f(CW$_\fR being set to the currently active item.
.Sp
If '\-t' is spcified the titles header for the table is set.
.IP "\fBmigrate\fR" 8
.IX Item "migrate"
Migrate a given list of VMs to another host.
.IP "\fBmove\fR" 8
.IX Item "move"
Move a given list of VMs to another datastore.
.IP "\fBsetpool\fR" 8
.IX Item "setpool"
Set the share level on the given resource pools.
.IP "\fBshow\fR" 8
.IX Item "show"
Show information about a given object. If no specific object type is specified 'vm' is assumed.
If no specific matching pattern is specified all objects of that type are listed.
.IP "\fBsnapshot\fR" 8
.IX Item "snapshot"
Take a snapshot of the matching \s-1VM\s0's.
If '\-t' is specified, it is used as the title of the snapshot. Otherwise the current time is used.
.IP "\fBstate\fR" 8
.IX Item "state"
Set the state of a list of VMs.
.Sp
This can be any of the following choices:
.Sp
.Vb 7
\&        on \- Power up the specified VMs
\&        off \- Power down the specified VMs. This is a hard power state so data loss could occur.
\&        suspend \- Power the machine into standby mode. This is a hard power state which does not rely on VMware tools.
\&        restart \- Hard power cycle the VMs. Like \*(Aqoff\*(Aq this is a forced power state so data loss could occur.
\&        shutdown \- Try shutting down the machine via VMware tools.
\&        standby \- Try to put the machine into the soft standby state.
\&        reboot \- Try shutting down the machine via VMware tools.
.Ve
.IP "\fBversion\fR" 8
.IX Item "version"
Display various version informaiton about the connected vServer and local \s-1API.\s0
This command is the default if no actual command is specified (i.e. just running 'vwm' with nothing else specified).
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB[@profile]\fR" 8
.IX Item "[@profile]"
.RS 8
.PD 0
.IP "\fBUsed during:\fR All operations" 4
.IX Item "Used during: All operations"
.IP "\fBDefault:\fR First specified profile in config" 4
.IX Item "Default: First specified profile in config"
.IP "\fBType:\fR Profile name or \s-1URL\s0" 4
.IX Item "Type: Profile name or URL"
.RE
.RS 8
.PD
.Sp
Specifies which profile to use when addressing the vServer.
This can be an entry within the config file or the \s-1URL\s0 (with optional login details) e.g.
.Sp
.Vb 5
\&        vwm version @cluster1
\&        vwm version @cluster2
\&        vwm version @https://cluster1.acme.edu
\&        vwm version @https://username@cluster1.acme.edu
\&        vwm version @https://username:password@cluster1.acme.edu
.Ve
.Sp
Examples 1 and two assume 'custer1' and 'customer2' have been defined in the examples file (see \s-1EXAMPLES\s0). The further examples specify the connection information on the command line.
Specifying the password from the command line is exceptionally silly and should be avoided.
.Sp
If username and/or password is omitted (such as in examples 3 and 4 above) they will be prompted for when vwm is run.
.RE
.IP "\fB\-c\fR" 8
.IX Item "-c"
.RS 8
.PD 0
.IP "\fBUsed during:\fR migrate" 4
.IX Item "Used during: migrate"
.IP "\fBDefault:\fR 1" 4
.IX Item "Default: 1"
.IP "\fBType:\fR Number" 4
.IX Item "Type: Number"
.RE
.RS 8
.PD
.Sp
Specifies how many VMs should be created during a clone operation.
The name of the target \s-1VM\s0 is incremented in the usual Perlish way.
e.g.
.Sp
\&\s-1DBS1, DBS2, DBS3... DBS10
DB00, DB01, DB02... DB99
DBAA, DBAB, DBAC... DBZZ\s0
.RE
.IP "\fB\-\-display [col1,col2...]\fR" 8
.IX Item "--display [col1,col2...]"
.PD 0
.IP "\fB\-d [col1,col2...]\fR" 8
.IX Item "-d [col1,col2...]"
.RS 8
.IP "\fBUsed during:\fR list" 4
.IX Item "Used during: list"
.IP "\fBDefault:\fR Name" 4
.IX Item "Default: Name"
.IP "\fBType:\fR" 4
.IX Item "Type:"
.PD
Command seperated list of columns to display in tabular output when using the 'list' command.
See also: \-s to specify the seperation character to use between the columns.
.RE
.RS 8
.Sp
Specify a data store for operations that require it.
.RE
.IP "\fB\-\-datastore [datastore]\fR" 8
.IX Item "--datastore [datastore]"
.PD 0
.IP "\fB\-\-ds [datastore]\fR" 8
.IX Item "--ds [datastore]"
.IP "\fB\-a [datastore]\fR" 8
.IX Item "-a [datastore]"
.RS 8
.IP "\fBUsed during:\fR migrate" 4
.IX Item "Used during: migrate"
.IP "\fBDefault:\fR Same as source \s-1VM\s0" 4
.IX Item "Default: Same as source VM"
.IP "\fBType:\fR Datastore name" 4
.IX Item "Type: Datastore name"
.RE
.RS 8
.PD
.Sp
Specify a data store for operations that require it.
.RE
.IP "\fB\-\-force\fR" 8
.IX Item "--force"
.PD 0
.IP "\fB\-f\fR" 8
.IX Item "-f"
.RS 8
.IP "\fBUsed during:\fR All operations" 4
.IX Item "Used during: All operations"
.IP "\fBDefault:\fR off" 4
.IX Item "Default: off"
.IP "\fBType:\fR Switch" 4
.IX Item "Type: Switch"
.RE
.RS 8
.PD
.Sp
Force continue if an error occurs.
Normaly if an error occurs vwm will stop processing any operations specified on the command line.
If this flag is enabled vwm will continue operation as if no error occured.
.RE
.IP "\fB\-\-human\fR" 8
.IX Item "--human"
.PD 0
.IP "\fB\-h\fR" 8
.IX Item "-h"
.RS 8
.IP "\fBUsed during:\fR df" 4
.IX Item "Used during: df"
.IP "\fBDefault:\fR off" 4
.IX Item "Default: off"
.IP "\fBType:\fR Switch" 4
.IX Item "Type: Switch"
.RE
.RS 8
.PD
.Sp
Display the numbers of the 'df' command in a human readable format.
.RE
.IP "\fB\-\-dryrun\fR" 8
.IX Item "--dryrun"
.PD 0
.IP "\fB\-n\fR" 8
.IX Item "-n"
.RS 8
.IP "\fBUsed during:\fR All operations" 4
.IX Item "Used during: All operations"
.IP "\fBDefault:\fR off" 4
.IX Item "Default: off"
.IP "\fBType:\fR Switch" 4
.IX Item "Type: Switch"
.RE
.RS 8
.PD
.Sp
Dry run mode.
When enabled vwm will continue as normal but no actual call to the VMware VServer is made.
.RE
.IP "\fB\-\-folder\fR" 8
.IX Item "--folder"
.PD 0
.IP "\fB\-l\fR" 8
.IX Item "-l"
.RS 8
.IP "\fBUsed during:\fR clone" 4
.IX Item "Used during: clone"
.IP "\fBDefault:\fR Source \s-1VM /\s0 templates folder" 4
.IX Item "Default: Source VM / templates folder"
.IP "\fBType:\fR String" 4
.IX Item "Type: String"
.RE
.RS 8
.PD
.Sp
Specifies the folder that the cloned machine should be moved into. If unspecified the source \s-1VM\s0's folder is used instead.
.RE
.IP "\fB\-\-pool [pool]\fR" 8
.IX Item "--pool [pool]"
.PD 0
.IP "\fB\-o [pool]\fR" 8
.IX Item "-o [pool]"
.RS 8
.IP "\fBUsed during:\fR clone, migrate, move" 4
.IX Item "Used during: clone, migrate, move"
.IP "\fBDefault:\fR Same as the source \s-1VM\s0" 4
.IX Item "Default: Same as the source VM"
.IP "\fBType:\fR Pool name" 4
.IX Item "Type: Pool name"
.RE
.RS 8
.PD
.Sp
Specifies the alternate pool name to use when migrating or cloning machines. If unspecified the source \s-1VM\s0's pool is used instead.
.RE
.IP "\fB\-\-priority [priority]\fR" 8
.IX Item "--priority [priority]"
.PD 0
.IP "\fB\-p [priority]\fR" 8
.IX Item "-p [priority]"
.RS 8
.IP "\fBUsed during:\fR migrate" 4
.IX Item "Used during: migrate"
.IP "\fBDefault:\fR low" 4
.IX Item "Default: low"
.IP "\fBType:\fR Choice of: low, normal, high" 4
.IX Item "Type: Choice of: low, normal, high"
.RE
.RS 8
.PD
.Sp
Specifies the priority when migrating VMs.
.RE
.IP "\fB\-\-seperator [character]\fR" 8
.IX Item "--seperator [character]"
.PD 0
.IP "\fB\-s [character]\fR" 8
.IX Item "-s [character]"
.RS 8
.IP "\fBUsed during:\fR list" 4
.IX Item "Used during: list"
.IP "\fBDefault:\fR \et (tab)" 4
.IX Item "Default: t (tab)"
.IP "\fBType:\fR String" 4
.IX Item "Type: String"
.RE
.RS 8
.PD
.Sp
Specifies the string to display between columns when outputing a list.
.RE
.IP "\fB\-\-title [title]\fR" 8
.IX Item "--title [title]"
.PD 0
.IP "\fB\-t [title]\fR" 8
.IX Item "-t [title]"
.RS 8
.IP "\fBUsed during:\fR list, snapshot" 4
.IX Item "Used during: list, snapshot"
.IP "\fBDefault:\fR The Unix \s-1EPOC\s0 (for VMs)" 4
.IX Item "Default: The Unix EPOC (for VMs)"
.IP "\fBType:\fR String" 4
.IX Item "Type: String"
.RE
.RS 8
.PD
.Sp
The title of the snapshot to create or the title row of the list table.
.RE
.IP "\fB\-v\fR" 8
.IX Item "-v"
.PD 0
.IP "\fB\-\-verbose\fR" 8
.IX Item "--verbose"
.RS 8
.IP "\fBUsed during:\fR All operations" 4
.IX Item "Used during: All operations"
.IP "\fBDefault:\fR 0" 4
.IX Item "Default: 0"
.IP "\fBType:\fR Accumulating switch" 4
.IX Item "Type: Accumulating switch"
.RE
.RS 8
.PD
.Sp
Be more verbose when outputting information to \s-1STDERR.\s0
Specify multiple times to increase verbosity.
.RE
.IP "\fB\-w [seconds]\fR" 8
.IX Item "-w [seconds]"
.PD 0
.IP "\fB\-wait [seconds]\fR" 8
.IX Item "-wait [seconds]"
.RS 8
.IP "\fBUsed during:\fR clone, host, migrate, setpool, state" 4
.IX Item "Used during: clone, host, migrate, setpool, state"
.IP "\fBDefault:\fR 0" 4
.IX Item "Default: 0"
.IP "\fBType:\fR Number of seconds" 4
.IX Item "Type: Number of seconds"
.RE
.RS 8
.PD
.Sp
Force a wait for the specified number of seconds between operations.
.RE
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A command line tool for the manipulation of VMware Virtual Machines (\s-1VM\s0).
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.IP "\fBvwm clone \s-1VM01 VM02\s0\fR" 4
.IX Item "vwm clone VM01 VM02"
Clone \s-1VM01\s0 to \s-1VM02.\s0
Since neither the datasource (\-d) or pool (\-o) is specified these details are copied from \s-1VM01.\s0
.IP "\fBvwm clone \s-1DB00 DB01\s0 \-c 30\fR" 4
.IX Item "vwm clone DB00 DB01 -c 30"
Clone \s-1DB01\s0 to \s-1DB02\s0 creating 30 copies. This will actually make the machines \s-1DB01\s0 to \s-1DB30.\s0
Since neither the datasource (\-d) or pool (\-o) is specified these details are copied from \s-1VM01.\s0
.IP "\fBvwm clone \s-1DB00 DB01\s0 \-c 30 \-d \s-1SAN1,SAN2\s0 \-o Active\fR" 4
.IX Item "vwm clone DB00 DB01 -c 30 -d SAN1,SAN2 -o Active"
Same as the above example but spread the datastores across \s-1SAN1\s0 and \s-1SAN2\s0 and move the machine to the 'Active' pool.
.IP "\fBvwm deploy Template-DBServer \s-1DB05\s0 \-l Databases\fR" 4
.IX Item "vwm deploy Template-DBServer DB05 -l Databases"
Deploys the template Template-DBServer into \s-1DB05,\s0 moving the destination into the Databases folder.
.IP "\fBvwm clone Template-DBServer \s-1DB05\s0 \-l Databases\fR" 4
.IX Item "vwm clone Template-DBServer DB05 -l Databases"
This is exactly the same as above. A clone and deploy operations will automatically figure out if the source is a template and act accordingly.
.IP "\fBvwm df *2\fR" 4
.IX Item "vwm df *2"
Display a datastore usage sheet (similar to the Unix 'df' command) for all datastores ending in '2'.
.IP "\fBvwm host maintenance Moe Homer\fR" 4
.IX Item "vwm host maintenance Moe Homer"
Put the hosts 'Moe' and 'Homer' into maintenance mode (use 'restore' to recover from this).
.IP "\fBvwm list vms\fR" 4
.IX Item "vwm list vms"
List all VMs.
.IP "\fBvwm list vms \-d name,host,ip\fR" 4
.IX Item "vwm list vms -d name,host,ip"
List all VMs \- showing their name, currently allocated host and \s-1IP\s0 address.
.IP "\fBvwm migrate DBS* Carl\fR" 4
.IX Item "vwm migrate DBS* Carl"
Migrate all virtual machines matching 'DBS*' to the 'Carl' host.
.IP "\fBvwm migrate DBS* Lenny \-w 60 \-o Active \-p high\fR" 4
.IX Item "vwm migrate DBS* Lenny -w 60 -o Active -p high"
Migrate all virtual machines matching 'DBS*' with high priority to the 'Active' pool on the 'Lenny' host waiting 60 seconds between machine.
.IP "\fBvwm move \s-1DB00 DB01 SAN2\s0 \f(CB@cluster2\fB\fR" 4
.IX Item "vwm move DB00 DB01 SAN2 @cluster2"
Move VMs \s-1DB00\s0 and \s-1DB01\s0 to the \s-1SAN2\s0 datastore within profile 'cluster2'.
.IP "\fBvwm show host Lisa\fR" 4
.IX Item "vwm show host Lisa"
Show information on host 'Lisa'.
.IP "\fBvwm snapshot \s-1DB04 DB05\s0 \-t 'Todays backup'\fR" 4
.IX Item "vwm snapshot DB04 DB05 -t 'Todays backup'"
Take a snapshot of VMs '\s-1DB04\s0' and '\s-1DB05\s0' using the title 'Todays backup'
.IP "\fBvwm state on \s-1DB00 DB01\s0 \-w 30\fR" 4
.IX Item "vwm state on DB00 DB01 -w 30"
Turn \s-1DB00\s0 and \s-1DB01\s0 on waiting 30 seconds between machines.
.IP "\fBvwm state on \s-1DB00 DB01\s0 \-w 30 \-f\fR" 4
.IX Item "vwm state on DB00 DB01 -w 30 -f"
Turn DB* VMs on.
\&\-f ensures that even if any of the machines fail to turn on for any reason the remaining machines will still be sent the 'on' command.
.SH "FILES"
.IX Header "FILES"
.IP "\fB/etc/vmmrc\fR" 8
.IX Item "/etc/vmmrc"
\&\s-1VMM\s0 config file for all users.
.IP "\fB.vmmrc\fR" 8
.IX Item ".vmmrc"
\&\s-1VMM\s0 config file for the local user.
.SH "CONFIG"
.IX Header "CONFIG"
The /etc/vmmrc and .vmmrc files will be processed to determine \s-1VMM\s0's configuration, the latter file taking precedence.
.PP
The layout of the config file spcifies which profiles to use.
.PP
.Vb 10
\&        [GLOBAL]
\&        rewrite host = s/^(.+?)\e./\e1/
\&        verbose = 2
\&        profile = Cluster1
\&        dryrun = 0
\&        human = 1
\&        force = 0
\&        seperator = \et
\&        http_proxy = http://myproxy.example.com:8080
\&        https_proxy = http://myproxy.example.com:8080
\&        
\&        [Cluster1]
\&        url = https://cluster1.acme.edu
\&        username = admin
\&        password = password
\&        
\&        [Cluster2]
\&        url = https://cluster2.acme.edu
\&        username = administrator
\&        password = changeme
.Ve
.IP "\fB[\s-1GLOBAL\s0]\fR" 8
.IX Item "[GLOBAL]"
The meta global section. Any option specified here will be automatically carried into each profiles config.
.Sp
In the main example Cluster1 will have a 'verbose' option of 2. Cluster2 will have a 'verbose' option of 1 since it overrides the global setting.
.IP "\fB[profile]\fR" 8
.IX Item "[profile]"
The name (case-insensitive) of the profile to define.
.IP "\fBurl\fR" 8
.IX Item "url"
The connection \s-1URL\s0 of the vServer system within the profile
.IP "\fBusername\fR and \fBpassword\fR" 8
.IX Item "username and password"
The authentication information when connecting to the vServer.
.IP "\fBdryrun\fR" 8
.IX Item "dryrun"
Specify a default dry run value. See \fB\-n\fR for further information.
.IP "\fBforce\fR" 8
.IX Item "force"
If an error is encounted during a multiple \s-1VM\s0 operation the default behaviour is to stop execution. If this setting is set to '1' this behaviour will be overridden and operations will continue even if an error is encounted.
.IP "\fBhttp_proxy\fR" 8
.IX Item "http_proxy"
.PD 0
.IP "\fBhttps_proxy\fR" 8
.IX Item "https_proxy"
.PD
Forceably set the \s-1HTTP\s0(s)_PROXY environment variable to the provided value before connecting.
This is included to assist basic login shells where these variables are not imported correctly.
.IP "\fBhuman\fR" 8
.IX Item "human"
Always output numbers in a human readable format rather than the raw form.
.IP "\fBpriority\fR" 8
.IX Item "priority"
Specify a default priority when using any command that is '\-p' compatible.
.IP "\fBprofile\fR" 8
.IX Item "profile"
Specify the default profile to use if none is explicitally set. If not specified the first found profile in the config file is used.
.IP "\fBrewrite host\fR" 8
.IX Item "rewrite host"
Specify a substitution regular expression to use when correcting host names.
The value given in the above example will remove any trailing \s-1DNS\s0 name correcting 'host1.a.very.long.dns.com' to 'host1'.
.IP "\fBseperator\fR" 8
.IX Item "seperator"
Specify the seperator character used when outputting tabular data with the 'list' command.
.IP "\fBverbose\fR" 8
.IX Item "verbose"
Specify a default verbosity level. See \fB\-v\fR for further information.
.SH "INSTALLATION"
.IX Header "INSTALLATION"
\&\s-1VMM\s0 requires a few external modules before it can work correctly. Follow the following stages to get everything working.
.PP
* Install the VMware Perl \s-1SDK\s0 from http://www.vmware.com/support/developer/viperltoolkit/
.PP
.Vb 2
\& This requires the packages libclass\-methodmaker\-perl libcrypt\-ssleay\-perl 
\& libsoap\-lite\-perl libuuid\-perl libxml\-libxml\-perl.
.Ve
.PP
* Setup the config file. See either the \s-1CONFIG\s0 section above or use the sample file from /usr/share/doc/vmware\-manager.
.PP
* Run \s-1VMM\s0 with a simple command to make sure everything is setup right.
.PP
.Vb 1
\&        vwm version
.Ve
.PP
* Enjoy
.SH "BUGS"
.IX Header "BUGS"
Quite probably.
.PP
Please report to https://github.com/hash\-bang/VMM when found.
.SH "AUTHOR"
.IX Header "AUTHOR"
Matt Carter <m@ttcarter.com>