Reset vApp operation


The Reset vApp operation enables you to reset the vApp.

The following figure shows a sample <items> XML element for the Reset vApp operation:

Sample <items> XML element for the Reset vApp operation

<items>
 <item>
   <parameters>
     <vapp-id></vapp-id>
   </parameters>
 </item>
</items>

The following table describes the elements for this adapter request:

Adapter request elements for the Reset vApp operation

Element

Definition

Required

<operation-name>

Defines the type of operation: Reset_vApp

Yes

<vcloud-organization>

Specifies the name of the vCloud organization

Conditional:

  • Required if not specified in the configuration
  • If used, requires <user-name> and <password>
<user-name>

Specifies the user name required for basic HTTP authentication on vCloud

Conditional:

  • Required if not specified in the configuration
  • If used, requires <vcloud-organization> and <password>
<password>

Contains the password corresponding to the specified user name

Conditional:

  • Required if not specified in the configuration
  • If used, requires <vcloud-organization> and <user-name>
<parameters>

Contains the elements for the operation

Yes

<vapp-id>

Specifies the ID corresponding to the vApp that you want to reset
Valid value: Any string

Yes

The following figure shows the sample adapter request for the Reset vApp operation:

Sample adapter request for the Reset vApp operation

<vmware-vcloud-request>
 <operation-name>Reset_vApp</operation-name>
 <vcloud-organization>TestOrg</vcloud-organization>
 <user-name>TestUser</user-name>
 <password>Password</password>
 <parameters>
   <vapp-id>vapp-451028474</vapp-id>
 </parameters>
</vmware-vcloud-request>

The following figure shows the response for the sample adapter request:

Sample adapter response for the Reset vApp operation

<vmware-vcloud-response>
 <metadata>
  /code>
   <reason>Accepted</reason>
 </status-line>
 <message-body>
   <Task status="running" startTime="2010-11-23T17:23:13.333+05:30"
operation="Resetting Virtual Application (451028474)" expiryTime="
2011-02-21T17:23:13.333+05:30"
endTime="9999-12-31T23:59:59.999+05:30"
type="application/vnd.vmware.vcloud.task+xml" href="https://10.128.248
.112/api/v1.0/task/3nq5jeq6kf6k92t24qd"
>
     <Owner type="application/vnd.vmware.vcloud.vApp+xml" name=""
href="https://10.128.248.112/api/v1.0/vApp/vapp-451028474" />
   </Task>
 </message-body>
</vmware-vcloud-response>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*