Remove Hard Disk operation

The Remove Hard Disk operation removes the specified hard disk from a virtual machine.

The following table describes the elements for this request.

Adapter request elements for the Remove Hard Disk operation

Element

Definition

Required

<operation-type>

Defines the type of the operation: Configure_Vm

Yes

<operation-name>

Defines the name of operation: Remove_Hard_Disk

Yes

<soap-url>

Specifies the URL for the remote SOAP service running on the VMware VirtualCenter

If the <soap-url> element is not specified, the request uses the VirtualCenter Server details specified in the adapter configuration.

Default format for HTTPS: https://<hostName>:<port>/sdk/vim

Default format for HTTP: http://<hostName>:<port>/sdk/vim

Note

If you want to use an HTTP value, you might need to change the configuration of the VMware Infrastructure application.

Specifies the transport protocol for the message

If the <transport> element is not provided, the request uses the VirtualCenter Server details specified in the adapter configuration.

Valid values: https-rpc (default), http-rpc

Note

If the value of the <transport> element is https-rpc, you must install the security certificate for the VMware Virtual Center to the keystore of the peer on which the adapter is enabled.

<user-name>

Specifies the user name that is used for HTTP basic authentication on the VMware Virtual Center

If no user name is specified, the request is executed with the user name that is specified in the configuration.

Specifies the password corresponding to <user-name>

Conditional; required if <user-name> is specified

Contains the element required to execute the operation

Yes

<virtual-machine>

Contains the name of the virtual machine from which the specified hard disk is to be removed

Yes

<device-change-list>

Specifies the set of virtual disks to be removed by the configuration operation

Value takes the form:

<device-change-list>
   <device-change>
      <device type="VirtualDisk">
          <disk-name></disk-name>
          <disk-key></disk-key>
     </device>
   </device-change>
</device-change-list>

<disk-name>: Specifies the name of the hard disk to be removed
<disk-key>: Specifies the numeric key of the hard disk to be removed

Note

You must specify either <disk-name> or <disk-key> element. If you specify both the <disk-name and the <disk-key> elements, then the adapter only considers the <disk-key> element.

Yes

The following code sample shows a sample adapter request for the Remove Hard Disk operation.

Sample adapter request for the Remove Hard Disk operation

<vmware-infrastructure-request>
    <operation-type>Configure_Vm</operation-type>
    <operation-name>Remove_Hard_Disk</operation-name>
   <soap-url></soap-url>
   <transport></transport>
    <user-name></user-name>
    <password></password>
    <parameters>
        <virtual-machine>TestDev</virtual-machine>
            <spec>
                <device-change-list>
                    <device-change>
                        <device type="VirtualDisk">
                            <disk-name>Hard Disk 1</disk-name>
                           <disk-key>2005</disk-key>
                        </device>
                    </device-change>
                </device-change-list>
            </spec>
    </parameters>
</vmware-infrastructure-request>

The following code sample shows the response for the sample Remove Hard Disk operation.

Sample adapter response for the Remove Hard Disk operation

<vmware-infrastructure-response>
    <metadata>
        <status>success</status>
    </metadata>
    <RemoveHardDiskResponse>
        <Task>task-726</Task>
    </RemoveHardDiskResponse>
</vmware-infrastructure-response>

The following table describes the response element.

Adapter response element for the Remove Hard Disk operation

Element	Definition
<Task>	Specifies the task ID of the submitted task Use the task ID to obtain the status of the specified task. For information about using the task ID to check the task status, see Request and response for the Retrieve_Task_Status operation.

Remove Hard Disk operation

On this page