| Cloud Admin | Enterprise Admin | User |
|---|---|---|
 |
 |
|
Contents:
OVF Packages are virtual appliances templates definitions defined asOVF Envelope documents.
The current model capture single VirtualSystemType descriptions based on one VirtualDiskDescription.
OVF Package Data Model
Product Section of the software instaled on the OVF.
| Field Name | Type | Occurs | Required | Description |
|---|---|---|---|---|
| productName | String | 1 | true | The name of the OVF |
| categoryName | String | 1 | optional | The category tag for the OVF Package |
| iconPath | String | 1 | optional | The source icon url |
| productUrl | String | 1 | optional | The product url of the OVF Package |
| productVersion | String | 1 | optional | The product verison |
| productVendor | String | 1 | optional | The product vendor |
| ovfPackageDiskFormatTypeUri | Enum | 1 | true | The virtual disk file format type localizer |
| url | Link | 1 | true | Link to the source url of the .ovf file |
| edit | Link | 1 | true | Link to the url for edit the resource |
Methods related to OVF Package Resource
Retrieve a list of OVF Package.
This method retrieves all the OVF Packages on the Datacenter's AppsLibrary for a given enterprise, including those the being used a OVFPackageList.
Synopsis: GET http://{$hostIp}/api/admin/enterprises/{$enterpriseId}/appslib/ovfpackages
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request Message Body: N/A.
Example Request: Retrieve a list of OVF Packages.
Response Headers: Content-Length, Content-Type.
Response Message Body: OVFPackage.
Response Status: 200, 401, 403.
Example Response: Response of the GET over OVFPackages
Create a new OVF Package
Synopsis: POST http://{$hostIp}/api/admin/enterprises/{$enterpriseId}/appslib/ovfpackages
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request Message Body: OVFPackage.
Request example: Create new OVF Package
Response Headers: Content-Length, Content-Type, Location.
Response Message Body: URI.
Response Status: 201, 400, 401, 403.
Response example: The creation response
Retrieve an OVF Package
Synopsis: GET http://{$hostIp}/api/admin/enterprises/{$enterpriseId}/appslib/ovfpackages/{$ovfPackageId}
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request Message Body: N/A.
Example Request: Retrieve information about an OVF Package.
Response Headers: Content-Length, Content-Type.
Response Message Body: OVFPackage
Response Status: 200, 401, 403.
Example Response: Response of the GET over an OVF Package
Delete an OVF Package
If the current OVF Package is being used on some OVFPackageList the list is updated to exclude the OVF package.
Synopsis: DELETE http://{$hostIp}/api/admin/enterprises/{$enterpriseId}/appslib/ovfpackages/{$ovfPackageId}
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request Message Body: N/A.
Example Request: Delete an OVF Package entity.
Response Headers: Content-Length, Content-Type.
Response Message Body: N/A.
Response Status: 200, 401, 403, 409
Example Response: Response of the deletion
