Bug 1430559

Summary: [Docs] [RFE] [REST] Add an example of how to perform a partial import of a virtual machine
Product: Red Hat Enterprise Virtualization Manager Reporter: Andrew Dahms <adahms>
Component: DocumentationAssignee: rhev-docs <rhev-docs>
Status: CLOSED CURRENTRELEASE QA Contact: rhev-docs <rhev-docs>
Severity: medium Docs Contact:
Priority: medium    
Version: 4.1.0CC: gklein, lbopf, lsurette, rbalakri, srevivo, ykaul
Target Milestone: ovirt-4.1.1-1Keywords: FutureFeature
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-04-10 06:24:12 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: Docs RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On: 1380365    
Bug Blocks:    

Description Andrew Dahms 2017-03-09 00:05:42 UTC
In Red Hat Virtualization 4.1, it is now possible to perform a 'partial' import of a virtual machine via the REST API, whereby a virtual machine can be imported even if its disks are not all available.

The 'StorageDomainVm' section of the REST API Guide must be updated to include this new option.

See the following for an example of the whole command -

POST /api/storagedomains/xxxxxxx-xxxx-xxxx-xxxxxx/vms/xxxxxxx-xxxx-xxxx-xxxxxx/register HTTP/1.1
Accept: application/xml
Content-type: application/xml

<action>
    <cluster id='bf5a9e9e-5b52-4b0d-aeba-4ee4493f1072'></cluster>
    <allow_partial_import>true</allow_partial_import>
</action>

Comment 1 Lucy Bopf 2017-04-10 06:24:12 UTC
Looks like this has been covered in the in-code REST API documentation, and is published here:

https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.1/html/rest_api_guide/services#services-storage_domain_vm-methods-register

Although there is no explicit example included, the description is fairly explanatory, so I'm moving this one to CLOSED.