This API has a deprecated equivalent from v7.0U1.
Filter Library Item
Queries an OVF package stored in content library to retrieve information to use when deploying the package. See LibraryItem.deploy. This operation retrieves information from the descriptor of the OVF package stored in the library item specified by ovfLibraryItemId. The information returned by the operation can be used to populate the deployment specification (see LibraryItem.ResourcePoolDeploymentSpec when deploying the OVF package to the deployment target specified by target.
if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter ovfLibraryItemId requires System.Read. - The resource ResourcePool referenced by the attribute LibraryItem.DeploymentTarget.resource-pool-id requires System.Read. - The resource HostSystem referenced by the attribute LibraryItem.DeploymentTarget.host-id requires System.Read. - The resource Folder referenced by the attribute LibraryItem.DeploymentTarget.folder-id requires System.Read.
Request
URLURL
https://{api_host}/api/vcenter/ovf/library-item/{ovf_library_item_id}?action=filter
Path Parameters
Path Parameters
string
ovf_library_item_id
Required
Identifier of the content library item containing the OVF package to query. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
OvfLibraryItemFilterRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"target": {
"resource_pool_id": "string"
}
}
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
OvfLibraryItemOvfSummary
of type application/json
Information that can be used to populate the deployment specification (see LibraryItem.ResourcePoolDeploymentSpec) when deploying the OVF package to the deployment target specified by target.
{
"EULAs": [
"string"
],
"additional_params": {},
"annotation": "string",
"name": "string",
"networks": [
"string"
],
"storage_groups": [
"string"
]
}
array of
string
EULAs
Required
End User License Agreements specified in the OVF descriptor. All end user license agreements must be accepted in order for the LibraryItem.deploy operation to succeed. See LibraryItem.ResourcePoolDeploymentSpec.accept-all-eula.
array of
object
additional_params
Optional
Additional OVF parameters which can be specified for the deployment target. These OVF parameters can be inspected, optionally modified, and used as values in LibraryItem.ResourcePoolDeploymentSpec.additional-parameters for the LibraryItem.deploy operation. If unset, the OVF descriptor does not require addtional parameters or does not have additional parameters suitable for the deployment target. When clients pass a value of this structure as a parameter, the field must contain all the attributes defined in OvfParams. When operations return a value of this structure as a result, the field will contain all the attributes defined in OvfParams.
string
annotation
Optional
Default annotation for the virtual machine or virtual appliance. If unset, the OVF descriptor did not specify an annotation.
string
name
Optional
Default name for the virtual machine or virtual appliance. If unset, the OVF descriptor did not specify a name.
array of
string
networks
Optional
Section identifiers for sections of type ovf:NetworkSection in the OVF descriptor. These identifiers can be used as keys in LibraryItem.ResourcePoolDeploymentSpec.network-mappings. If unset, the OVF descriptor did not specify any networks.
array of
string
storage_groups
Optional
Section identifiers for sections of type vmw:StorageGroupSection in the OVF descriptor. These identifiers can be used as keys in LibraryItem.ResourcePoolDeploymentSpec.storage-mappings. If unset, the OVF descriptor did not specify any storage groups.
Errors
404
com.vmware.vapi.std.errors.not_found : if the library item specified by ovfLibraryItemId does not exist. if any resource specified by a field of the LibraryItem.DeploymentTarget structure, specified by target, does not exist.
500
com.vmware.vapi.std.errors.resource_inaccessible : if there was an error accessing the OVF package at the specified ovfLibraryItemId.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$OvfLibraryItemDeploymentTarget = Initialize-OvfLibraryItemDeploymentTarget -ResourcePoolId "MyResourcePoolId"
$OvfLibraryItemFilterRequestBody = Initialize-OvfLibraryItemFilterRequestBody -Target $OvfLibraryItemDeploymentTarget
Invoke-FilterOvfLibraryItemId -OvfLibraryItemId "MyOvfLibraryItemId" -OvfLibraryItemFilterRequestBody $OvfLibraryItemFilterRequestBody
PowerCLI Client SDK All Parameters Example
$OvfLibraryItemDeploymentTarget = Initialize-OvfLibraryItemDeploymentTarget -ResourcePoolId "MyResourcePoolId" -HostId "MyHostId" -FolderId "MyFolderId"
$OvfLibraryItemFilterRequestBody = Initialize-OvfLibraryItemFilterRequestBody -Target $OvfLibraryItemDeploymentTarget
Invoke-FilterOvfLibraryItemId -OvfLibraryItemId "MyOvfLibraryItemId" -OvfLibraryItemFilterRequestBody $OvfLibraryItemFilterRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"target":{"folder_id":"string","host_id":"string","resource_pool_id":"string"}}' https://{api_host}/api/vcenter/ovf/library-item/{ovf_library_item_id}?action=filter
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/com/vmware/vcenter/ovf/library-item/id:{ovf_library_item_id}?~action=filter
x-vmw-doc-operation: filter
Availability
Added in 7.0U2
