com.vmware.general

Class Rename

java.lang.Object

com.vmware.connection.ConnectedVimServiceBase

com.vmware.general.Rename

@Sample(name="rename",
        description="This sample demonstrates renaming a manged entity")
public class Rename
extends ConnectedVimServiceBase

 Rename

 This sample demonstrates renaming a manged entity

 Parameters:
 url          [required] : url of the web service
 username     [required] : username for the authentication
 password     [required] : password for the authentication
 entityname   [required] : name of the inventory object - a managed entity
 newname      [required] : new name of the inventory object - a managed entity

 Command Line:
 Rename a virtual machine VM to new name VM2
 run.bat com.vmware.general --url [webserviceurl]
 --username [username] --password [password] --entityname VM
 --newname VM2

 Rename a resource pool named Rp to new name pool
 java com.vmware.general --url [webserviceurl]
 --username [username] --password [password] --entityname Rp
 --newname pool
 

Nested Class Summary

Nested classes/interfaces inherited from class com.vmware.connection.ConnectedVimServiceBase

ConnectedVimServiceBase.ConnectionException

Field Summary

Fields inherited from class com.vmware.connection.ConnectedVimServiceBase

PROP_ME_NAME, SVC_INST_NAME

Constructor Summary

Constructors

Constructor and Description
Rename()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getTaskResultAfterDone(com.vmware.vim25.ManagedObjectReference task) This method returns a boolean value specifying whether the Task is succeeded or failed.
void	rename()
void	setEntityname(java.lang.String entityname)
void	setNewentityname(java.lang.String newentityname)

Methods inherited from class com.vmware.connection.ConnectedVimServiceBase

basicConnectionFromConnection, connect, disconnect, getServiceInstanceReference, setConnection, setHostConnection

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Rename

public Rename()

Method Detail

setEntityname

@Option(name="entityname",
        description="name of the inventory object - a managed entity")
public void setEntityname(java.lang.String entityname)

setNewentityname

@Option(name="newname",
        description="new name of the inventory object - a managed entity")
public void setNewentityname(java.lang.String newentityname)

getTaskResultAfterDone

public boolean getTaskResultAfterDone(com.vmware.vim25.ManagedObjectReference task)
                               throws com.vmware.vim25.InvalidPropertyFaultMsg,
                                      com.vmware.vim25.RuntimeFaultFaultMsg,
                                      com.vmware.vim25.InvalidCollectorVersionFaultMsg

This method returns a boolean value specifying whether the Task is succeeded or failed.

Parameters:

task - ManagedObjectReference representing the Task.

Returns:

boolean value representing the Task result.

Throws:

com.vmware.vim25.InvalidCollectorVersionFaultMsg

com.vmware.vim25.RuntimeFaultFaultMsg

com.vmware.vim25.InvalidPropertyFaultMsg

rename

@Action
public void rename()
            throws com.vmware.vim25.DuplicateNameFaultMsg,
                   com.vmware.vim25.RuntimeFaultFaultMsg,
                   com.vmware.vim25.InvalidNameFaultMsg,
                   com.vmware.vim25.InvalidPropertyFaultMsg,
                   com.vmware.vim25.InvalidCollectorVersionFaultMsg

Throws:

com.vmware.vim25.DuplicateNameFaultMsg

com.vmware.vim25.RuntimeFaultFaultMsg

com.vmware.vim25.InvalidNameFaultMsg

com.vmware.vim25.InvalidPropertyFaultMsg

com.vmware.vim25.InvalidCollectorVersionFaultMsg