9.0

Using vmrun to Control Virtual Machines
14 VMware, Inc.
removeSharedFolder
(VMwarevSphereand
VMwareServerdonot
supportsharedfolders.)
Removestheguestvirtualmachine’saccesstoashared
folderonthehost.Thesharenameisamountpointin
theguestfilesystem.
<pathto.vmxfile>
<sharename>
setSharedFolderState
(VMwarevSphereand
VMwareServerdonot
supportsharedfolders.)
Modifiesthewrit
abilitystateofaspecifiedfoldershared
betweenthehostandaguestvirtualmachine(.vmxfile).
Thesharenameisamountpointintheguestfilesystem.
Thepathtofolderistheexporteddirectoryonthehost.
Asharedfoldercanbemadewritableorread‐only.
<pathto.v
mxfile>
<sharename>
<pathtofolderonhost>
writable |readonly
captureScreen Capturesthescreenofthevirtualmachinetoalocalfile.
ThespecifiedoutputfileonthehostisinPNGformat.
Avalidguestloginisrequired.
<pathto.vmxfile>
<outputpathonhost>
writeVariable Writesavariabletothevirtualma
chinestateorguest.
Youcanseteitheranon‐persistentguestvariable
(guestVar),aruntimeconfigurationparameteras
storedinthe.vmxfile,oranenvironmentvariable
(guestEnv)intheguestoperatingsystem.Aguest
variableisaruntime‐onlyvaluethatprovidesasimple
waytopassrunt
imevaluesinandoutoftheguest.
EnvironmentvariablesrequireVMwareToolsandvalid
guestlogin.WithLinux,settingtheguestenvironment
alsorequiresrootlogin.
Providethevariablenameanditsvalue.
<pathto.vmxfile>
[ guestVar |
runtimeConfig |
guestEnv ]
<variablename>
<variablevalue>
readVariable Readsavariablefromthevirtualmachinest
ateorguest.
Youcangetaguestvariable,aruntimeconfigurationas
storedinthe.vmxfile,orenvironmentvariablesinthe
guestoperatingsystem.ReadingtheguestEnvrequires
avalidguestlogin.
Seeaboveforadescriptionofvariabletypes.
<pathto.vmxfile>
[ guestVar |
runtimeConfig |
guestEnv ]
<variablename>
Maintenance Commands
list Listsallru
nningvirtualmachines. None
upgradevm Upgradesavirtualmachinetothecurrentversionof
virtualhardware.Hasnoeffectifthevirtualhardware
versionisthemostrecentsupported.
<pathto.vmxfile>
installTools PreparestoinstallVMwareToolsintheguestoperating
system.InWindowsguestswithautorunenabled,the
VMwareToolsinstallerst
artsbyitself.InLinuxguests
withoutautorun,thiscommandconnectsthevirtual
CD‐ROMdrivetotheVMwareToolsISOimagesuitable
fortheguest,buttheinstallerdoesnotstart.Youmust
completetheinstallationwithadditionalmanualsteps,
asdescribedintheproductdocumentation.
<pathto.vmxfile>
register
(Registra
tionnotsupported
onWorkstationoron
VMwareFusion.)
Registersthespecifiedvirtualmachine,addingittothe
host’sinventory.Pathformatdependsontheproduct.
ForESX/ESXihosts,"[datastore1] vm/vm.vmx"
(startingwiththedatastore)istypical.
<pathto.vmxfile>
unregister
(Registrationnotsupported
onWorkstationoron
VMwareFusion.)
Unregistersthespecifiedvi
rtualmachine,removingit
fromthehost’sinventory.Pathformatdependsonthe
product.ForESX/ESXi,"[datastore1] vm/vm.vmx"
(startingwiththedatastore)istypical.
<pathto.vmxfile>
listRegisteredVM Listsallregisteredvirtualmachines. None
deleteVM Removesthespecifiedvirtualmachine. <pathto.vmxfile>
Table 2. vmrun Commands and Parameters (Continued)
Command Description Parameters