How many actions are included in vCenter Orchestrator ?
There are a considerable number of pre-built actions that may be used to build your own workflows. The environment this table is taken from has the VC, VIM3, and Microsoft vmoapps installed:
| Module: com.vmware.basic | ||
| com.vmware.basic | createDirectory | |
| Description: | Create a directory structure on the VS-O server. | |
| com.vmware.basic | getFileName | |
| Description: | Strip directory from filenames. | |
| Module: com.vmware.constants | ||
| com.vmware.constants | getDefaultCompanyName | |
| Description: | Returns the company name. | |
| com.vmware.constants | getDefaultSSHKeyPairPath | |
| Description: | Path on the VCO server where the Key Pair for SSH is stored. | |
| Module: com.vmware.library.action | ||
| com.vmware.library.action | getAllActions | |
| Description: | Return all the actions | |
| Module: com.vmware.library.authorization | ||
| com.vmware.library.authorization | addObjectToAuthorizationForGroup | |
| Description: | Add an object/relation to an authorization. If the authoriation does not exist, the action create it. | |
| com.vmware.library.authorization | addObjectToAuthorizationForUser | |
| Description: | Add an object/relation to an authorization. If the authoriation does not exist, the action create it. | |
| com.vmware.library.authorization | changeGroupAuthorization | |
| Description: | null | |
| com.vmware.library.authorization | changeUserAuthorization | |
| Description: | null | |
| com.vmware.library.authorization | getOrCreateAuthorizationForGroup | |
| Description: | null | |
| com.vmware.library.authorization | getOrCreateAuthorizationForUser | |
| Description: | null | |
| com.vmware.library.authorization | removeAuthorizationRelationToObjectForGroup | |
| Description: | null | |
| com.vmware.library.authorization | removeAuthorizationRelationToObjectForUser | |
| Description: | null | |
| Module: com.vmware.library.configurations | ||
| com.vmware.library.configurations | addObjectInConfigurationElement | |
| Description: | Add any object into a configuration element of type "array of objects". Returns true if object is successfully added. Returns false if object already exists in the array. | |
| com.vmware.library.configurations | addResourceElementInConfigurationElement | |
| Description: | Add a resource element into a configuration element of type "array of resource elements" The resource is added only if it is not already placed into the array. Returns true if the resource is successfully added, otherwise returns false. | |
| com.vmware.library.configurations | getConfigurationAttributeDescriptionList | |
| Description: | Returns the list of Configuration Attribute Description as an Array of Strings | |
| com.vmware.library.configurations | getObjectFromConfigurationElementWithKey | |
| Description: | null | |
| com.vmware.library.configurations | removeObjectInConfigurationElement | |
| Description: | Remove an object from configuration element of type "array of objects" Returns true if object is successfully removed, otherwise returns false. | |
| com.vmware.library.configurations | removeResourceElementInConfigurationElement | |
| Description: | Remove a resource element within a configuration element of type "array of resource elements" Returns true if the resource is successfully removed, otherwise returns false. | |
| Module: com.vmware.library.customProperties | ||
| com.vmware.library.customProperties | getCustomProperty | |
| Description: | Get a custom property from an object | |
| com.vmware.library.customProperties | isPluginType | |
| Description: | Check if the object type is a plugin type Returns true if object type is a plugin type | |
| com.vmware.library.customProperties | setCustomProperty | |
| Description: | Set a custom property on an object | |
| Module: com.vmware.library.email | ||
| com.vmware.library.email | sendHtmlEmail | |
| Description: | null | |
| Module: com.vmware.library.ldap | ||
| com.vmware.library.ldap | getCurrentLdapUser | |
| Description: | Return the current LDAP User | |
| Module: com.vmware.library.microsoft.activeDirectory | ||
| com.vmware.library.microsoft.activeDirectory | createComputer | |
| Description: | Create a computer in the Active Directory | |
| com.vmware.library.microsoft.activeDirectory | createOrganizationalUnit | |
| Description: | Create an OU in an existing OU | |
| com.vmware.library.microsoft.activeDirectory | createUser | |
| Description: | Create a user | |
| com.vmware.library.microsoft.activeDirectory | createUserGroup | |
| Description: | Create a new Usergroup in the given container (OU or Group) | |
| com.vmware.library.microsoft.activeDirectory | destroyElement | |
| Description: | Detroy an element of the Active Directory. | |
| com.vmware.library.microsoft.activeDirectory | getComputerFromContainer | |
| Description: | Get a computer by his name in the given OU or Group (container) | |
| com.vmware.library.microsoft.activeDirectory | getOrganizationUnitFromOrganizationUnit | |
| Description: | Get a computer by his name in the given OU or Group (container) | |
| com.vmware.library.microsoft.activeDirectory | getUserFromContainer | |
| Description: | Get a user by his name in the given OU or Group (container) | |
| com.vmware.library.microsoft.activeDirectory | getUsergroupFromContainer | |
| Description: | Get a usergroup by his name in the given OU or Group (container) | |
| com.vmware.library.microsoft.activeDirectory | setComputerEnable | |
| Description: | Allow to enable or disable a computer in the Active Directory | |
| com.vmware.library.microsoft.activeDirectory | setUserEnable | |
| Description: | Allow to enable or disable a computer in the Active Directory | |
| Module: com.vmware.library.microsoft.wmi | ||
| com.vmware.library.microsoft.wmi | executeWmiCommand | |
| Description: | Execute a WMI Method on a given WMI Class or WMI instance | |
| com.vmware.library.microsoft.wmi | getComputerWmiFromComputerAD | |
| Description: | Return a WMI Computer from an AD Computer | |
| Module: com.vmware.library.networking | ||
| com.vmware.library.networking | createNetworkDomain | |
| Description: | null | |
| com.vmware.library.networking | deleteNetworkDomain | |
| Description: | null | |
| com.vmware.library.networking | editNetworkDomain | |
| Description: | Edit a network domain | |
| com.vmware.library.networking | freeIpAddress | |
| Description: | DEPRECATED | |
| com.vmware.library.networking | getAllNetworkDomains | |
| Description: | null | |
| com.vmware.library.networking | getNetworkDomain | |
| Description: | null | |
| com.vmware.library.networking | getOrCreateNetworkDomain | |
| Description: | Deprecated | |
| com.vmware.library.networking | validateNetmaskField | |
| Description: | Validates a text field - ensures that the text field represents a valid netmask. | |
| Module: com.vmware.library.networking.ip | ||
| com.vmware.library.networking.ip | createIpAddressForRange | |
| Description: | null | |
| com.vmware.library.networking.ip | createIpAddressForSubnet | |
| Description: | null | |
| com.vmware.library.networking.ip | createRange | |
| Description: | null | |
| com.vmware.library.networking.ip | createSubnet | |
| Description: | null | |
| com.vmware.library.networking.ip | deleteIpAddress | |
| Description: | null | |
| com.vmware.library.networking.ip | deleteRange | |
| Description: | null | |
| com.vmware.library.networking.ip | deleteSubnet | |
| Description: | null | |
| com.vmware.library.networking.ip | editIpAddressForRange | |
| Description: | null | |
| com.vmware.library.networking.ip | editIpAddressForSubnet | |
| Description: | null | |
| com.vmware.library.networking.ip | freeIpAddress | |
| Description: | null | |
| com.vmware.library.networking.ip | getAllRangesForNetworkDomain | |
| Description: | null | |
| com.vmware.library.networking.ip | getAllSubnetsForNetworkDomain | |
| Description: | null | |
| com.vmware.library.networking.ip | getEndIpAddressFromStartIpAddress | |
| Description: | Helper that returns the appropriate number of byte from and IP adress depending on its class (1 for A class, 2 for B class, 3 for C class). | |
| com.vmware.library.networking.ip | getIpAddress | |
| Description: | null | |
| com.vmware.library.networking.ip | getOrCreateIpAddressForRange | |
| Description: | Deprecated | |
| com.vmware.library.networking.ip | getOrCreateIpAddressForSubnet | |
| Description: | Deprecated | |
| com.vmware.library.networking.ip | getOrCreateRange | |
| Description: | Deprecated | |
| com.vmware.library.networking.ip | getOrCreateSubnet | |
| Description: | Deprecated | |
| com.vmware.library.networking.ip | mustCreateRangeOrSubnet | |
| Description: | Return true if the network domain uses fixed IP addresses and there is no range or subnet linked with this network domain. | |
| com.vmware.library.networking.ip | reserveIpAddress | |
| Description: | null | |
| Module: com.vmware.library.networking.mac | ||
| com.vmware.library.networking.mac | deleteMacAddress | |
| Description: | null | |
| com.vmware.library.networking.mac | deleteMacAddressPool | |
| Description: | null | |
| com.vmware.library.networking.mac | freeMacAddress | |
| Description: | null | |
| com.vmware.library.networking.mac | getOrCreateMacAddress | |
| Description: | null | |
| com.vmware.library.networking.mac | getOrCreateMacAddressPool | |
| Description: | null | |
| com.vmware.library.networking.mac | reserveMacAddress | |
| Description: | null | |
| Module: com.vmware.library.networking.vim3 | ||
| com.vmware.library.networking.vim3 | getNetworkFromNetworkDomain | |
| Description: | Get esx network from a network domain. | |
| com.vmware.library.networking.vim3 | getNetworksFromNetworkDomain | |
| Description: | Get esx networks from a network domain. | |
| Module: com.vmware.library.policy | ||
| com.vmware.library.policy | setPolicyCredential | |
| Description: | Allow to change a user credential running a policy If the credential is not valid, exception is thrown. | |
| com.vmware.library.policy | startPolicy | |
| Description: | Start a policy. If policy is running, do nothing | |
| com.vmware.library.policy | stopPolicy | |
| Description: | Stop a policy. If policy is not running, do nothing | |
| Module: com.vmware.library.refactor | ||
| com.vmware.library.refactor | createXmlResource | |
| Description: | null | |
| com.vmware.library.refactor | createXmlResourceFromBeacon | |
| Description: | null | |
| com.vmware.library.refactor | executeRefactor | |
| Description: | null | |
| com.vmware.library.refactor | importExclusionListFromMapping | |
| Description: | null | |
| com.vmware.library.refactor | importMappingInDefinition | |
| Description: | null | |
| com.vmware.library.refactor | readXmlResource | |
| Description: | Read the given resource element and return it's xml content as a string. resource must be not null and it's mime-type must be 'text/xml'. | |
| Module: com.vmware.library.refactor.presentation | ||
| com.vmware.library.refactor.presentation | getDefaultDestinationPath | |
| Description: | null | |
| com.vmware.library.refactor.presentation | getDefaultDestinationWebviewUrlFolder | |
| Description: | null | |
| Module: com.vmware.library.ssh | ||
| com.vmware.library.ssh | registerVSOonHost | |
| Description: | Upload and register the VS-O public key to the target user@host. This will enable future connections to use public key authentication instead of password authentication for this user. | |
| Module: com.vmware.library.tasks | ||
| com.vmware.library.tasks | createRecurrentTask | |
| Description: | Create a recurrent Task. Return the newly created task Valid values for recurrenceCycle: one-time: run the task only one time. The recurrencePattern is ignored, the start date is mandatory every-minutes: The pattern represents all the seconds on the minutes when the task start every-hours: The pattern represents all the minutes:seconds on the minutes when the task start every-days: The pattern represents all the hours:minutes:seconds on the minutes when the task start every-weeks: The pattern represents all the day hours:minutes:seconds on the minutes when the task start every-months: The pattern represents all the day of the month hours:minutes:seconds on the minutes when the task start recurrencePattern sample: if cycle is one-time : ignored if cycle is every-minutes : "00" or "00, 30" if cycle is every-hours : "00:00" or "18:30:00" if cycle is every-days : "18:30:00, 19:30:00" if cycle is every-weeks : "Mon 00:00:00, Wed 18:00:00" if cycle is every-months: "14 00:00:00, 28 18:00:00" | |
| com.vmware.library.tasks | createTask | |
| Description: | Create a Task. Return the newly created task | |
| Module: com.vmware.library.vc.basic | ||
| com.vmware.library.vc.basic | cloneVM | |
| Description: | Creates a clone of this virtual machine. If the virtual machine is used as a template, this method corresponds to the deploy command. Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients may also escape any other characters in this name parameter. The privilege required on the source virtual machine depends on the source and destination types: - source is virtual machine, destination is virtual machine - VirtualMachine.Provisioning.Clone - source is virtual machine, destination is template - VirtualMachine.Provisioning.CreateTemplateFromVM - source is template, destination is virtual machine - VirtualMachine.Provisioning.DeployTemplate - source is template, destination is template - VirtualMachine.Provisioning.CloneTemplate If customization is requested in the CloneSpec, then the VirtualMachine.Provisioning.Customize privilege must also be held on the source virtual machine. | |
| com.vmware.library.vc.basic | getDatacenterForVimObject | |
| Description: | Return the Datacenter for any Vim object. Return null if not in a datacenter (Datacenter folder) | |
| com.vmware.library.vc.basic | getVimHostForVimObject | |
| Description: | Return the VimHost (Virtual Center) for any Vim object | |
| com.vmware.library.vc.basic | vim3WaitTaskEnd | |
| Description: | Wait for a VC Task to end. When task ended, return the task result if any. | |
| com.vmware.library.vc.basic | waitForCompletionForBatchWorkflow | |
| Description: | Wait that the workflows are terminated | |
| com.vmware.library.vc.basic | WaitTaskEndOrVMQuestion | |
| Description: | Wait for a VC Task to end or for the VM to ask a question. Return the task result or the question asked. | |
| Module: com.vmware.library.vc.cluster | ||
| com.vmware.library.vc.cluster | drsEnabledCluster | |
| Description: | Return true if the specified cluster is DRS enabled. False if not. | |
| com.vmware.library.vc.cluster | getAllClusterComputeResourceForVimHost | |
| Description: | Get all the ClusterComputeResource in a VimHost | |
| com.vmware.library.vc.cluster | getAllComputeResourceForVimHost | |
| Description: | Get all ComputeResource (Non cluster) in a VimHost | |
| com.vmware.library.vc.cluster | getAllHostSystemsOfCluster | |
| Description: | Return all the host system in a cluster | |
| com.vmware.library.vc.cluster | getAllVMsOfCluster | |
| Description: | Get all VMs in a cluster | |
| com.vmware.library.vc.cluster | getAllVMsOfComputeResource | |
| Description: | Return all VMs of a ComputeResource (non cluster) | |
| com.vmware.library.vc.cluster | getComputeResourceOfVm | |
| Description: | Return the ComputeResource or ClusterComputeResource of a VM | |
| com.vmware.library.vc.cluster | getNetworkForCluster | |
| Description: | Actions for presentations Return a list of network for a cluster, computeResource or host | |
| com.vmware.library.vc.cluster | haEnabledCluster | |
| Description: | Return true if the specified cluster is HA enabled. False if not. | |
| Module: com.vmware.library.vc.customattribute | ||
| com.vmware.library.vc.customattribute | getCustomField | |
| Description: | Return the custom field value | |
| com.vmware.library.vc.customattribute | setOrCreateCustomField | |
| Description: | Set a custom attribute for an object. If the custom attribute does not exist, the action create it | |
| Module: com.vmware.library.vc.datacenter | ||
| com.vmware.library.vc.datacenter | getAllVMsOfDatacenter | |
| Description: | Get all VMs in a datacenter | |
| Module: com.vmware.library.vc.datastore | ||
| com.vmware.library.vc.datastore | getAllAvaiblableHostForVM | |
| Description: | [DEPRECATED] Return all hosts "viewing" the VM. | |
| com.vmware.library.vc.datastore | getAllDatastoreOnVimHost | |
| Description: | Return all datastores on an ESX host | |
| com.vmware.library.vc.datastore | getAllDatastores | |
| Description: | Return all the datastores | |
| com.vmware.library.vc.datastore | getAllDatastoresMatchingRegexp | |
| Description: | Return all the datastores matching the given regexp | |
| com.vmware.library.vc.datastore | getAllDatastoresOfVC | |
| Description: | Return all the datastores in a VC | |
| com.vmware.library.vc.datastore | getAllDatastoresOfVCExceptTheOneInParam | |
| Description: | Return all the datastores in a VC (the VC of the datastore entered in parameter) except the datastore entered in parameter | |
| com.vmware.library.vc.datastore | getAllVMsOfDatastore | |
| Description: | Return all VMs of a Datastore | |
| com.vmware.library.vc.datastore | getDatacenterForDatastore | |
| Description: | Get datacenter for a datastore | |
| com.vmware.library.vc.datastore | getDatastoreForHostAndResourcePool | |
| Description: | Return all available Datastore on host and pool (sum of each). If host and pool are null, return the available datastore to relocate the vm (in fact, all datastore in the same Virtual Center) | |
| com.vmware.library.vc.datastore | getDatastoreFreeSize | |
| Description: | Return the Available Size on a Datastore in MB. | |
| com.vmware.library.vc.datastore | getValidDatastoreForConversion | |
| Description: | Return all the datastores valid for the conversion of thick provioned disk to thin provisioned | |
| com.vmware.library.vc.datastore | getValidDatastoreForNetwork | |
| Description: | Get all valid datastores for a network. | |
| com.vmware.library.vc.datastore | getValidNetworkForDatastore | |
| Description: | null | |
| Module: com.vmware.library.vc.datastore.files | ||
| com.vmware.library.vc.datastore.files | deleteFile | |
| Description: | Deletes the specified files from the datastore. If a valid virtual disk file is specified, then all the components of the virtual disk are deleted. | |
| com.vmware.library.vc.datastore.files | getAllConfigFile | |
| Description: | Get all VMX files on a datastore (using API to browse the datastore directly) | |
| com.vmware.library.vc.datastore.files | getAllFloppyImageFile | |
| Description: | Get all Floppy image files (*.flp) on a datastore (using API to browse the datastore directly) | |
| com.vmware.library.vc.datastore.files | getAllTemplateConfigFile | |
| Description: | Get all VMTX files on a datastore (using API to browse the datastore directly) | |
| com.vmware.library.vc.datastore.files | getAllVmdkFile | |
| Description: | Get all VMDK files on a datastore (using API to browse the datastore directly) | |
| Module: com.vmware.library.vc.folder | ||
| com.vmware.library.vc.folder | createFolder | |
| Description: | Create a folder in an existing folder Return the new folder | |
| com.vmware.library.vc.folder | destroyFolder | |
| Description: | Delete an existing folder. Return the deletion task. | |
| com.vmware.library.vc.folder | destroyFolderAndWait | |
| Description: | Delete a folder and wait the task's completion | |
| com.vmware.library.vc.folder | getAllVirtualMachinesByFolder | |
| Description: | Get all VMs in a folder without checking authorization | |
| com.vmware.library.vc.folder | getAllVirtualMachinesByFolderIncludingSubFolders | |
| Description: | Get all VMs for the specified folder and all subfolders. No authorization checking. | |
| com.vmware.library.vc.folder | getRootVmFolder | |
| Description: | Return the root VMfolder. Does not return anything if there are more than one datacenter | |
| com.vmware.library.vc.folder | getVirtualMachineByFolder | |
| Description: | Get all VMs in a folder that are authorized for the current user. | |
| com.vmware.library.vc.folder | renameFolder | |
| Description: | Rename a given folder. Return the rename task | |
| com.vmware.library.vc.folder | renameFolderAndWait | |
| Description: | Rename a given workflow and wait the task's completion | |
| Module: com.vmware.library.vc.host | ||
| com.vmware.library.vc.host | getAllHostSystems | |
| Description: | Return all the host system | |
| com.vmware.library.vc.host | getAllHostSystemsMatchingRegexp | |
| Description: | Return all the host matching the given regexp | |
| com.vmware.library.vc.host | getAllHostSystemsWithFT | |
| Description: | Return all the host system configured with Fault Tolerance | |
| com.vmware.library.vc.host | getAllVMsOfHost | |
| Description: | Return all the virtual machine in a host system | |
| com.vmware.library.vc.host | rescanHostHBAs | |
| Description: | null | |
| Module: com.vmware.library.vc.network | ||
| com.vmware.library.vc.network | getAllVSwitchesMatchingRegexp | |
| Description: | Return all the virtual switch matching the given regexp | |
| com.vmware.library.vc.network | getDatacenterForNetwork | |
| Description: | Return datacenter of a network | |
| com.vmware.library.vc.network | getNetworkForResourcePoolHostVm | |
| Description: | Retrun available network for a resource pool, a host (if cluster is null) or for a vm (if cluster and host are null). Used for the networks list in the clone presentations. If called with a parameter of the wrong type (and not null), this action might return an "undefined" value. | |
| com.vmware.library.vc.network | getNetworksForHostSystem | |
| Description: | null | |
| com.vmware.library.vc.network | getNetworksForLabel | |
| Description: | Returns all networks with name specified by label | |
| com.vmware.library.vc.network | getNetworksForVimHost | |
| Description: | Return all existing networks in a VimHost | |
| Module: com.vmware.library.vc.resourcePool | ||
| com.vmware.library.vc.resourcePool | createResourcePool | |
| Description: | Create a new Rescource Pool with default CPU and momory allocation (disabled). Returns the new ResourcePool, null if any error. | |
| com.vmware.library.vc.resourcePool | createResourcePoolForCluster | |
| Description: | Create a new Rescource Pool with default CPU and momory allocation (disabled). Returns the new ResourcePool, null if any error. | |
| com.vmware.library.vc.resourcePool | destroyResourcePool | |
| Description: | Destroy a resource pool. Return the task created by this action. Wait on the task to end to be sure the resource pool is well renamed | |
| com.vmware.library.vc.resourcePool | destroyResourcePoolAndWait | |
| Description: | Destroy a resource pool and wait on the task. Return true is the resource pool was destroyed, false if not. | |
| com.vmware.library.vc.resourcePool | getAllChildResourcePool | |
| Description: | Return all resource pool of the given resource pool | |
| com.vmware.library.vc.resourcePool | getAllResourcePool | |
| Description: | Return all the Resource Pools on all plugins | |
| com.vmware.library.vc.resourcePool | getAllVMsOfResourcePool | |
| Description: | Get all VMs in a resource pool | |
| com.vmware.library.vc.resourcePool | getValidResourcePoolForDatastore | |
| Description: | Get valid resourcePools for a datastore | |
| com.vmware.library.vc.resourcePool | getValidResourcePoolForNetwork | |
| Description: | Get valid resourcePools for a network | |
| com.vmware.library.vc.resourcePool | renameResourcePool | |
| Description: | Rename a resource pool. Return the task created by this action. Wait on the task to end to be sure the resource pool is well renamed | |
| com.vmware.library.vc.resourcePool | renameResourcePoolAndWait | |
| Description: | Rename a resource pool and wait on the task. return true is the resource pool was renamed, false if not. | |
| Module: com.vmware.library.vc.spec | ||
| com.vmware.library.vc.spec | getDescription | |
| Description: | Static strings used for describing an object or property. | |
| com.vmware.library.vc.spec | getResourceAllocationInfo | |
| Description: | The ResourceAllocationInfo specifies the reserved resource requirement as well as the limit (maximum allowed usage) for a given kind of resource. This is specified for both memory allocation (specified in MB) and CPU allocation (specified in MHz). For a resource pool, the reservation is specified as a value and a flag. The reservation is the guaranteed amount of a resource that the resource pool has. If expandableReservation is true, then the resource pool is allowed to grow its reservation dynamically by borrowing unreserved resources from its parent resource pool. If the limit is configured, it must be greater than or equal to the reservation. | |
| com.vmware.library.vc.spec | getResourceConfigSpec | |
| Description: | Return a VimResourceConfigSpec | |
| com.vmware.library.vc.spec | getSharesInfo | |
| Description: | Specification of shares. Shares are used to determine relative allocation between resource consumers. In general, a consumer with more shares gets proportionally more of the resource, subject to certain other constraints. | |
| Module: com.vmware.library.vc.storage | ||
| com.vmware.library.vc.storage | rescanAll | |
| Description: | Rescans all HBA, VMFS and StorageSystem of a HostSystem. | |
| Module: com.vmware.library.vc.vapp | ||
| com.vmware.library.vc.vapp | getAllVMsOfVApp | |
| Description: | Return all the virtual machine in a vapp | |
| Module: com.vmware.library.vc.vm | ||
| com.vmware.library.vc.vm | cloneVM | |
| Description: | Try to clone a VM. | |
| com.vmware.library.vc.vm | customizeVM | |
| Description: | Try to customize a VM. (no clone operation done) If any Exception appens, raise a "VMware3:CloneException" with no object attached. | |
| com.vmware.library.vc.vm | describeVirtualMachine | |
| Description: | Returns a virtual machine description string for a VC2 VM. The string contains the virtual machine display name and it's power status. | |
| com.vmware.library.vc.vm | destroyVm | |
| Description: | Destroy the Virtual Machine, removing it from the Inventory AND from the Datastore! | |
| com.vmware.library.vc.vm | getAllVMs | |
| Description: | Return all the virtual machines | |
| com.vmware.library.vc.vm | getAllVMsMatchingRegexp | |
| Description: | null | |
| com.vmware.library.vc.vm | linkedCloneVM | |
| Description: | Try to linked clone a VM. | |
| com.vmware.library.vc.vm | setDiskToNonPersitent | |
| Description: | Set all disk of the VM to the mode: independent non-persistent Return the task for reconfiguring the VM devices | |
| Module: com.vmware.library.vc.vm.network | ||
| com.vmware.library.vc.vm.network | getNetworkForGivenNic | |
| Description: | Retrun the network for a given VM nic | |
| com.vmware.library.vc.vm.network | getNicByNumber | |
| Description: | Return a Network card device (VimVirtualE1000, VimVirtualVmxnet, VimVirtualPCNet32). The network position let you choose if you want to get the 1st, 2nd... 5th network card. | |
| com.vmware.library.vc.vm.network | getNumberOfNic | |
| Description: | Get total number of NIC (network interface card) of a VM | |
| Module: com.vmware.library.vc.vm.os | ||
| com.vmware.library.vc.vm.os | getAllLinuxVMs | |
| Description: | Return all the virtual machine which have Windows as operating system | |
| com.vmware.library.vc.vm.os | getAllWindowsVMs | |
| Description: | Return all the virtual machine which have Windows as operating system | |
| com.vmware.library.vc.vm.os | getVirtualMachinesByOs | |
| Description: | null | |
| com.vmware.library.vc.vm.os | isWindowsOsInVm | |
| Description: | Return true if the OS is a Windows. | |
| Module: com.vmware.library.vc.vm.power | ||
| com.vmware.library.vc.vm.power | forcePowerOff | |
| Description: | Force the power off of a VM | |
| com.vmware.library.vc.vm.power | resetVM | |
| Description: | Resets power on this virtual machine. If the current state is poweredOn, then this method first performs powerOff(hard). Once the power state is poweredOff, then this method performs powerOn(option). Although this method functions as a powerOff followed by a powerOn, the two operations are atomic with respect to other clients, meaning that other power operations cannot be performed until the reset method completes. | |
| com.vmware.library.vc.vm.power | shutdownVM | |
| Description: | Shutdown the VM guest and wait for a given time before throwing an error if the VM is still not powered off. If timeout is set to 0, the action don't wait | |
| com.vmware.library.vc.vm.power | shutdownVMAndForce | |
| Description: | Try to shutdown a VM guest. If still not power off after 5 minutes, force power off. | |
| com.vmware.library.vc.vm.power | standbyGuest | |
| Description: | Stand by the guest operating System. VMware tools have to be available. | |
| com.vmware.library.vc.vm.power | startVM | |
| Description: | Start / Resume a VM. Return the start task | |
| com.vmware.library.vc.vm.power | suspendVM | |
| Description: | Suspend a VM. Return the suspend Task | |
| Module: com.vmware.library.vc.vm.snapshot | ||
| com.vmware.library.vc.vm.snapshot | createSnapshot | |
| Description: | Creates a new snapshot of this virtual machine. As a side effect, this updates the current snapshot. Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients may also escape any other characters in this name parameter. | |
| com.vmware.library.vc.vm.snapshot | getAllSnapshotResultInDatastoreBrowser | |
| Description: | null | |
| com.vmware.library.vc.vm.snapshot | getAllSnapshotsOfVM | |
| Description: | Get all snapshots for a vm | |
| com.vmware.library.vc.vm.snapshot | getPropertiesForAllSnapshotTask | |
| Description: | Return properties with the name of snapshot as key and vc object VirtualMachineSnapshot as value. It is used to get the snapshot VC Object when searching information on the snapshot from the datastorebrowser which return the name of the snapshot but not the object. | |
| com.vmware.library.vc.vm.snapshot | getPropertiesForSnapshotTask | |
| Description: | Return properties with the name of snapshot as key and vc object VirtualMachineSnapshot as value. It is used to get the snapshot VC Object when searching information on the snapshot from the datastorebrowser which return the name of the snapshot but not the object. | |
| com.vmware.library.vc.vm.snapshot | removeAllSnapshot | |
| Description: | Remove all the snapshots associated with this virtual machine. If the virtual machine does not have any snapshots, then this operation simply returns successfully. | |
| com.vmware.library.vc.vm.snapshot | removeOldestSnapshotOfVM | |
| Description: | Remove the x oldest snapshots of a virtual machine | |
| com.vmware.library.vc.vm.snapshot | revertToCurrentSnapshot | |
| Description: | Reverts the virtual machine to the current snapshot. This is equivalent to doing snapshot.currentSnapshot.revert. If no snapshot exists, then the operation does nothing, and the virtual machine state remains unchanged. | |
| Module: com.vmware.library.vc.vm.spec | ||
| com.vmware.library.vc.vm.spec | checkVMwareInput | |
| Description: | Check that basics inputs parameters of a Clone workflows are all part of the same vimHost (Virutal Center) | |
| com.vmware.library.vc.vm.spec | getCloneSpec | |
| Description: | Specification for a virtual machine cloning operation. | |
| com.vmware.library.vc.vm.spec | getConfigSpec | |
| Description: | The ConfigSpec data object type encapsulates configuration settings when creating or reconfiguring a virtual machine. To support incremental changes, these properties are all optional. | |
| com.vmware.library.vc.vm.spec | getConfigSpecSimple | |
| Description: | The ConfigSpec data object type encapsulates configuration settings when creating or reconfiguring a virtual machine. To support incremental changes, these properties are all optional. Basic Version | |
| com.vmware.library.vc.vm.spec | getCustomizationGlobalIPSettings | |
| Description: | A collection of global IP settings for a virtual network adapter. In Linux, DNS server settings are global. The settings can either be statically set or supplied by a DHCP server. | |
| com.vmware.library.vc.vm.spec | getCustomizationGlobalIPSettingsWithDomainAsString | |
| Description: | A collection of global IP settings for a virtual network adapter. In Linux, DNS server settings are global. The settings can either be statically set or supplied by a DHCP server. | |
| com.vmware.library.vc.vm.spec | getCustomizationSpec | |
| Description: | The Specification data object type contains information required to customize a virtual machine when deploying it or migrating it to a new host. | |
| com.vmware.library.vc.vm.spec | getCustomizationSpecSysprepText | |
| Description: | null | |
| com.vmware.library.vc.vm.spec | getCustomizationWinOptions | |
| Description: | Optional operations supported by the customization process for Windows. | |
| com.vmware.library.vc.vm.spec | getRelocateSpec | |
| Description: | Specification for moving or copying a virtual machine to a different datastore or host. | |
| Module: com.vmware.library.vc.vm.spec.config | ||
| com.vmware.library.vc.vm.spec.config | getVirtualDeviceConfigSpec | |
| Description: | The VirtualDeviceSpec data object type encapsulates change specifications for an individual virtual device. The virtual device being added or modified must be fully specified. | |
| com.vmware.library.vc.vm.spec.config | getVirtualDeviceConnectInfo | |
| Description: | VirtualDevice is the base data object type for devices in a virtual machine. This type contains enough information about a virtual device to allow clients to display devices they do not recognize. For example, a client with an older version than the server to which it connects may see a device without knowing what it is. | |
| com.vmware.library.vc.vm.spec.config | getVirtualMachineAffinityInfo | |
| Description: | Allow to create a VirtualMachineAffinityInfo Specification of scheduling affinity. Scheduling affinity is used for explicitly specifying which processors or NUMA nodes may be used by a virtual machine. | |
| com.vmware.library.vc.vm.spec.config | getVirtualMachineConsolePreferences | |
| Description: | Create a VirtualMachineConsolePrefrences. Preferences for the legacy console application that affect the way it behaves during power operations on the virtual machine. | |
| Module: com.vmware.library.vc.vm.spec.config.device | ||
| com.vmware.library.vc.vm.spec.config.device | createVirtualDiskFlatVer2ConfigSpec | |
| Description: | Create a new VimVirtualDeviceConfigSpec for a VimVirtualDiskFlatVer2BackingInfo. The VirtualDisk.FlatVer2BackingInfo data object type contains information about backing a virtual disk using a virtual disk file on the host, in the flat file format used by GSX Server 3.x, ESX Server 2.x, and ESX Server 3.x. Flat disks are allocated when created, unlike sparse disks, which grow as needed. | |
| com.vmware.library.vc.vm.spec.config.device | createVirtualEthernetCardDvNetworkConfigSpec | |
| Description: | Create a new VimVirtualDeviceConfigSpec for a VimVirtualEthernetCardNetworkBackingInfo The virtual Ethernet card backing class. | |
| com.vmware.library.vc.vm.spec.config.device | createVirtualEthernetCardNetworkConfigSpec | |
| Description: | Create a new VimVirtualDeviceConfigSpec for a VimVirtualEthernetCardNetworkBackingInfo The virtual Ethernet card backing class. | |
| com.vmware.library.vc.vm.spec.config.device | createVirtualFloppyRemoteConfigSpec | |
| Description: | Create a new VimVirtualDeviceConfigSpec for a VimVirtualFloppyRemoteDeviceBackingInfo The data object type for remote device backing of a virtual floppy drive. | |
| com.vmware.library.vc.vm.spec.config.device | createVirtualScsiControllerConfigSpec | |
| Description: | Create a new VimVirtualDeviceConfigSpec for a VimVirtualSCSIController The VirtualSCSIController data object type represents a SCSI controller in a virtual machine. | |
| com.vmware.library.vc.vm.spec.config.device | getParaVirtualSCSIController | |
| Description: | ParaVirtualSCSIController is the data object that represents a paravirtualized SCSI controller. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualBusLogicController | |
| Description: | VirtualBusLogicController is the data object that represents a BusLogic SCSI controller. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualCdrom | |
| Description: | The VirtualCdrom data object type describes the configuration of a CD-ROM device in a virtual machine. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualController | |
| Description: | VirtualController is the base data object type for a device controller in a virtual machine. VirtualController extends VirtualDevice to inherit general information about a controller (such as name and description), and to allow controllers to appear in a generic list of virtual devices. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualDevice | |
| Description: | Set values common to all Virtual Device. Should not be called directly to create a VirtualDevice!!! VirtualDevice is the base data object type for devices in a virtual machine. This type contains enough information about a virtual device to allow clients to display devices they do not recognize. For example, a client with an older version than the server to which it connects may see a device without knowing what it is. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualDisk | |
| Description: | The VirtualDisk data object type contains information about a disk in a virtual machine. The virtual disk backing object types in the VirtualDisk data object type describe the different virtual disk backings available. The disk format version in each case describes the version of the format that is used. Supported virtual disk backings: Sparse disk format, version 1 and 2 The virtual disk backing grows when needed. Supported only for GSX Server. Flat disk format, version 1 and 2 The virtual disk backing is preallocated. Version 1 is supported only for GSX Server. Raw disk format, version 2 The virtual disk backing uses a full physical disk drive to back the virtual disk. Supported only for GSX Server. Partitioned raw disk format, version 2 The virtual disk backing uses one or more partitions on a physical disk drive to back a virtual disk. Supported only for GSX Server. Raw disk mapping, version 1 The virtual disk backing uses a raw device mapping to back the virtual disk. Supported for ESX Server | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualE1000 | |
| Description: | The VirtualE1000 data object type represents an instance of the E1000 virtual Ethernet adapter attached to a virtual machine. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualEnsoniq1371 | |
| Description: | The VirtualEnsoniq1371 data object type represents an Ensoniq 1371 sound card in a virtual machine. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualEthernetCard | |
| Description: | VirtualController is the base data object type for a device controller in a virtual machine. VirtualController extends VirtualDevice to inherit general information about a controller (such as name and description), and to allow controllers to appear in a generic list of virtual devices. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualFloppy | |
| Description: | The VirtualFloppy data object type contains information about a floppy drive in a virtual machine. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualIDEController | |
| Description: | The VirtualIDEController data object type specifies a virtual IDE controller. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualKeyboard | |
| Description: | This data object type contains information about the keyboard on a virtual machine. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualLsiLogicController | |
| Description: | VirtualLsiLogicController is the data object that represents a LSI Logic SCSI controller. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualLsiLogicSASController | |
| Description: | VirtualLsiLogicSASController is the data object that represents a LSI Logic SAS SCSI controller. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualMachineVideoCard | |
| Description: | The VirtualVideoCard data object type represents a video card in a virtual machine. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualParallelPort | |
| Description: | This data object type represents a parallel port in a virtual machine. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualPCIController | |
| Description: | The VirtualPCIController data object type defines a virtual PCI controller. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualPCNet32 | |
| Description: | This data object type defines the properties of an AMD Lance PCNet32 Ethernet card attached to a virtual machine. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualPointingDevice | |
| Description: | The VirtualPointingDevice data object type contains information about the mouse type on a virtual machine. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualPS2Controller | |
| Description: | The VirtualPCIController data object type defines a virtual PCI controller. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualSCSIController | |
| Description: | May not be called directly. The VirtualSCSIController data object type represents a SCSI controller in a virtual machine. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualSCSIPassthrough | |
| Description: | The VirtualSCSIPassthrough data object type contains information about a SCSI device on the virtual machine that is being backed by a generic SCSI device on the host via passthrough. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualSerialPort | |
| Description: | The VirtualSerialPort data object type represents a serial port in a virtual machine. The nested classes define the physical devices that can back the virtual serial port: a host file, a host serial port device, or a pipe. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualSIOController | |
| Description: | This data object type defines a Super IO Controller for floppy drives, parallel ports, and serial ports. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualSoundBlaster16 | |
| Description: | The VirtualSoundBlaster16 data object type represents a Sound Blaster 16 sound card in a virtual machine. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualUSB | |
| Description: | The VirtualUSB data object type contains information about a USB device attached to a virtual machine. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualUSBController | |
| Description: | This data object type defines a Super IO Controller for floppy drives, parallel ports, and serial ports. | |
| com.vmware.library.vc.vm.spec.config.device | getVirtualVmxnet | |
| Description: | The VirtualVmxnet data object type represents an instance of the Vmxnet virtual Ethernet adapter attached to a virtual machine. | |
| Module: com.vmware.library.vc.vm.spec.config.device.backing.device | ||
| com.vmware.library.vc.vm.spec.config.device.backing.device | getVirtualCdromAtapiBackingInfo | |
| Description: | The VirtualCdrom.AtapiBackingInfo data object type represents an ATAPI device backing for a virtual CD-ROM. | |
| com.vmware.library.vc.vm.spec.config.device.backing.device | getVirtualCdromPassthroughBackingInfo | |
| Description: | The VirtualCdrom.PassthroughBackingInfo data class represents a device pass-through backing for a virtual CD-ROM. | |
| com.vmware.library.vc.vm.spec.config.device.backing.device | getVirtualDiskRawDiskVer2BackingInfo | |
| Description: | The VirtualDisk.RawDiskVer2BackingInfo data object type contains information about backing a virtual disk by using a host device, as used by GSX Server 3.x. | |
| com.vmware.library.vc.vm.spec.config.device.backing.device | getVirtualEthernetCardLegacyNetworkBackingInfo | |
| Description: | The virtual Ethernet card legacy backing class. | |
| com.vmware.library.vc.vm.spec.config.device.backing.device | getVirtualEthernetCardNetworkBackingInfo | |
| Description: | The virtual Ethernet card backing class. | |
| com.vmware.library.vc.vm.spec.config.device.backing.device | getVirtualFloppyDeviceBackingInfo | |
| Description: | The data object type for device backing of a virtual floppy drive. | |
| com.vmware.library.vc.vm.spec.config.device.backing.device | getVirtualParallelPortDeviceBackingInfo | |
| Description: | The data object type for a device backing of a virtual parallel port. | |
| com.vmware.library.vc.vm.spec.config.device.backing.device | getVirtualPointingDeviceDeviceBackingInfo | |
| Description: | The VirtualPointingDevice.DeviceBackingInfo provides information about the physical mouse backing the VirtualPointingDevice data object type. | |
| com.vmware.library.vc.vm.spec.config.device.backing.device | getVirtualSCSIPassthroughDeviceBackingInfo | |
| Description: | The VirtualSCSIPassthrough.DeviceBackingInfo data object type contains information about the backing that maps the virtual device onto a physical device. | |
| com.vmware.library.vc.vm.spec.config.device.backing.device | getVirtualSerialPortDeviceBackingInfo | |
| Description: | This data object type provides information for backing a virtual serial port with a host serial port device. | |
| com.vmware.library.vc.vm.spec.config.device.backing.device | getVirtualSoundCardDeviceBackingInfo | |
| Description: | The sound card device backing data class. | |
| Module: com.vmware.library.vc.vm.spec.config.device.backing.file | ||
| com.vmware.library.vc.vm.spec.config.device.backing.file | getVirtualCdromIsoBackingInfo | |
| Description: | VirtualDevice.FileBackingInfo is a data object type for information about a file backing for a device in a virtual machine. | |
| com.vmware.library.vc.vm.spec.config.device.backing.file | getVirtualDiskFlatVer2BackingInfo | |
| Description: | The VirtualDisk.FlatVer2BackingInfo data object type contains information about backing a virtual disk using a virtual disk file on the host, in the flat file format used by GSX Server 3.x, ESX Server 2.x, and ESX Server 3.x. Flat disks are allocated when created, unlike sparse disks, which grow as needed. | |
| com.vmware.library.vc.vm.spec.config.device.backing.file | getVirtualDiskRawDiskMappingVer1BackingInfo | |
| Description: | The VirtualDisk.FlatVer2BackingInfo data object type contains information about backing a virtual disk using a virtual disk file on the host, in the flat file format used by GSX Server 3.x, ESX Server 2.x, and ESX Server 3.x. Flat disks are allocated when created, unlike sparse disks, which grow as needed. | |
| com.vmware.library.vc.vm.spec.config.device.backing.file | getVirtualFloppyImageBackingInfo | |
| Description: | The data object type for file image backing of a virtual floppy drive. | |
| com.vmware.library.vc.vm.spec.config.device.backing.file | getVirtualParallelPortFileBackingInfo | |
| Description: | The data object type for a file backing of a virtual parallel port. | |
| com.vmware.library.vc.vm.spec.config.device.backing.file | getVirtualSerialPortFileBackingInfo | |
| Description: | This data object type provides information for backing a virtual serial port with a host file. | |
| Module: com.vmware.library.vc.vm.spec.config.device.backing.pipe | ||
| com.vmware.library.vc.vm.spec.config.device.backing.pipe | getVirtualSerialPortPipeBackingInfo | |
| Description: | This data object type provides information for backing a virtual serial port with a pipe. A pipe enables you to set up the virtual serial port to connect to an application on the host computer. This is useful, for example, if you want to use an application on the host to capture debugging information sent from the virtual machine's serial port. | |
| Module: com.vmware.library.vc.vm.spec.config.device.backing.remote | ||
| com.vmware.library.vc.vm.spec.config.device.backing.remote | getVirtualCdromRemotePassthroughBackingInfo | |
| Description: | The VirtualCdrom.RemotePassthroughBackingInfo data object type contains the information to specify a remote pass-through device backing of a virtual CD-ROM. | |
| com.vmware.library.vc.vm.spec.config.device.backing.remote | getVirtualDeviceRemoteDeviceBackingInfo | |
| Description: | VirtualDevice.RemoteDeviceBackingInfo is a data object type for information about a remote device backing used by a device in a virtual machine. The primary difference between a remote device backing and a local device backing is that the VirtualCenter server cannot provide a list of remote host devices available for this virtual device backing. | |
| com.vmware.library.vc.vm.spec.config.device.backing.remote | getVirtualFloppyRemoteDeviceBackingInfo | |
| Description: | The data object type for remote device backing of a virtual floppy drive. | |
| Module: com.vmware.library.vc.vm.spec.identity | ||
| com.vmware.library.vc.vm.spec.identity | getCustomizationCustomName | |
| Description: | Specifies that the VirtualCenter server will launch an external application to generate the (hostname/IP). The command line for this application must be specified in the server configuration file (vpxd.cfg) in the vpxd/name-ip-generator key. | |
| com.vmware.library.vc.vm.spec.identity | getCustomizationFixedName | |
| Description: | A fixed name. | |
| com.vmware.library.vc.vm.spec.identity | getCustomizationGuiRunOnce | |
| Description: | The commands listed in the GuiRunOnce data object type are executed when a user logs on the first time after customization completes. The logon may be driven by the AutoLogon setting. | |
| com.vmware.library.vc.vm.spec.identity | getCustomizationGuiUnattended | |
| Description: | The GuiUnattended type maps to the GuiUnattended key in the sysprep.inf answer file. These values are plugged directly into the sysprep.inf file that VirtualCenter stores on the target virtual disk. | |
| com.vmware.library.vc.vm.spec.identity | getCustomizationIdentification | |
| Description: | The Identification data object type provides information needed to join a workgroup or domain | |
| com.vmware.library.vc.vm.spec.identity | getCustomizationIdentificationFromCredential | |
| Description: | The Identification data object type provides information needed to join a workgroup or domain | |
| com.vmware.library.vc.vm.spec.identity | getCustomizationLicenseFilePrintData | |
| Description: | The LicenseFilePrintData type maps directly to the LicenseFilePrintData key in the sysprep.inf answer file. | |
| com.vmware.library.vc.vm.spec.identity | getCustomizationLinuxPrep | |
| Description: | This is the Linux counterpart to the Windows Sysprep object. LinuxPrep contains machine-wide settings that identify a Linux machine in the same way that the Sysprep type identifies a Windows machine. | |
| com.vmware.library.vc.vm.spec.identity | getCustomizationPassword | |
| Description: | Contains a password string and a flag that specifies whether the string is in plain text or encrypted. | |
| com.vmware.library.vc.vm.spec.identity | getCustomizationPrefixName | |
| Description: | Specifies that a unique name should be generated by concatenating the base string with a number. Virtual machine names are unique across the set of hosts and virtual machines known to the VirtualCenter instance. VirtualCenter tracks the network names of virtual machines as well as hosts. VMware Tools runs in a guest operating system and reports information to VirtualCenter, including the network name of the guest. | |
| com.vmware.library.vc.vm.spec.identity | getCustomizationSysprep | |
| Description: | An object representation of a Windows sysprep.inf answer file. The sysprep type encloses all the individual keys listed in a sysprep.inf file. For more detailed information, see the document Windows 2000 Unattended Setup Guide. | |
| com.vmware.library.vc.vm.spec.identity | getCustomizationUnknownName | |
| Description: | Indicates that the name is not specified in advance. The client should prompt the user for the value to complete the specification. | |
| com.vmware.library.vc.vm.spec.identity | getCustomizationUserData | |
| Description: | Personal data pertaining to the owner of the virtual machine. | |
| com.vmware.library.vc.vm.spec.identity | getCustomizationVirtualMachineName | |
| Description: | Specifies that VirtualCenter should generate a virtual machine name from a base prefix comprising the virtual machine entity name. A number is appended, if necessary, to make it unique. Virtual machine names are unique across the set of hosts and virtual machines known to the VirtualCenter instance. VMware Tools reports the names of existing virtual machines. | |
| Module: com.vmware.library.vc.vm.spec.nic | ||
| com.vmware.library.vc.vm.spec.nic | getCustomizationAdapterMapping | |
| Description: | Define Data object type to associate a virtual network adapter with its IP settings. | |
| com.vmware.library.vc.vm.spec.nic | getCustomizationDhcpIpGenerator | |
| Description: | Use a DHCP server to configure the virtual network adapter. | |
| com.vmware.library.vc.vm.spec.nic | getCustomizationFixedIp | |
| Description: | Use a static IP Address for the virtual network adapter. | |
| com.vmware.library.vc.vm.spec.nic | getCustomizationIPSettings | |
| Description: | Define IP settings for a virtual network adapter. | |
| com.vmware.library.vc.vm.spec.nic | getCustomizationUnknownIpGenerator | |
| Description: | The IP address is left unspecified. The user must be prompted to supply an IP address. | |
| Module: com.vmware.library.vc.vm.tools | ||
| com.vmware.library.vc.vm.tools | upgradeToolsAtNextReboot | |
| Description: | Upgrade vm tools at next reboot | |
| com.vmware.library.vc.vm.tools | vim3WaitDnsNameInTools | |
| Description: | Wait for a given name in the DNS guest informations (VMware tools). Exception: - Timeout: When timeout is reached | |
| com.vmware.library.vc.vm.tools | vim3WaitForPrincipalIP | |
| Description: | Return IP if found. Else return empty string. Exception: - Timeout: timeout reached | |
| com.vmware.library.vc.vm.tools | vim3WaitToolsStarted | |
| Description: | Wait for the VMware tools to be up and the guest running Exception: - Timeout: When timeout is reached - ReferenceError: When vm is not set correctly | |
| Module: com.vmware.library.vim3.basic | ||
| com.vmware.library.vim3.basic | cloneVM | |
| Description: | Creates a clone of this virtual machine. If the virtual machine is used as a template, this method corresponds to the deploy command. Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients may also escape any other characters in this name parameter. The privilege required on the source virtual machine depends on the source and destination types: - source is virtual machine, destination is virtual machine - VirtualMachine.Provisioning.Clone - source is virtual machine, destination is template - VirtualMachine.Provisioning.CreateTemplateFromVM - source is template, destination is virtual machine - VirtualMachine.Provisioning.DeployTemplate - source is template, destination is template - VirtualMachine.Provisioning.CloneTemplate If customization is requested in the CloneSpec, then the VirtualMachine.Provisioning.Customize privilege must also be held on the source virtual machine. | |
| com.vmware.library.vim3.basic | getDatacenterForVimObject | |
| Description: | Return the Datacenter for any Vim object. Return null if not in a datacenter (Datacenter folder) | |
| com.vmware.library.vim3.basic | getVimHostForVimObject | |
| Description: | Return the VimHost (Virtual Center) for any Vim object | |
| com.vmware.library.vim3.basic | getVimPathForVimObject | |
| Description: | null | |
| com.vmware.library.vim3.basic | vim3WaitTaskEnd | |
| Description: | Wait a VIM 3 Task to end. When task ended, return the task result if any. | |
| com.vmware.library.vim3.basic | WaitTaskEndOrVMQuestion | |
| Description: | Wait for a VIM 3 Task to end or for the VM to ask a question. Return the task result or the question asked. | |
| Module: com.vmware.library.vim3.cluster | ||
| com.vmware.library.vim3.cluster | drsEnabledCluster | |
| Description: | Return true if the specified cluster is DRS enabled. False if not. | |
| com.vmware.library.vim3.cluster | getAllClusterComputeResourceForVimHost | |
| Description: | Get all the ClusterComputeResource in a VimHost | |
| com.vmware.library.vim3.cluster | getAllComputeResourceForVimHost | |
| Description: | Get all ComputeResource (Non cluster) in a VimHost | |
| com.vmware.library.vim3.cluster | getAllVMsOfCluster | |
| Description: | Get all VMs in a cluster | |
| com.vmware.library.vim3.cluster | getAllVMsOfComputeResource | |
| Description: | Return all VMs of a ComputeResource (non cluster) | |
| com.vmware.library.vim3.cluster | getComputeResourceOfVm | |
| Description: | Return the ComputeResource or ClusterComputeResource of a VM | |
| com.vmware.library.vim3.cluster | getNetworkForCluster | |
| Description: | Actions for presentations Return a list of network for a cluster, computeResource or host | |
| Module: com.vmware.library.vim3.customattribute | ||
| com.vmware.library.vim3.customattribute | getCustomField | |
| Description: | Return the custom field value | |
| com.vmware.library.vim3.customattribute | setOrCreateCustomField | |
| Description: | Set a custom attribute for an object. If the custom attribute does not exist, the action create it | |
| Module: com.vmware.library.vim3.datastore | ||
| com.vmware.library.vim3.datastore | getAllAvaiblableHostForVM | |
| Description: | [DEPRECATED] Return all hosts "viewing" the VM. | |
| com.vmware.library.vim3.datastore | getAllDatastoreOnVimHost | |
| Description: | Return all datastores on an ESX host | |
| com.vmware.library.vim3.datastore | getDatacenterForDatastore | |
| Description: | Get datacenter for a datastore | |
| com.vmware.library.vim3.datastore | getDatastoreForHostAndResourcePool | |
| Description: | Return all available Datastore on host and pool (sum of each). If host and pool are null, return the available datastore to relocate the vm (in fact, all datastore in the same Virtual Center) | |
| com.vmware.library.vim3.datastore | getDatastoreFreeSize | |
| Description: | Return the Available Size on a Datastore in MB. | |
| com.vmware.library.vim3.datastore | getValidDatastoreForNetwork | |
| Description: | Get all valid datastores for a network. | |
| com.vmware.library.vim3.datastore | getValidNetworkForDatastore | |
| Description: | null | |
| Module: com.vmware.library.vim3.datastore.files | ||
| com.vmware.library.vim3.datastore.files | getAllConfigFile | |
| Description: | Get all VMX files on a datastore (using API to browse the datastore directly) | |
| com.vmware.library.vim3.datastore.files | getAllFloppyImageFile | |
| Description: | Get all Floppy image files (*.flp) on a datastore (using API to browse the datastore directly) | |
| com.vmware.library.vim3.datastore.files | getAllTemplateConfigFile | |
| Description: | Get all VMTX files on a datastore (using API to browse the datastore directly) | |
| com.vmware.library.vim3.datastore.files | getAllVmdkFile | |
| Description: | Get all VMDK files on a datastore (using API to browse the datastore directly) | |
| Module: com.vmware.library.vim3.folder | ||
| com.vmware.library.vim3.folder | createFolder | |
| Description: | Create a folder in an existing folder Return the new folder | |
| com.vmware.library.vim3.folder | destroyFolder | |
| Description: | Delete an existing folder. Return the deletion task. | |
| com.vmware.library.vim3.folder | destroyFolderAndWait | |
| Description: | Delete a folder and wait the task's completion | |
| com.vmware.library.vim3.folder | getRootVmFolder | |
| Description: | Return the root VMfolder. Does not return anything if there are more than one datacenter | |
| com.vmware.library.vim3.folder | getVirtualMachineByFolder | |
| Description: | null | |
| com.vmware.library.vim3.folder | renameFolder | |
| Description: | Rename a given folder. Return the rename task | |
| com.vmware.library.vim3.folder | renameFolderAndWait | |
| Description: | Rename a given workflow and wait the task's completion | |
| Module: com.vmware.library.vim3.network | ||
| com.vmware.library.vim3.network | getDatacenterForNetwork | |
| Description: | Return datacenter of a network | |
| com.vmware.library.vim3.network | getNetworkForResourcePoolHostVm | |
| Description: | Return available network for a resource pool, a host (if cluster is null) or for a VM (if cluster and host are null). Used in the networks list in clone presentations. If called with a (non-null) parameter of the wrong type, this action could possibly return an "undefined" value. | |
| com.vmware.library.vim3.network | getNetworksForLabel | |
| Description: | Returns all networks with name specified by label | |
| com.vmware.library.vim3.network | getNetworksForVimHost | |
| Description: | Return all existing networks in a VimHost | |
| Module: com.vmware.library.vim3.resourcePool | ||
| com.vmware.library.vim3.resourcePool | createResourcePool | |
| Description: | Create a new Rescource Pool with default CPU and memory allocation (disabled). Returns the new ResourcePool, null if any error. | |
| com.vmware.library.vim3.resourcePool | createResourcePoolForCluster | |
| Description: | Create a new Rescource Pool with default CPU and momory allocation (disabled). Returns the new ResourcePool, null if any error. | |
| com.vmware.library.vim3.resourcePool | destroyResourcePool | |
| Description: | Destroy a resource pool. Return the task created by this action. Wait on the task to end to be sure the resource pool is well renamed | |
| com.vmware.library.vim3.resourcePool | destroyResourcePoolAndWait | |
| Description: | Destroy a resource pool and wait on the task. Return true is the resource pool was destroyed, false if not. | |
| com.vmware.library.vim3.resourcePool | getAllChildResourcePool | |
| Description: | Return all resource pool of the given resource pool | |
| com.vmware.library.vim3.resourcePool | getAllResourcePool | |
| Description: | Return all the Resource Pools on all plugins | |
| com.vmware.library.vim3.resourcePool | getValidResourcePoolForDatastore | |
| Description: | Get valid resourcePools for a datastore | |
| com.vmware.library.vim3.resourcePool | getValidResourcePoolForNetwork | |
| Description: | Get valid resourcePools for a network | |
| com.vmware.library.vim3.resourcePool | renameResourcePool | |
| Description: | Rename a resource pool. Return the task created by this action. Wait on the task to end to be sure the resource pool is well renamed | |
| com.vmware.library.vim3.resourcePool | renameResourcePoolAndWait | |
| Description: | Rename a resource pool and wait on the task. return true is the resource pool was renamed, false if not. | |
| Module: com.vmware.library.vim3.spec | ||
| com.vmware.library.vim3.spec | getDescription | |
| Description: | Static strings used for describing an object or property. | |
| com.vmware.library.vim3.spec | getResourceAllocationInfo | |
| Description: | The ResourceAllocationInfo specifies the reserved resource requirement as well as the limit (maximum allowed usage) for a given kind of resource. This is specified for both memory allocation (specified in MB) and CPU allocation (specified in MHz). For a resource pool, the reservation is specified as a value and a flag. The reservation is the guaranteed amount of a resource that the resource pool has. If expandableReservation is true, then the resource pool is allowed to grow its reservation dynamically by borrowing unreserved resources from its parent resource pool. If the limit is configured, it must be greater than or equal to the reservation. | |
| com.vmware.library.vim3.spec | getResourceConfigSpec | |
| Description: | Return a VimResourceConfigSpec | |
| com.vmware.library.vim3.spec | getSharesInfo | |
| Description: | Specification of shares. Shares are used to determine relative allocation between resource consumers. In general, a consumer with more shares gets proportionally more of the resource, subject to certain other constraints. | |
| Module: com.vmware.library.vim3.vm | ||
| com.vmware.library.vim3.vm | cloneVM | |
| Description: | Try to clone a VM. If any Exception appens, raise a "VMware3:CloneException" with no object attached. | |
| com.vmware.library.vim3.vm | customizeVM | |
| Description: | Try to customize a VM. (no clone operation done) If any Exception appens, raise a "VMware3:CloneException" with no object attached. | |
| com.vmware.library.vim3.vm | describeVirtualMachine | |
| Description: | Returns a virtual machine description string for a VC2 VM. The string contains the virtual machine display name and it's power status. | |
| com.vmware.library.vim3.vm | destroyVm | |
| Description: | Destroy the Virtual Machine, removing it from the Inventory AND from the Datastore! | |
| com.vmware.library.vim3.vm | getVMTotalSize | |
| Description: | null | |
| com.vmware.library.vim3.vm | setDiskToNonPersitent | |
| Description: | Set all disk of the VM to the mode: independent non-persistent Return the task for reconfiguring the VM devices | |
| Module: com.vmware.library.vim3.vm.network | ||
| com.vmware.library.vim3.vm.network | getNetworkForGivenNic | |
| Description: | Retrun the network for a given VM nic | |
| com.vmware.library.vim3.vm.network | getNicByNumber | |
| Description: | Return a Network card device (VimVirtualE1000, VimVirtualVmxnet, VimVirtualVmxnet2, VimVirtualPCNet32). The network position let you choose if you want to get the 1st, 2nd... 5th network card. | |
| com.vmware.library.vim3.vm.network | getNumberOfNic | |
| Description: | Get total number of NIC (network interface card) of a VM | |
| Module: com.vmware.library.vim3.vm.os | ||
| com.vmware.library.vim3.vm.os | isWindowsOsInVm | |
| Description: | Return true if the OS is a Windows. | |
| Module: com.vmware.library.vim3.vm.power | ||
| com.vmware.library.vim3.vm.power | forcePowerOff | |
| Description: | Force the power off of a VM | |
| com.vmware.library.vim3.vm.power | resetVM | |
| Description: | Resets power on this virtual machine. If the current state is poweredOn, then this method first performs powerOff(hard). Once the power state is poweredOff, then this method performs powerOn(option). Although this method functions as a powerOff followed by a powerOn, the two operations are atomic with respect to other clients, meaning that other power operations cannot be performed until the reset method completes. | |
| com.vmware.library.vim3.vm.power | shutdownVM | |
| Description: | Shutdown the VM guest and wait for a given time before throwing an error if the VM is still not powered off. If timeout is set to 0, the action don't wait | |
| com.vmware.library.vim3.vm.power | shutdownVMAndForce | |
| Description: | Try to shutdown a VM guest. If still not power off after 5 minutes, force power off. | |
| com.vmware.library.vim3.vm.power | standbyGuest | |
| Description: | Stand by the guest operating System. VMware tools have to be available. | |
| com.vmware.library.vim3.vm.power | startVM | |
| Description: | Start / Resume a VM. Return the start task | |
| com.vmware.library.vim3.vm.power | suspendVM | |
| Description: | Suspend a VM. Return the suspend Task | |
| Module: com.vmware.library.vim3.vm.snapshot | ||
| com.vmware.library.vim3.vm.snapshot | createSnapshot | |
| Description: | Creates a new snapshot of this virtual machine. As a side effect, this updates the current snapshot. Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients may also escape any other characters in this name parameter. | |
| com.vmware.library.vim3.vm.snapshot | removeAllSnapshot | |
| Description: | Remove all the snapshots associated with this virtual machine. If the virtual machine does not have any snapshots, then this operation simply returns successfully. | |
| com.vmware.library.vim3.vm.snapshot | revertToCurrentSnapshot | |
| Description: | Reverts the virtual machine to the current snapshot. This is equivalent to doing snapshot.currentSnapshot.revert. If no snapshot exists, then the operation does nothing, and the virtual machine state remains unchanged. | |
| Module: com.vmware.library.vim3.vm.spec | ||
| com.vmware.library.vim3.vm.spec | checkVMwareInput | |
| Description: | Check that basics inputs parameters of a Clone workflows are all part of the same vimHost (Virutal Center) | |
| com.vmware.library.vim3.vm.spec | getCloneSpec | |
| Description: | Specification for a virtual machine cloning operation. | |
| com.vmware.library.vim3.vm.spec | getConfigSpec | |
| Description: | The ConfigSpec data object type encapsulates configuration settings when creating or reconfiguring a virtual machine. To support incremental changes, these properties are all optional. | |
| com.vmware.library.vim3.vm.spec | getConfigSpecSimple | |
| Description: | The ConfigSpec data object type encapsulates configuration settings when creating or reconfiguring a virtual machine. To support incremental changes, these properties are all optional. Basic Version | |
| com.vmware.library.vim3.vm.spec | getCustomizationGlobalIPSettings | |
| Description: | A collection of global IP settings for a virtual network adapter. In Linux, DNS server settings are global. The settings can either be statically set or supplied by a DHCP server. | |
| com.vmware.library.vim3.vm.spec | getCustomizationGlobalIPSettingsWithDomainAsString | |
| Description: | A collection of global IP settings for a virtual network adapter. In Linux, DNS server settings are global. The settings can either be statically set or supplied by a DHCP server. | |
| com.vmware.library.vim3.vm.spec | getCustomizationSpec | |
| Description: | The Specification data object type contains information required to customize a virtual machine when deploying it or migrating it to a new host. | |
| com.vmware.library.vim3.vm.spec | getCustomizationSpecSysprepText | |
| Description: | null | |
| com.vmware.library.vim3.vm.spec | getCustomizationWinOptions | |
| Description: | Optional operations supported by the customization process for Windows. | |
| com.vmware.library.vim3.vm.spec | getRelocateSpec | |
| Description: | Specification for moving or copying a virtual machine to a different datastore or host. | |
| com.vmware.library.vim3.vm.spec | reconfigVm | |
| Description: | Start reconfiguring a VM, returning the Task | |
| Module: com.vmware.library.vim3.vm.spec.config | ||
| com.vmware.library.vim3.vm.spec.config | getVirtualDeviceConfigSpec | |
| Description: | The VirtualDeviceSpec data object type encapsulates change specifications for an individual virtual device. The virtual device being added or modified must be fully specified. | |
| com.vmware.library.vim3.vm.spec.config | getVirtualDeviceConnectInfo | |
| Description: | VirtualDevice is the base data object type for devices in a virtual machine. This type contains enough information about a virtual device to allow clients to display devices they do not recognize. For example, a client with an older version than the server to which it connects may see a device without knowing what it is. | |
| com.vmware.library.vim3.vm.spec.config | getVirtualMachineAffinityInfo | |
| Description: | Allow to create a VirtualMachineAffinityInfo Specification of scheduling affinity. Scheduling affinity is used for explicitly specifying which processors or NUMA nodes may be used by a virtual machine. | |
| com.vmware.library.vim3.vm.spec.config | getVirtualMachineConsolePreferences | |
| Description: | Create a VirtualMachineConsolePrefrences. Preferences for the legacy console application that affect the way it behaves during power operations on the virtual machine. | |
| Module: com.vmware.library.vim3.vm.spec.config.device | ||
| com.vmware.library.vim3.vm.spec.config.device | createVirtualDiskFlatVer2ConfigSpec | |
| Description: | Create a new VimVirtualDeviceConfigSpec for a VimVirtualDiskFlatVer2BackingInfo. The VirtualDisk.FlatVer2BackingInfo data object type contains information about backing a virtual disk using a virtual disk file on the host, in the flat file format used by GSX Server 3.x, ESX Server 2.x, and ESX Server 3.x. Flat disks are allocated when created, unlike sparse disks, which grow as needed. | |
| com.vmware.library.vim3.vm.spec.config.device | createVirtualEthernetCardNetworkConfigSpec | |
| Description: | Create a new VimVirtualDeviceConfigSpec for a VimVirtualEthernetCardNetworkBackingInfo The virtual Ethernet card backing class. | |
| com.vmware.library.vim3.vm.spec.config.device | createVirtualFloppyRemoteConfigSpec | |
| Description: | Create a new VimVirtualDeviceConfigSpec for a VimVirtualFloppyRemoteDeviceBackingInfo The data object type for remote device backing of a virtual floppy drive. | |
| com.vmware.library.vim3.vm.spec.config.device | createVirtualScsiControllerConfigSpec | |
| Description: | Create a new VimVirtualDeviceConfigSpec for a VimVirtualSCSIController The VirtualSCSIController data object type represents a SCSI controller in a virtual machine. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualBusLogicController | |
| Description: | VirtualBusLogicController is the data object that represents a BusLogic SCSI controller. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualCdrom | |
| Description: | The VirtualCdrom data object type describes the configuration of a CD-ROM device in a virtual machine. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualController | |
| Description: | VirtualController is the base data object type for a device controller in a virtual machine. VirtualController extends VirtualDevice to inherit general information about a controller (such as name and description), and to allow controllers to appear in a generic list of virtual devices. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualDevice | |
| Description: | Set values common to all Virtual Device. Should not be called directly to create a VirtualDevice!!! VirtualDevice is the base data object type for devices in a virtual machine. This type contains enough information about a virtual device to allow clients to display devices they do not recognize. For example, a client with an older version than the server to which it connects may see a device without knowing what it is. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualDisk | |
| Description: | The VirtualDisk data object type contains information about a disk in a virtual machine. The virtual disk backing object types in the VirtualDisk data object type describe the different virtual disk backings available. The disk format version in each case describes the version of the format that is used. Supported virtual disk backings: Sparse disk format, version 1 and 2 The virtual disk backing grows when needed. Supported only for GSX Server. Flat disk format, version 1 and 2 The virtual disk backing is preallocated. Version 1 is supported only for GSX Server. Raw disk format, version 2 The virtual disk backing uses a full physical disk drive to back the virtual disk. Supported only for GSX Server. Partitioned raw disk format, version 2 The virtual disk backing uses one or more partitions on a physical disk drive to back a virtual disk. Supported only for GSX Server. Raw disk mapping, version 1 The virtual disk backing uses a raw device mapping to back the virtual disk. Supported for ESX Server | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualE1000 | |
| Description: | The VirtualE1000 data object type represents an instance of the E1000 virtual Ethernet adapter attached to a virtual machine. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualEnsoniq1371 | |
| Description: | The VirtualEnsoniq1371 data object type represents an Ensoniq 1371 sound card in a virtual machine. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualEthernetCard | |
| Description: | VirtualController is the base data object type for a device controller in a virtual machine. VirtualController extends VirtualDevice to inherit general information about a controller (such as name and description), and to allow controllers to appear in a generic list of virtual devices. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualFloppy | |
| Description: | The VirtualFloppy data object type contains information about a floppy drive in a virtual machine. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualIDEController | |
| Description: | The VirtualIDEController data object type specifies a virtual IDE controller. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualKeyboard | |
| Description: | This data object type contains information about the keyboard on a virtual machine. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualLsiLogicController | |
| Description: | VirtualLsiLogicController is the data object that represents a LSI Logic SCSI controller. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualMachineVideoCard | |
| Description: | The VirtualVideoCard data object type represents a video card in a virtual machine. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualParallelPort | |
| Description: | This data object type represents a parallel port in a virtual machine. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualPCIController | |
| Description: | The VirtualPCIController data object type defines a virtual PCI controller. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualPCNet32 | |
| Description: | This data object type defines the properties of an AMD Lance PCNet32 Ethernet card attached to a virtual machine. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualPointingDevice | |
| Description: | The VirtualPointingDevice data object type contains information about the mouse type on a virtual machine. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualPS2Controller | |
| Description: | The VirtualPCIController data object type defines a virtual PCI controller. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualSCSIController | |
| Description: | May not be called directly. The VirtualSCSIController data object type represents a SCSI controller in a virtual machine. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualSCSIPassthrough | |
| Description: | The VirtualSCSIPassthrough data object type contains information about a SCSI device on the virtual machine that is being backed by a generic SCSI device on the host via passthrough. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualSerialPort | |
| Description: | The VirtualSerialPort data object type represents a serial port in a virtual machine. The nested classes define the physical devices that can back the virtual serial port: a host file, a host serial port device, or a pipe. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualSIOController | |
| Description: | This data object type defines a Super IO Controller for floppy drives, parallel ports, and serial ports. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualSoundBlaster16 | |
| Description: | The VirtualSoundBlaster16 data object type represents a Sound Blaster 16 sound card in a virtual machine. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualUSB | |
| Description: | The VirtualUSB data object type contains information about a USB device attached to a virtual machine. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualUSBController | |
| Description: | This data object type defines a Super IO Controller for floppy drives, parallel ports, and serial ports. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualVmxnet | |
| Description: | The VirtualVmxnet data object type represents an instance of the Vmxnet virtual Ethernet adapter attached to a virtual machine. | |
| com.vmware.library.vim3.vm.spec.config.device | getVirtualVmxnet2 | |
| Description: | The VirtualVmxnet data object type represents an instance of the Vmxnet virtual Ethernet adapter attached to a virtual machine. | |
| Module: com.vmware.library.vim3.vm.spec.config.device.backing.device | ||
| com.vmware.library.vim3.vm.spec.config.device.backing.device | getVirtualCdromAtapiBackingInfo | |
| Description: | The VirtualCdrom.AtapiBackingInfo data object type represents an ATAPI device backing for a virtual CD-ROM. | |
| com.vmware.library.vim3.vm.spec.config.device.backing.device | getVirtualCdromPassthroughBackingInfo | |
| Description: | The VirtualCdrom.PassthroughBackingInfo data class represents a device pass-through backing for a virtual CD-ROM. | |
| com.vmware.library.vim3.vm.spec.config.device.backing.device | getVirtualDiskRawDiskVer2BackingInfo | |
| Description: | The VirtualDisk.RawDiskVer2BackingInfo data object type contains information about backing a virtual disk by using a host device, as used by GSX Server 3.x. | |
| com.vmware.library.vim3.vm.spec.config.device.backing.device | getVirtualEthernetCardLegacyNetworkBackingInfo | |
| Description: | The virtual Ethernet card legacy backing class. | |
| com.vmware.library.vim3.vm.spec.config.device.backing.device | getVirtualEthernetCardNetworkBackingInfo | |
| Description: | The virtual Ethernet card backing class. | |
| com.vmware.library.vim3.vm.spec.config.device.backing.device | getVirtualFloppyDeviceBackingInfo | |
| Description: | The data object type for device backing of a virtual floppy drive. | |
| com.vmware.library.vim3.vm.spec.config.device.backing.device | getVirtualParallelPortDeviceBackingInfo | |
| Description: | The data object type for a device backing of a virtual parallel port. | |
| com.vmware.library.vim3.vm.spec.config.device.backing.device | getVirtualPointingDeviceDeviceBackingInfo | |
| Description: | The VirtualPointingDevice.DeviceBackingInfo provides information about the physical mouse backing the VirtualPointingDevice data object type. | |
| com.vmware.library.vim3.vm.spec.config.device.backing.device | getVirtualSCSIPassthroughDeviceBackingInfo | |
| Description: | The VirtualSCSIPassthrough.DeviceBackingInfo data object type contains information about the backing that maps the virtual device onto a physical device. | |
| com.vmware.library.vim3.vm.spec.config.device.backing.device | getVirtualSerialPortDeviceBackingInfo | |
| Description: | This data object type provides information for backing a virtual serial port with a host serial port device. | |
| com.vmware.library.vim3.vm.spec.config.device.backing.device | getVirtualSoundCardDeviceBackingInfo | |
| Description: | The sound card device backing data class. | |
| Module: com.vmware.library.vim3.vm.spec.config.device.backing.file | ||
| com.vmware.library.vim3.vm.spec.config.device.backing.file | getVirtualCdromIsoBackingInfo | |
| Description: | VirtualDevice.FileBackingInfo is a data object type for information about a file backing for a device in a virtual machine. | |
| com.vmware.library.vim3.vm.spec.config.device.backing.file | getVirtualDiskFlatVer2BackingInfo | |
| Description: | The VirtualDisk.FlatVer2BackingInfo data object type contains information about backing a virtual disk using a virtual disk file on the host, in the flat file format used by GSX Server 3.x, ESX Server 2.x, and ESX Server 3.x. Flat disks are allocated when created, unlike sparse disks, which grow as needed. | |
| com.vmware.library.vim3.vm.spec.config.device.backing.file | getVirtualDiskRawDiskMappingVer1BackingInfo | |
| Description: | The VirtualDisk.FlatVer2BackingInfo data object type contains information about backing a virtual disk using a virtual disk file on the host, in the flat file format used by GSX Server 3.x, ESX Server 2.x, and ESX Server 3.x. Flat disks are allocated when created, unlike sparse disks, which grow as needed. | |
| com.vmware.library.vim3.vm.spec.config.device.backing.file | getVirtualFloppyImageBackingInfo | |
| Description: | The data object type for file image backing of a virtual floppy drive. | |
| com.vmware.library.vim3.vm.spec.config.device.backing.file | getVirtualParallelPortFileBackingInfo | |
| Description: | The data object type for a file backing of a virtual parallel port. | |
| com.vmware.library.vim3.vm.spec.config.device.backing.file | getVirtualSerialPortFileBackingInfo | |
| Description: | This data object type provides information for backing a virtual serial port with a host file. | |
| Module: com.vmware.library.vim3.vm.spec.config.device.backing.pipe | ||
| com.vmware.library.vim3.vm.spec.config.device.backing.pipe | getVirtualSerialPortPipeBackingInfo | |
| Description: | This data object type provides information for backing a virtual serial port with a pipe. A pipe enables you to set up the virtual serial port to connect to an application on the host computer. This is useful, for example, if you want to use an application on the host to capture debugging information sent from the virtual machine's serial port. | |
| Module: com.vmware.library.vim3.vm.spec.config.device.backing.remote | ||
| com.vmware.library.vim3.vm.spec.config.device.backing.remote | getVirtualCdromRemotePassthroughBackingInfo | |
| Description: | The VirtualCdrom.RemotePassthroughBackingInfo data object type contains the information to specify a remote pass-through device backing of a virtual CD-ROM. | |
| com.vmware.library.vim3.vm.spec.config.device.backing.remote | getVirtualDeviceRemoteDeviceBackingInfo | |
| Description: | VirtualDevice.RemoteDeviceBackingInfo is a data object type for information about a remote device backing used by a device in a virtual machine. The primary difference between a remote device backing and a local device backing is that the VirtualCenter server cannot provide a list of remote host devices available for this virtual device backing. | |
| com.vmware.library.vim3.vm.spec.config.device.backing.remote | getVirtualFloppyRemoteDeviceBackingInfo | |
| Description: | The data object type for remote device backing of a virtual floppy drive. | |
| Module: com.vmware.library.vim3.vm.spec.identity | ||
| com.vmware.library.vim3.vm.spec.identity | getCustomizationCustomName | |
| Description: | Specifies that the VirtualCenter server will launch an external application to generate the (hostname/IP). The command line for this application must be specified in the server configuration file (vpxd.cfg) in the vpxd/name-ip-generator key. | |
| com.vmware.library.vim3.vm.spec.identity | getCustomizationFixedName | |
| Description: | A fixed name. | |
| com.vmware.library.vim3.vm.spec.identity | getCustomizationGuiRunOnce | |
| Description: | The commands listed in the GuiRunOnce data object type are executed when a user logs on the first time after customization completes. The logon may be driven by the AutoLogon setting. | |
| com.vmware.library.vim3.vm.spec.identity | getCustomizationGuiUnattended | |
| Description: | The GuiUnattended type maps to the GuiUnattended key in the sysprep.inf answer file. These values are plugged directly into the sysprep.inf file that VirtualCenter stores on the target virtual disk. | |
| com.vmware.library.vim3.vm.spec.identity | getCustomizationIdentification | |
| Description: | The Identification data object type provides information needed to join a workgroup or domain | |
| com.vmware.library.vim3.vm.spec.identity | getCustomizationIdentificationFromCredential | |
| Description: | The Identification data object type provides information needed to join a workgroup or domain | |
| com.vmware.library.vim3.vm.spec.identity | getCustomizationLicenseFilePrintData | |
| Description: | The LicenseFilePrintData type maps directly to the LicenseFilePrintData key in the sysprep.inf answer file. | |
| com.vmware.library.vim3.vm.spec.identity | getCustomizationLinuxPrep | |
| Description: | This is the Linux counterpart to the Windows Sysprep object. LinuxPrep contains machine-wide settings that identify a Linux machine in the same way that the Sysprep type identifies a Windows machine. | |
| com.vmware.library.vim3.vm.spec.identity | getCustomizationPassword | |
| Description: | Contains a password string and a flag that specifies whether the string is in plain text or encrypted. | |
| com.vmware.library.vim3.vm.spec.identity | getCustomizationPrefixName | |
| Description: | Specifies that a unique name should be generated by concatenating the base string with a number. Virtual machine names are unique across the set of hosts and virtual machines known to the VirtualCenter instance. VirtualCenter tracks the network names of virtual machines as well as hosts. VMware Tools runs in a guest operating system and reports information to VirtualCenter, including the network name of the guest. | |
| com.vmware.library.vim3.vm.spec.identity | getCustomizationSysprep | |
| Description: | An object representation of a Windows sysprep.inf answer file. The sysprep type encloses all the individual keys listed in a sysprep.inf file. For more detailed information, see the document Windows 2000 Unattended Setup Guide. | |
| com.vmware.library.vim3.vm.spec.identity | getCustomizationUnknownName | |
| Description: | Indicates that the name is not specified in advance. The client should prompt the user for the value to complete the specification. | |
| com.vmware.library.vim3.vm.spec.identity | getCustomizationUserData | |
| Description: | Personal data pertaining to the owner of the virtual machine. | |
| com.vmware.library.vim3.vm.spec.identity | getCustomizationVirtualMachineName | |
| Description: | Specifies that VirtualCenter should generate a virtual machine name from a base prefix comprising the virtual machine entity name. A number is appended, if necessary, to make it unique. Virtual machine names are unique across the set of hosts and virtual machines known to the VirtualCenter instance. VMware Tools reports the names of existing virtual machines. | |
| Module: com.vmware.library.vim3.vm.spec.nic | ||
| com.vmware.library.vim3.vm.spec.nic | getCustomizationAdapterMapping | |
| Description: | Define Data object type to associate a virtual network adapter with its IP settings. | |
| com.vmware.library.vim3.vm.spec.nic | getCustomizationDhcpIpGenerator | |
| Description: | Use a DHCP server to configure the virtual network adapter. | |
| com.vmware.library.vim3.vm.spec.nic | getCustomizationFixedIp | |
| Description: | Use a static IP Address for the virtual network adapter. | |
| com.vmware.library.vim3.vm.spec.nic | getCustomizationIPSettings | |
| Description: | Define IP settings for a virtual network adapter. | |
| com.vmware.library.vim3.vm.spec.nic | getCustomizationUnknownIpGenerator | |
| Description: | The IP address is left unspecified. The user must be prompted to supply an IP address. | |
| Module: com.vmware.library.vim3.vm.tools | ||
| com.vmware.library.vim3.vm.tools | vim3WaitDnsNameInTools | |
| Description: | Wait for a given name in the DNS guest informations (VMware tools). Exception: - Timeout: When timeout is reached | |
| com.vmware.library.vim3.vm.tools | vim3WaitForPrincipalIP | |
| Description: | Return IP if found. Else return empty string. Exception: - Timeout: timeout reached | |
| com.vmware.library.vim3.vm.tools | vim3WaitToolsStarted | |
| Description: | Wait for the VMware tools to be up and the guest running Exception: - Timeout: When timeout is reached - ReferenceError: When vm is not set correctly | |
| Module: com.vmware.library.workflow | ||
| com.vmware.library.workflow | getAllWorkflows | |
| Description: | Return all the workflows | |
| com.vmware.library.workflow | getWorkflowById | |
| Description: | Return the workflow for the given ID. Throw an exception if the workflow is not found | |
| com.vmware.library.workflow | waitAllWorkflowComplete | |
| Description: | null | |
| com.vmware.library.workflow | waitForCompletion | |
| Description: | Wait that the workflows are terminated | |
| Module: com.vmware.util | ||
| com.vmware.util | callActions | |
| Description: | Will call all actions in 'actions' parameter with args 'parameter, additionalParams'. It is assumed that all callable actions have the same signature and return the modifiable object ('parameter'), i.e : Any actionToCall(Any parameter, additionalParams[0], additionalParams[1], ...). | |
| com.vmware.util | exportAllActionsToCsv | |
| Description: | Log all action modules (name, version, signature and fingerprint) in a CSV file | |
| com.vmware.util | exportAllAuthorizationElementsToCsv | |
| Description: | Log all AuthorizationElements in a CSV file | |
| com.vmware.util | exportAllConfigurationElementsToCsv | |
| Description: | Log all configuration elements (name, version, signature and fingerprint) in a CSV file | |
| com.vmware.util | exportAllPoliciesToCsv | |
| Description: | Log all policies in a CSV file | |
| com.vmware.util | exportAllPolicyTemplatesToCsv | |
| Description: | Log all policy templates (name, version, signature and fingerprint) in a CSV file | |
| com.vmware.util | exportAllResourceElementsToCsv | |
| Description: | Log all resource elements (name, version, signature and fingerprint) in a CSV file | |
| com.vmware.util | exportAllTasksToCsv | |
| Description: | Log all Tasks in a CSV file | |
| com.vmware.util | exportAllWebviewsToCsv | |
| Description: | Log all webviews name, version, signature and fingerprint in a CSV file | |
| com.vmware.util | exportAllWorkflowsToCsv | |
| Description: | Log all workflows (name, version, signature and fingerprint) in a CSV file | |
| com.vmware.util | isActionParameterInstanceOfType | |
| Description: | null | |
| com.vmware.util | isWorkflowParameterInstanceOfType | |
| Description: | null | |
| Module: com.vmware.web.webview | ||
| com.vmware.web.webview | getAllPolicy | |
| Description: | null | |
| com.vmware.web.webview | getAllTask | |
| Description: | null | |
| com.vmware.web.webview | getAllWaitingForInput | |
| Description: | null | |
| com.vmware.web.webview | getExecutionListForWorkflowInSameCategory | |
| Description: | null | |
| com.vmware.web.webview | getExecutionsForCurrentUser | |
| Description: | Return the workflow which where executed by the current User. If VS-O version 3.1.1, check the runningUserName property of the WorkflowToken Object. Optionnaly, you can pass an array of workflow as first argument to look for executions insteed of searching among all the workflow executions. | |
| com.vmware.web.webview | getExecutionsForWorkflowCategory | |
| Description: | null | |
| com.vmware.web.webview | getExecutionsForWorkflowList | |
| Description: | null | |
| com.vmware.web.webview | getObjectFromParam | |
| Description: | Return the object from the parameter | |
| com.vmware.web.webview | getSortedExecutionsForWorkflowList | |
| Description: | Returns executions of a workflow list. These execustions are sorted by start date. | |
| com.vmware.web.webview | getTasksForWorkflowList | |
| Description: | null | |
| com.vmware.web.webview | getWorkflowByCategory | |
| Description: | null | |
| com.vmware.web.webview | getWorkflowListInSameCategory | |
| Description: | null | |
| com.vmware.web.webview | getWorkflowOutput | |
| Description: | workflowToken can be either a ParamString or an WorkflowTokenObject. Return a Properties object. | |
| com.vmware.web.webview | objectToJson | |
| Description: | null | |
| com.vmware.web.webview | objectToParam | |
| Description: | Retrieve the UrlParameter from an object. UrlParameter is used to send an object through an URL. | |
| com.vmware.web.webview | paramToDunesUri | |
| Description: | Return the dunesUri string from a param string. a param String is used in the webview and is the concatenation of the type and the uri. | |
| Module: com.vmware.web.webview.workbench | ||
| com.vmware.web.webview.workbench | getWorkbenchDataFactory | |
| Description: | return a WorkbenchDataFactory object with the following function: This is an helper factory to build you data object for the WorkbenchNavigationPane component. * addColumn(String name, String key, HashMap options) : void // set a new column where options could be: noShow[true], noSort[true], type[cssIcon | state], order[desc|asc]. * addRow(String id, String name, HashMap fields) : void // add a row with two mandatory field (id and name). Other fields are specified in fields hashmap where the key should match a column key. * getData() : Properties // return a complex Properties instance with all data and value. | |
| Module: org.dojotoolkit.dojo.json | ||
| org.dojotoolkit.dojo.json | serialize | |
| Description: | summary: Create a JSON serialization of an object, note that this doesn't check for infinite recursion, so don't do that! o: an object to be serialized. Objects may define their own serialization via a special "__json__" or "json" function property. If a specialized serializer has been defined, it will be used as a fallback. return: a String representing the serialized version of the passed object | |
| Module: org.dojotoolkit.dojo.string | ||
| org.dojotoolkit.dojo.string | escapeString | |
| Description: | null | |