Index (VMware vSphere Web Services SDK JAXWS Java Samples Documentation)







function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Index (VMware vSphere Web Services SDK JAXWS Java Samples Documentation)";
}
}



















Overview 
Package 
Class 
Tree 
Deprecated 
 Index 










 PREV 
 NEXT

FRAMES  
 NO FRAMES  
 



All Classes









A B C D E G H L M N O P R S T U V W

A

AcquireSessionInfo - Class in com.vmware.host AcquireSessionInfo This sample will acquire a session with VC or ESX and print a cim service ticket and related session information to a file Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication host [required] : Name of the host info [optional] : Type of info required only [cimticket] for now file [optional] : Full path of the file to save data to Command Line: run.bat com.vmware.general.Browser --url [webserviceurl] --username [username] --password [password] --host [hostname] --info [password] --file [path_to_file]AcquireSessionInfo() -
Constructor for class com.vmware.host.AcquireSessionInfo
 
actionPerformed(ActionEvent) -
Method in class com.vmware.performance.VIUsage
 
addPassword(String, String, char[]) -
Method in interface com.vmware.security.credstore.CredentialStore
Stores the password for a given host and username.
AddVirtualNic - Class in com.vmware.host AddVirtualNic This sample is used to add a Virtual Nic to a PortGroup Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication portgroupname [required] : Name of the port group ipaddress [optional] : ipaddress for the nic, if not set DHCP will be in affect for the nic hostname [optional] : Name of the host datacentername [optional] : Name of the datacenter Command Line: Add VirtualNic to a PortGroup on a Virtual Switch run.bat com.vmware.host.AddVirtualNic --url [webserviceurl] --username [username] --password [password] --hostname [hostname] --datacentername [mydatacenter] --portgroupname [myportgroup] --ipaddress [AAA.AAA.AAA.AAA] Add VirtualNic to a PortGroup on a Virtual Switch without hostname run.bat com.vmware.host.AddVirtualNic --url [webserviceurl] --username [username] --password [password] --datacentername [mydatacenter] --portgroupname [myportgroup] --ipaddress [AAA.AAA.AAA.AAA] Add VirtualNic to a PortGroup on a Virtual Switch without datacentername run.bat com.vmware.host.AddVirtualNic --url [webserviceurl] --username [username] --password [password] --portgroupname [myportgroup] --ipaddress [AAA.AAA.AAA.AAA]AddVirtualNic() -
Constructor for class com.vmware.host.AddVirtualNic
 
AddVirtualSwitch - Class in com.vmware.host AddVirtualSwitch This sample is used to add a virtual switch Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication vswitchid [required]: Name of the switch to be added hostname [required]: Name of the host Command Line: Add a Virtual Switch run.bat com.vmware.host.AddVirtualSwitch --url [webserviceurl] --username [username] --password [password] --hostname [hostname] --vswitchid [mySwitch]AddVirtualSwitch() -
Constructor for class com.vmware.host.AddVirtualSwitch
 
AddVirtualSwitchPortGroup - Class in com.vmware.host AddVirtualSwitchPortGroup This sample is used to add a Virtual Machine Port Group to a vSwitch Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication vswitchid [required] : Name of the vSwitch to add portgroup to portgroupname [required] : Name of the port group hostname [optional] : Name of the host Command Line: Add Virtual switch Port Group: run.bat com.vmware.host.AddVirtualSwitchPortGroup --url [webserviceurl] --username [username] --password [password] --vswitchid [mySwitch] --portgroupname [myportgroup] --hostname [hostname]AddVirtualSwitchPortGroup() -
Constructor for class com.vmware.host.AddVirtualSwitchPortGroup
 



B

Basics - Class in com.vmware.performance Basics This sample displays available performance counters or other data for an requested ESX system.Basics() -
Constructor for class com.vmware.performance.Basics
 
Browser - Class in com.vmware.general Browser This sample prints managed entity, its type, reference value, property name, Property Value, Inner Object Type, its Inner Reference Value and inner property value Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication Command Line: run.bat com.vmware.general.Browser --url [webserviceurl] --username [username] --password [password]Browser() -
Constructor for class com.vmware.general.Browser
 



C

clearPasswords() -
Method in interface com.vmware.security.credstore.CredentialStore
Removes all passwords.
close() -
Method in interface com.vmware.security.credstore.CredentialStore
Closes this credential store and frees all resources associated with it.
ColdMigration - Class in com.vmware.httpfileaccess ColdMigration This sample puts VM files in specified Datacenter and Datastore and register and reconfigure the particular VM Parameters: url [required]: url of the web service.ColdMigration() -
Constructor for class com.vmware.httpfileaccess.ColdMigration
 
com.vmware.alarms - package com.vmware.alarms com.vmware.events - package com.vmware.events com.vmware.general - package com.vmware.general com.vmware.guest - package com.vmware.guest com.vmware.host - package com.vmware.host com.vmware.httpfileaccess - package com.vmware.httpfileaccess com.vmware.performance - package com.vmware.performance com.vmware.performance.widgets - package com.vmware.performance.widgets com.vmware.scheduling - package com.vmware.scheduling com.vmware.scsilun - package com.vmware.scsilun com.vmware.security.credstore - package com.vmware.security.credstore com.vmware.simpleagent - package com.vmware.simpleagent com.vmware.storage - package com.vmware.storage com.vmware.vapp - package com.vmware.vapp com.vmware.vm - package com.vmware.vm Connect - Class in com.vmware.general Connect This sample simply connects to an ESX server or to vCenter server Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication Command Line: run.bat com.vmware.general.Connect --url [webserviceurl] --username [username] --password [password]Connect() -
Constructor for class com.vmware.general.Connect
 
Create - Class in com.vmware.general Create This sample creates managed entity like Host-Standalone Cluster Datacenter, and folder Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication parentname [required] : specifies the name of the parent folder itemtype [required] : Type of the object to be added e.g.Create() -
Constructor for class com.vmware.general.Create
 
CreateStorageDRS - Class in com.vmware.storage This sample demonstrates how to create Storage DRS Parameters: url [required]: url of the web service.CreateStorageDRS() -
Constructor for class com.vmware.storage.CreateStorageDRS
 
CreateTemporaryFile - Class in com.vmware.guest CreateTemporaryFile This sample creates a temporary file inside a virtual machine.CreateTemporaryFile() -
Constructor for class com.vmware.guest.CreateTemporaryFile
 
CreateUser - Class in com.vmware.simpleagent CreateUser The CreateUser class creates a user account and password stores them the local credential store.CreateUser() -
Constructor for class com.vmware.simpleagent.CreateUser
 
CredentialStore - Interface in com.vmware.security.credstoreA credential store.CredentialStoreAdmin - Class in com.vmware.security.credstoreThe CredentialStoreAdmin class is a command-line tool that provides complete access to the credential store backing file on the local machine.CredentialStoreAdmin() -
Constructor for class com.vmware.security.credstore.CredentialStoreAdmin
 
CredentialStoreFactory - Class in com.vmware.security.credstoreFactory class providing instances of a {linkplain CredentialStore credential store}.CredentialStoreFactory() -
Constructor for class com.vmware.security.credstore.CredentialStoreFactory
 



D

Delete - Class in com.vmware.general Delete This sample deletes the specified managed entity from the inventory tree The managed entity can be a virtual machine, ClusterComputeResource or a Folder Parameters url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication entityname [required] : Virtual Machine|ClusterComputeResource|Folder Command Line: To delete a folder named 'testFolder' run.bat com.vmware.general.Delete --url [webserviceurl] --username [username] --password [password] --entityname [testFolder] To delete a datacenter named myData run.bat com.vmware.general.Delete --url [webserviceurl] --username [username] --password [password] --entityname [myData]Delete() -
Constructor for class com.vmware.general.Delete
 
DeleteOneTimeScheduledTask - Class in com.vmware.scheduling DeleteOneTimeScheduledTask This sample demonstrates deleting a scheduled task Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication taskname [required] : name of the task to be deleted Command Line: run.bat com.vmware.scheduling.DeleteOneTimeScheduledTask --url [webserviceurl] --username [username] --password [password] --taskname [TaskToBeDeleted]DeleteOneTimeScheduledTask() -
Constructor for class com.vmware.scheduling.DeleteOneTimeScheduledTask
 
DownloadGuestFile - Class in com.vmware.guest DownloadGuestFile This sample downloads a file from the guest to a specified path on the host where the client is running.DownloadGuestFile() -
Constructor for class com.vmware.guest.DownloadGuestFile
 
DVSCreate - Class in com.vmware.host This sample demonstrates how to create/update Distributed Virtual Switch Parameters: url [required]: url of the web service.DVSCreate() -
Constructor for class com.vmware.host.DVSCreate
 



E

EventFormat - Class in com.vmware.events EventFormat This sample retrieves and formats the lastEvent from Hostd or Vpxd Parameters: url [required] : url of the web service.EventFormat() -
Constructor for class com.vmware.events.EventFormat
 
EventHistoryCollectorMonitor - Class in com.vmware.events EventHistoryCollectorMonitor This sample demonstrates how to create and monitor an EventHistoryCollector This sample uses the latestPage property of the EventHistoryCollector to filter the Events Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication Command Line: run.bat com.vmware.vm.EventHistoryCollectorMonitor --url [webserviceurl] --username [username] --password [password]EventHistoryCollectorMonitor() -
Constructor for class com.vmware.events.EventHistoryCollectorMonitor
 



G

getCredentialStore() -
Static method in class com.vmware.security.credstore.CredentialStoreFactory
Returns the default credential store.
getCredentialStore(File) -
Static method in class com.vmware.security.credstore.CredentialStoreFactory
Returns a credential store given the file backing it.
GetCurrentTime - Class in com.vmware.general GetCurrentTime This sample gets the current time of the vSphere Server Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication Command Line: run.bat com.vmware.general.GetCurrentTime --url [webservicesurl] --username [Username] --password [password]GetCurrentTime() -
Constructor for class com.vmware.general.GetCurrentTime
 
GetHostName - Class in com.vmware.general GetHostName This sample gets the hostname and additional details of the ESX Servers in the inventory Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication Command Line: run.bat com.vmware.general.GetHostName --url [webservicesurl] --username [username] --password [password]GetHostName() -
Constructor for class com.vmware.general.GetHostName
 
getHosts() -
Method in interface com.vmware.security.credstore.CredentialStore
Returns all hosts that have entries in the credential store.
getPassword(String, String) -
Method in interface com.vmware.security.credstore.CredentialStore
Gets the password for a given host and username.
GetUpdates - Class in com.vmware.general GetUpdates This sample demonstrates how to use the PropertyCollector to monitor one or more properties of one or more managed objects.GetUpdates() -
Constructor for class com.vmware.general.GetUpdates
 
getUsernames(String) -
Method in interface com.vmware.security.credstore.CredentialStore
Returns all usernames that have passwords stored for a given host.
GetVMFiles - Class in com.vmware.httpfileaccess GetVMFiles This sample gets all the config files, snapshots files, logs files, virtual disk files to the local system.GetVMFiles() -
Constructor for class com.vmware.httpfileaccess.GetVMFiles
 



H

History - Class in com.vmware.performance History This sample reads performance measurements from the current time.History() -
Constructor for class com.vmware.performance.History
 
HostProfileManager - Class in com.vmware.host This sample demonstrates HostProfileManager and ProfileComplainceManager Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication sourcehostname [required] : Name of the host entityname [required] : Attached Entity Name entitytype [required] : Attached Entity Type Command Line: Create hostprofile given profileSourceHost (host system) profileAttachEntity (host system), profileAttachEntityType (host system) Applies config after attaching hostprofile to host system and check for compliance"); run.bat com.vmware.host.HostProfileManager --url [webserviceurl]"); --username [username] --password [password] --sourcehostname [host name] --entityname [host name] --entitytype HostSystem Create hostprofile given profileSourceHost (host system), profileAttachEntity (cluster computer resource), profileAttachEntityType (cluster compute resource) Attaches hostprofile to all hosts in cluster and checks for compliance run.bat com.vmware.host.HostProfileManager --url [webserviceurl] --username [username] --password [password] --sourcehostname [host name] --entityname [Cluster] --entitytype ClusterComputeResourceHostProfileManager() -
Constructor for class com.vmware.host.HostProfileManager
 



L

LicenseManager - Class in com.vmware.general LicenseManager Demonstrates uses of the Licensing API using License Manager Reference.LicenseManager() -
Constructor for class com.vmware.general.LicenseManager
 
LineChart - Class in com.vmware.performance.widgetsDraws a nice pretty chart given a set of data.LineChart(int, long, String, String, int, boolean) -
Constructor for class com.vmware.performance.widgets.LineChart
 



M

main(String[]) -
Static method in class com.vmware.alarms.VMPowerStateAlarm
 
main(String[]) -
Static method in class com.vmware.events.EventFormat
 
main(String[]) -
Static method in class com.vmware.events.EventHistoryCollectorMonitor
 
main(String[]) -
Static method in class com.vmware.events.VMEventHistoryCollectorMonitor
 
main(String[]) -
Static method in class com.vmware.general.Browser
 
main(String[]) -
Static method in class com.vmware.general.Connect
 
main(String[]) -
Static method in class com.vmware.general.Create
 
main(String[]) -
Static method in class com.vmware.general.Delete
 
main(String[]) -
Static method in class com.vmware.general.GetCurrentTime
 
main(String[]) -
Static method in class com.vmware.general.GetHostName
 
main(String[]) -
Static method in class com.vmware.general.GetUpdates
 
main(String[]) -
Static method in class com.vmware.general.LicenseManager
 
main(String[]) -
Static method in class com.vmware.general.Move
 
main(String[]) -
Static method in class com.vmware.general.PropertyCollector
 
main(String[]) -
Static method in class com.vmware.general.RemoveManagedObject
 
main(String[]) -
Static method in class com.vmware.general.Rename
 
main(String[]) -
Static method in class com.vmware.general.SearchIndex
 
main(String[]) -
Static method in class com.vmware.general.SimpleClient
 
main(String[]) -
Static method in class com.vmware.general.TaskList
 
main(String[]) -
Static method in class com.vmware.guest.CreateTemporaryFile
 
main(String[]) -
Static method in class com.vmware.guest.DownloadGuestFile
 
main(String[]) -
Static method in class com.vmware.guest.RunProgram
 
main(String[]) -
Static method in class com.vmware.guest.UploadGuestFile
 
main(String[]) -
Static method in class com.vmware.host.AcquireSessionInfo
 
main(String[]) -
Static method in class com.vmware.host.AddVirtualNic
 
main(String[]) -
Static method in class com.vmware.host.AddVirtualSwitch
 
main(String[]) -
Static method in class com.vmware.host.AddVirtualSwitchPortGroup
 
main(String[]) -
Static method in class com.vmware.host.DVSCreate
 
main(String[]) -
Static method in class com.vmware.host.HostProfileManager
 
main(String[]) -
Static method in class com.vmware.host.NIOCForDVS
 
main(String[]) -
Static method in class com.vmware.host.RemoveVirtualNic
 
main(String[]) -
Static method in class com.vmware.host.RemoveVirtualSwitch
 
main(String[]) -
Static method in class com.vmware.host.RemoveVirtualSwitchPortGroup
 
main(String[]) -
Static method in class com.vmware.httpfileaccess.ColdMigration
 
main(String[]) -
Static method in class com.vmware.httpfileaccess.GetVMFiles
 
main(String[]) -
Static method in class com.vmware.performance.Basics
 
main(String[]) -
Static method in class com.vmware.performance.History
 
main(String[]) -
Static method in class com.vmware.performance.PrintCounters
 
main(String[]) -
Static method in class com.vmware.performance.RealTime
 
main(String[]) -
Static method in class com.vmware.performance.VITop
 
main(String[]) -
Static method in class com.vmware.performance.VIUsage
 
main(String[]) -
Static method in class com.vmware.scheduling.DeleteOneTimeScheduledTask
 
main(String[]) -
Static method in class com.vmware.scheduling.OneTimeScheduledTask
 
main(String[]) -
Static method in class com.vmware.scheduling.WeeklyRecurrenceScheduledTask
 
main(String[]) -
Static method in class com.vmware.scsilun.SCSILunName
 
main(String[]) -
Static method in class com.vmware.security.credstore.CredentialStoreAdmin
 
main(String[]) -
Static method in class com.vmware.simpleagent.CreateUser
 
main(String[]) -
Static method in class com.vmware.simpleagent.SimpleAgent
 
main(String[]) -
Static method in class com.vmware.storage.CreateStorageDRS
 
main(String[]) -
Static method in class com.vmware.storage.SDRSRecommendation
 
main(String[]) -
Static method in class com.vmware.storage.SDRSRules
 
main(String[]) -
Static method in class com.vmware.vapp.OVFManagerExportVAPP
 
main(String[]) -
Static method in class com.vmware.vapp.OVFManagerExportVMDK
 
main(String[]) -
Static method in class com.vmware.vapp.OVFManagerImportLocalVApp
 
main(String[]) -
Static method in class com.vmware.vapp.OVFManagerImportVAppFromUrl
 
main(String[]) -
Static method in class com.vmware.vm.VMClone
 
main(String[]) -
Static method in class com.vmware.vm.VMCreate
 
main(String[]) -
Static method in class com.vmware.vm.VMDeltaDisk
 
main(String[]) -
Static method in class com.vmware.vm.VMDiskCreate
 
main(String[]) -
Static method in class com.vmware.vm.VMLinkedClone
 
main(String[]) -
Static method in class com.vmware.vm.VMManageCD
 
main(String[]) -
Static method in class com.vmware.vm.VMManageFloppy
 
main(String[]) -
Static method in class com.vmware.vm.VMotion
 
main(String[]) -
Static method in class com.vmware.vm.VMPowerOps
 
main(String[]) -
Static method in class com.vmware.vm.VMPromoteDisks
 
main(String[]) -
Static method in class com.vmware.vm.VMReconfig
 
main(String[]) -
Static method in class com.vmware.vm.VMRelocate
 
main(String[]) -
Static method in class com.vmware.vm.VMSnapshot
 
mouseClicked(MouseEvent) -
Method in class com.vmware.performance.widgets.LineChart
Called when the mouse is clicked ont the component.
mouseDragged(MouseEvent) -
Method in class com.vmware.performance.widgets.LineChart
Called when the mouse is dragged over the component.
mouseEntered(MouseEvent) -
Method in class com.vmware.performance.widgets.LineChart
Called when the mouse is enters the component.
mouseExited(MouseEvent) -
Method in class com.vmware.performance.widgets.LineChart
Called when the mouse is exits the component.
mouseMoved(MouseEvent) -
Method in class com.vmware.performance.widgets.LineChart
Called when the mouse is moved over the component.
mousePressed(MouseEvent) -
Method in class com.vmware.performance.widgets.LineChart
Called when the mouse is pressed ont the component.
mouseReleased(MouseEvent) -
Method in class com.vmware.performance.widgets.LineChart
Called when the mouse is released ont the component.
Move - Class in com.vmware.general Move This sample moves a managed entity from its current location in the inventory to a new location, in a specified folder.Move() -
Constructor for class com.vmware.general.Move
 



N

NIOCForDVS - Class in com.vmware.host This sample demonstrates how to add/modify NetworkResourcePool to Distributed Virtual Switch: Parameters: url [required]: url of the web service.NIOCForDVS() -
Constructor for class com.vmware.host.NIOCForDVS
 



O

OneTimeScheduledTask - Class in com.vmware.scheduling OneTimeScheduledTask This sample demonstrates creation of ScheduledTask using the ScheduledTaskManager Parameters: url [required] : url of the web service.OneTimeScheduledTask() -
Constructor for class com.vmware.scheduling.OneTimeScheduledTask
 
OVFManagerExportVAPP - Class in com.vmware.vapp OVFManagerExportVAPP This sample demonstrates OVFManager.OVFManagerExportVAPP() -
Constructor for class com.vmware.vapp.OVFManagerExportVAPP
 
OVFManagerExportVMDK - Class in com.vmware.vapp OVFManagerExportVMDK This is a demonstrates OVFManager.Exports VMDK's of a VM to the localSystem.OVFManagerExportVMDK() -
Constructor for class com.vmware.vapp.OVFManagerExportVMDK
 
OVFManagerExportVMDK.HttpNfcLeaseExtender - Class in com.vmware.vappThe Class HttpNfcLeaseExtender.OVFManagerExportVMDK.HttpNfcLeaseExtender(ManagedObjectReference, VimPortType) -
Constructor for class com.vmware.vapp.OVFManagerExportVMDK.HttpNfcLeaseExtender
 
OVFManagerImportLocalVApp - Class in com.vmware.vapp OVFManagerImportLocalVApp This class can be used import or deploy an OVF Appliance from the Local drive.OVFManagerImportLocalVApp() -
Constructor for class com.vmware.vapp.OVFManagerImportLocalVApp
 
OVFManagerImportVAppFromUrl - Class in com.vmware.vapp This class can be used import or deploy an OVF Appliance from the specified URL.OVFManagerImportVAppFromUrl() -
Constructor for class com.vmware.vapp.OVFManagerImportVAppFromUrl
 



P

paintComponent(Graphics) -
Method in class com.vmware.performance.widgets.LineChart
Paints the component.
PrintCounters - Class in com.vmware.performance PrintCounters This sample writes available VM, Hostsystem or ResourcePool perf counters into the file specified Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication entitytype [required] : Managed entity [HostSystem|VirtualMachine|ResourcePool] entityname [required] : name of the managed entity filename [required] : Full path of filename to write to Command Line: Save counters available for a host run.bat com.vmware.performance.PrintCounters --url https://myHost.com/sdk --username [user] --password [password] --entitytype HostSystem --entityname myHost.com --filename myHostCountersPrintCounters() -
Constructor for class com.vmware.performance.PrintCounters
 
PropertyCollector - Class in com.vmware.general PropertyCollector This sample illustrates the property collector features added in version 4.1 Parameters: url [required] : url of the web service."); username [required] : username for the authentication"); password [required] : password for the authentication"); extension [required] : Extension to be demonstrated [retrieveproperties | updates | filterspec | propertycollector] vmname [optional] : Name of the virtual machine maxobjects [optional] : The maximum number of ObjectContent data objects that should be returned in a single result updatetype [optional] : waitforupdates | checkforupdates| extension nooftasks [optional] : Number of tasks to be created Command Line: Retrieve Properties Extension run.bat com.vmware.general.PropertyCollector --url [webserviceurl] --username [username] --password [password] --extension retrieveproperties --maxobjects [maxobjects] Updates Extension run.bat com.vmware.general.PropertyCollector --url [webserviceurl] --username [username] --password [password] --extension updates --vmname [vm name] --updatetype [waitforupdates | checkforupdates| extension] Filter Spec Extension run.bat com.vmware.general.PropertyCollector --url [webserviceurl] --username [username] --password [password] --extension filterspec --vmname [vm name] --noofTasks [Number of tasks to be created] Property Collector Extension run.bat com.vmware.general.PropertyCollector --url [webserviceurl] --username [username] --password [password] --extension propertycollectorPropertyCollector() -
Constructor for class com.vmware.general.PropertyCollector
 



R

RealTime - Class in com.vmware.performance RealTime This sample displays performance measurements from the current time at the console Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication vmname [required] : name of the vm Command Line: run.bat com.vmware.performance.RealTime --url [webservice url] --username [user] --password [password] --vmname [name of the vm]RealTime() -
Constructor for class com.vmware.performance.RealTime
 
RemoveManagedObject - Class in com.vmware.general This sample demonstrates Destroy or Unregister Managed Inventory Object like a Host, VM, Folder, etc Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication objtype [required] : type of managedobject to remove or unregister"); e.g.RemoveManagedObject() -
Constructor for class com.vmware.general.RemoveManagedObject
 
removePassword(String, String) -
Method in interface com.vmware.security.credstore.CredentialStore
Removes the password for a given host and username.
RemoveVirtualNic - Class in com.vmware.host RemoveVirtualNic This sample removes a Virtual Nic from a PortGroup on a vSwitch Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication portgroupname [required] : Name of port group to remove Virtual Nic from hostname [required] : Name of host datacentername [optional] : Name of datacenter Command Line: Remove a VirtualNic from a PortGroup run.bat com.vmware.host.RemoveVirtualNic --url [webserviceurl] --username [username] --password [password] --datacentername [mydatacenter] --portgroupname [myportgroup] --hostname [hostname] Remove a VirtualNic from a PortGroup without hostname run.bat com.vmware.host.RemoveVirtualNic --url [webserviceurl] --username [username] --password [password] --datacentername [mydatacenter] --portgroupname [myportgroup] Remove a VirtualNic from a PortGroup without datacentername run.bat com.vmware.host.RemoveVirtualNic --url [webserviceurl] --username [username] --password [password] --portgroupname [myportgroup] --hostname [name of the host]RemoveVirtualNic() -
Constructor for class com.vmware.host.RemoveVirtualNic
 
RemoveVirtualSwitch - Class in com.vmware.host RemoveVirtualSwitch This sample removes a virtual switch Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication vswitchid [required] : Name of the switch to be added hostname [required] : Name of the host Command Line: Remove a Virtual Switch run.bat com.vmware.host.RemoveVirtualSwitch --url [webserviceurl] --username [username] --password [password] --vswitchid [mySwitch] --hostname [hostname]RemoveVirtualSwitch() -
Constructor for class com.vmware.host.RemoveVirtualSwitch
 
RemoveVirtualSwitchPortGroup - Class in com.vmware.host RemoveVirtualSwitchPortGroup This sample removes a Virtual Switch PortGroup Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication portgroupname [required] : Name of the port group to be removed hostname [required] : Name of the host Command Line: Remove Virtual Switch Port Group run.bat com.vmware.host.RemoveVirtualSwitchPortGroup --url [webserviceurl] --username [username] --password [password] --portgroupname[myportgroup] --hostname [hostname]RemoveVirtualSwitchPortGroup() -
Constructor for class com.vmware.host.RemoveVirtualSwitchPortGroup
 
Rename - Class in com.vmware.general Rename This sample demonstrates renaming a manged entity Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication entityname [required] : name of the inventory object - a managed entity newname [required] : new name of the inventory object - a managed entity Command Line: Rename a virtual machine VM to new name VM2 run.bat com.vmware.general --url [webserviceurl] --username [username] --password [password] --entityname VM --newname VM2 Rename a resource pool named Rp to new name pool java com.vmware.general --url [webserviceurl] --username [username] --password [password] --entityname Rp --newname poolRename() -
Constructor for class com.vmware.general.Rename
 
run() -
Method in class com.vmware.vapp.OVFManagerExportVMDK.HttpNfcLeaseExtender
 
RunProgram - Class in com.vmware.guest RunProgram This sample runs a specified program inside a virtual machine with output re-directed to a temporary file inside the guest and downloads the output file.RunProgram() -
Constructor for class com.vmware.guest.RunProgram
 



S

SCSILunName - Class in com.vmware.scsilun SCSILunName This sample displays the CanonicalName,Vendor,Model,Data,Namespace and NamespaceId of the host SCSI LUN name Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication hostname [required] : host for which SCSI details will be displayed Command Line: run.bat com.vmware.scsilun.SCSILunName --url [webserviceurl] --username [username] --password [password] --hostname [host name]SCSILunName() -
Constructor for class com.vmware.scsilun.SCSILunName
 
SDRSRecommendation - Class in com.vmware.storage This sample demonstrates how to Run the Storage DRS on a given SDRS cluster and show the list of recommendations generated by SDRS.SDRSRecommendation() -
Constructor for class com.vmware.storage.SDRSRecommendation
 
SDRSRules - Class in com.vmware.storage This sample demonstrates how to Add/List/Modify/Delete the rules for an existing SDRS cluster.SDRSRules() -
Constructor for class com.vmware.storage.SDRSRules
 
SearchIndex - Class in com.vmware.general SearchIndex This sample demonstrates the SearchIndex API Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication dcname [required] : name of the datacenter vmdnsname [optional] : Dns of a virtual machine hostdnsname [optional] : Dns of the ESX host vmpath [optional] : Inventory path of a virtual machine vmip [optional] : IP Address of a virtual machine Command Line: Run the search index with dcName myDatacenter run.bat com.vmware.general.SearchIndex --url [webserviceurl] --username [username] --password [password] --dcName myDatacenter Run the search index with dcName myDatacenter and vmpath to virtual machine named Test run.bat com.vmware.general.SearchIndex --url [webserviceurl] --username [username] --password [password] --dcName myDatacenter --vmpath //DatacenterName//vm//Test Run the search index with dcName myDatacenter and hostdns 'abc.bcd.com' run.bat com.vmware.general.SearchIndex --url [webserviceurl] --username [username] --password [password] --dcName myDatacenter --hostDns abc.bcd.com Run the search index with dcName myDatacenter and ip of the vm as 111.123.155.21 run.bat com.vmware.general.SearchIndex --url [webserviceurl] --username [username] --password [password] --dcName myDatacenter --vmIP 111.123.155.21SearchIndex() -
Constructor for class com.vmware.general.SearchIndex
 
setAntialias(boolean) -
Method in class com.vmware.performance.widgets.LineChart
Sets the antialias flag to control whether or not antialiasing will be used when rendering the component.
setData(Calendar, long, String, List<Object[]>) -
Method in class com.vmware.performance.widgets.StatsTable
Sets the data.
setValues(int[], long) -
Method in class com.vmware.performance.widgets.LineChart
Sets the data samples to be displayed by the line chart.
SimpleAgent - Class in com.vmware.simpleagent SimpleAgent The SimpleAgent class uses the local credential store to obtain user account and password information, for automated logon to the target host system.SimpleAgent() -
Constructor for class com.vmware.simpleagent.SimpleAgent
 
SimpleClient - Class in com.vmware.general SimpleClient This sample lists the inventory contents (managed entities) Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication Command Line: run.bat com.vmware.general.SimpleClient --url [webserviceurl] --username [username] --password [password]SimpleClient() -
Constructor for class com.vmware.general.SimpleClient
 
StatsTable - Class in com.vmware.performance.widgetsThe Class StatsTable.StatsTable(String[]) -
Constructor for class com.vmware.performance.widgets.StatsTable
Instantiates a new stats table.



T

TaskList - Class in com.vmware.general TaskList This sample prints out a list of tasks if any are running The sample display the tasks in the following format: Operation: Name: Type: State: Error: Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication Command Line: run.bat com.vmware.general.TaskList --url [webserviceurl] --username [username] --password [password]TaskList() -
Constructor for class com.vmware.general.TaskList
 



U

UploadGuestFile - Class in com.vmware.guest UploadGuestFile This sample uploads a file from the client machine to a specified location inside the guest.UploadGuestFile() -
Constructor for class com.vmware.guest.UploadGuestFile
 



V

VITop - Class in com.vmware.performance VITop This sample is an ESX-Top-like application that lets administrators specify the CPU and memory counters by name to obtain metrics for a specified host Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication host [required] : name of the host cpu [required] : CPU counter name e.g.VITop() -
Constructor for class com.vmware.performance.VITop
 
VIUsage - Class in com.vmware.performance VIUsage This sample creates a GUI for graphical representation of the counters Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication host [required] : Name of the host counter [required] : Full counter name in dotted notation (group.counter.rollup) e.g.VIUsage() -
Constructor for class com.vmware.performance.VIUsage
 
VMClone - Class in com.vmware.vm VMClone This sample makes a template of an existing VM and deploy multiple instances of this template onto a datacenter Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication datacentername [required] : name of Datacenter vmpath [required] : inventory path of the VM clonename [required] : name of the clone Command Line: java com.vmware.vm.VMClone --url [webserviceurl] --username [username] --password [password] --datacentername [DatacenterName]" --vmpath [vmPath] --clonename [CloneName]VMClone() -
Constructor for class com.vmware.vm.VMClone
 
VMCreate - Class in com.vmware.vm VMCreate This sample creates a VM Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication vmname [required] : Name of the virtual machine datacentername [required] : Name of the datacenter hostname [required] : Name of the host guestosid [optional] : Type of Guest OS cpucount [optional] : Total cpu count disksize [optional] : Size of the Disk memorysize [optional] : Size of the Memory in 1024MB blocks datastorename [optional] : Name of dataStore Command Line: Create a VM given datacenter and host names run.bat com.vmware.vm.VMCreate --url [webserviceurl] --username [username] --password [password] --vmname [vmname] --datacentername [DataCenterName] --hostname [hostname] Create a VM given its name, Datacenter name and GuestOsId run.bat com.vmware.vm.VMCreate --url [webserviceurl] --username [username] --password [password] --vmname [vmname] --datacentername [DataCenterName] --guestosid [GuestOsId] Create a VM given its name, Datacenter name and its cpucount run.bat com.vmware.vm.VMCreate --url [webserviceurl] --username [username] --password [password] --vmname [vmname] --datacentername [DataCenterName] --cpucount [cpucount]VMCreate() -
Constructor for class com.vmware.vm.VMCreate
 
VMDeltaDisk - Class in com.vmware.vm VMDeltaDisk This sample creates a delta disk on top of an existing virtual disk in a VM, and simultaneously removes the original disk using the reconfigure API.VMDeltaDisk() -
Constructor for class com.vmware.vm.VMDeltaDisk
 
VMDiskCreate - Class in com.vmware.vm VMDiskCreate This sample demonstrates how to create a virtual disk Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication vmname [required] : Name of the virtual machine datastorename [optional] : name of the DataStore disksize [required] : Size of the virtual disk in MB disktype [optional] : Virtual Disk Type [thin | preallocated | eagerzeroed | rdm | rdmp] persistence [optional] : Persistence mode of the virtual disk [persistent | independent_persistent | independent_nonpersistent] devicename [optional] : Canonical name of the LUN to use for disk types Command Line: VMDiskCreate --url [webserviceurl] --username [username] --password [password] --vmname [vmname] --disksize [8] --disktype [thin | preallocated | eagerzeroed | rdm | rdmp] --persistence [persistent | independent_persistent | independent_nonpersistent] --devicename vmhba0:0:0:0VMDiskCreate() -
Constructor for class com.vmware.vm.VMDiskCreate
 
VMEventHistoryCollectorMonitor - Class in com.vmware.events VMEventHistoryCollectorMonitor This sample is responsible for creating EventHistoryCollector filtered for a single VM and monitoring Events using the latestPage attribute of the EventHistoryCollector.VMEventHistoryCollectorMonitor() -
Constructor for class com.vmware.events.VMEventHistoryCollectorMonitor
 
VMLinkedClone - Class in com.vmware.vm VMLinkedClone This sample creates a linked clone from an existing snapshot Each independent disk needs a DiskLocator with diskmovetype as moveAllDiskBackingsAndDisallowSharing Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication vmname [required] : Name of the virtual machine snapshotname [required] : Name of the snaphot clonename [required] : Name of the cloneName Command Line: Create a linked clone run.bat com.vmware.vm.VMLinkedClone --url [webserviceurl] --username [username] --password [password] --vmname [myVM] --snapshotname [snapshot name] --clonename [clone name]VMLinkedClone() -
Constructor for class com.vmware.vm.VMLinkedClone
 
VMManageCD - Class in com.vmware.vm VMManageCD This sample adds / removes CDROM to / from an existing VM This sample lists information about a VMs CDROMs This sample updates an existing CDROM a VM Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication vmname [required] : name of the virtual machine operation [required] : operation type - [get|add|remove|set] isopath [optional] : full datastore path to the iso file remote [optional] : Specify the device is a remote or client device or iso startconnected [optional] : virtual CD starts connected when VM powers on connect [optional] : virtual CD is connected after creation or update Set only if VM is powered on label [optional] : used to find the device.key value devicename [optional] : Specify the path to the CD on the VM's host Command Line: Get CD-Rom Info"); run.bat com.vmware.vm.VMManageCD --url [webserviceurl] --username [username] --password [password] --operation get --vmname [Virtual Machine Name] Add CD-Rom run.bat com.vmware.vm.VMManageCD --url --username [username] --password [password] --operation add --vmname [Virtual Machine Name] --isoPath "[datastore1] test.iso" --remote false --connect true Remove CD-Rom run.bat com.vmware.vm.VMManageCD --url [webserviceurl] --username [username] --password [password] --operation remove --vmname [Virtual Machine Name] --label CD\\DVD Drive 1 Reconfigure CD-Rom run.bat com.vmware.vm.VMManageCD --url [webserviceurl] --username [username] --password [password] --operation set --vmname [Virtual Machine Name] --label CD\\DVD Drive 1 --connect falseVMManageCD() -
Constructor for class com.vmware.vm.VMManageCD
 
VMManageFloppy - Class in com.vmware.vm VMManageFloppy This sample adds / removes floppy to / from an existing VM This sample lists information about a VMs Floppies This sample updates an existing floppy drive on a VM Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication vmname [required] : name of the virtual machine operation [required] : operation type - [get|add|remove|set] imgpath [optional] : path of image file remote [optional] : device is a remote or client device or iso startconnected [optional] : virtual floppy starts connected on VM poweron connect [optional] : virtual floppy is connected Set only if the VM is powered on label [optional] : used to find the device.key value device [optional] : path to the floppy on the VM's host Command Line: Get Floppy Info"); run.bat com.vmware.vm.VMManageFloppy --url [webserviceurl] --username [username] --password [password] --operation get --vmname [Virtual Machine Name] Add Floppy run.bat com.vmware.vm.VMManageFloppy --url [webserviceurl] --username [username] --password [password] --operation add --vmname [Virtual Machine Name] --imgpath test.flp --remote false --connect true Remove Floppy run.bat com.vmware.vm.VMManageFloppy --url [webserviceurl] --username [username] --password [password] --operation remove --vmname [Virtual Machine Name] --label Floppy Drive 1 Reconfigure Floppy run.bat com.vmware.vm.VMManageFloppy --url [webserviceurl] --username [username] --password [password] --operation set --vmname [Virtual Machine Name] --label Floppy Drive 1 --connect falseVMManageFloppy() -
Constructor for class com.vmware.vm.VMManageFloppy
 
VMotion - Class in com.vmware.vm VMotion Used to validate if VMotion is feasible between two hosts or not, It is also used to perform migrate/relocate task depending on the data given Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication vmname [required] : name of the virtual machine targethost [required] : Name of the target host sourcehost [required] : Name of the host containing the virtual machine targetpool [required] : Name of the target resource pool targetdatastore [required] : Name of the target datastore priority [required] : The priority of the migration task:- defaultPriority, highPriority,lowPriority state [optional] Command Line: run.bat com.vmware.vm.VMotion --url [URLString] --username [User] --password [Password] --vmname [VMName] --targethost [Target host] --sourcehost [Source host] --targetpool [Target resource pool] --targetdatastore [Target datastore] --priority [Migration task priority] --stateVMotion() -
Constructor for class com.vmware.vm.VMotion
 
VMPowerOps - Class in com.vmware.vm VMPowerOps Demonstrates VirtualMachine Power operations Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication operation [required] : type of the operation [poweron | poweroff | reset | suspend | reboot | shutdown | standby] datacentername [optional] : name of the datacenter guestid [optional] : guest id of the vm hostname [optional] : name of the host vmname [optional] : name of the virtual machine Command Line: run.bat com.vmware.vm.VMPowerOps --url [URLString] --username [User] --password [Password] --operation [Operation] --datacenter [DatacenterName]--guestid [GuestId] --hostname [HostName] --vmname [VMName]VMPowerOps() -
Constructor for class com.vmware.vm.VMPowerOps
 
VMPowerStateAlarm - Class in com.vmware.alarms VMPowerStateAlarm This sample which creates an Alarm to monitor the virtual machine's power state Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication vmname [required] : Name of the virtual machine alarm [required] : Name of the alarms Command Line: Create an alarm AlarmABC on a virtual machine run.bat com.vmware.vm.VMPowerStateAlarm --url [webserviceurl] --username [username] --password [password] --vmname [vmname] --alarm [alarm]VMPowerStateAlarm() -
Constructor for class com.vmware.alarms.VMPowerStateAlarm
 
VMPromoteDisks - Class in com.vmware.vm VMPromoteDisks Used to consolidate a linked clone by using promote API.VMPromoteDisks() -
Constructor for class com.vmware.vm.VMPromoteDisks
 
VMReconfig - Class in com.vmware.vm VMReconfig Reconfigures a virtual machine, which include reconfiguring the disk size, disk mode, etc.VMReconfig() -
Constructor for class com.vmware.vm.VMReconfig
 
VMRelocate - Class in com.vmware.vm VMRelocate Used to relocate a linked clone using disk move type Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication vmname [required] : name of the virtual machine diskmovetype [required] : Either of [moveChildMostDiskBacking | moveAllDiskBackingsAndAllowSharing] datastorename [required] : Name of the datastore Command Line: run.bat com.vmware.vm.VMRelocate --url [URLString] --username [User] --password [Password] --vmname [VMName] --diskmovetype [DiskMoveType] --datastorename [Datastore]VMRelocate() -
Constructor for class com.vmware.vm.VMRelocate
 
VMSnapshot - Class in com.vmware.vm VMSnapshot This sample demonstrates VM snapshot operations Parameters: url [required] : url of the web service.VMSnapshot() -
Constructor for class com.vmware.vm.VMSnapshot
 



W

WeeklyRecurrenceScheduledTask - Class in com.vmware.scheduling WeeklyRecurrenceScheduledTask This sample demonstrates creation of weekly recurring ScheduledTask using the ScheduledTaskManager Parameters: url [required] : url of the web service username [required] : username for the authentication password [required] : password for the authentication vmname [required] : virtual machine to be powered off taskname [required] : Name of the task to be created Command Line: run.bat com.vmware.scheduling.WeeklyRecurrenceScheduledTask --url [webserviceurl] --username [username] --password [password] --vmname [VM name] --taskname [TaskToBeCreated]WeeklyRecurrenceScheduledTask() -
Constructor for class com.vmware.scheduling.WeeklyRecurrenceScheduledTask
 


A B C D E G H L M N O P R S T U V W










Overview 
Package 
Class 
Tree 
Deprecated 
 Index 










 PREV 
 NEXT

FRAMES  
 NO FRAMES  
 



All Classes