REST API - filter

vcenter ovf library item: filter

Queries an OVF package stored in content library to retrieve information to use when deploying the package. See deploy.

This operation retrieves information from the descriptor of the OVF package stored in the library item specified by ovf_library_item_id. The information returned by the operation can be used to populate the deployment specification (see vcenter.ovf.library_item.resource_pool_deployment_spec when deploying the OVF package to the deployment target specified by target.

Request:

HTTP request

POST https://{server}/rest/com/vmware/vcenter/ovf/library-item/id:{ovf_library_item_id}?~action=filter

Path Parameters

Name Type Description
Required
ovf_library_item_id string Identifier of the content library item containing the OVF package to query.

Request Body Structure:

{
    "target"{
        "resource_pool_id""obj-103",
        "folder_id""obj-103",
        "host_id""obj-103"
    }
}

Request Body Parameters:

Name Type Description
bold = required
target deployment_target Specification of the deployment target.
target.resource_pool_id string Identifier of the resource pool to which the virtual machine or virtual appliance should be attached.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ResourcePool. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ResourcePool.

target.host_id string Identifier of the target host on which the virtual machine or virtual appliance will run. The target host must be a member of the cluster that contains the resource pool identified by vcenter.ovf.library_item.deployment_target.resource_pool_id.

Optional. If unset, the server will automatically select a target host from the resource pool if vcenter.ovf.library_item.deployment_target.resource_pool_id is a stand-alone host or a cluster with Distributed Resource Scheduling (DRS) enabled.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the field will be an identifier for the resource type: HostSystem.

target.folder_id string Identifier of the vCenter folder that should contain the virtual machine or virtual appliance. The folder must be virtual machine folder.

Optional. If unset, the server will choose the deployment folder.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Folder. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Folder.

Response:

HTTP Status Code: 200

Representation:

{
    "value"{
        "annotation""string",
        "storage_groups"[
            "string",
            "string"
        ],
        "name""string",
        "EULAs"[
            "string",
            "string"
        ],
        "networks"[
            "string",
            "string"
        ],
        "additional_params"[
            {
                "@class""com.vmware.vcenter.ovf.ovf_params",
                "type""string"
            },
            {
                "@class""com.vmware.vcenter.ovf.ovf_params",
                "type""string"
            }
        ]
    }
}

Response Type:

Name Type Description
bold = required
value ovf_summary Information that can be used to populate the deployment specification (see vcenter.ovf.library_item.resource_pool_deployment_spec) when deploying the OVF package to the deployment target specified by target.
value.name string Default name for the virtual machine or virtual appliance.

Optional. If unset, the OVF descriptor did not specify a name.

value.annotation string Default annotation for the virtual machine or virtual appliance.

Optional. If unset, the OVF descriptor did not specify an annotation.

value.EULAs string[] End User License Agreements specified in the OVF descriptor. All end user license agreements must be accepted in order for the deploy operation to succeed. See vcenter.ovf.library_item.resource_pool_deployment_spec.accept_all_EULA.

value.networks string[] Section identifiers for sections of type ovf:NetworkSection in the OVF descriptor. These identifiers can be used as keys in vcenter.ovf.library_item.resource_pool_deployment_spec.network_mappings.

Optional. If unset, the OVF descriptor did not specify any networks.

value.storage_groups string[] Section identifiers for sections of type vmw:StorageGroupSection in the OVF descriptor. These identifiers can be used as keys in vcenter.ovf.library_item.resource_pool_deployment_spec.storage_mappings.

Optional. If unset, the OVF descriptor did not specify any storage groups.

value.additional_params object[] Additional OVF parameters which can be specified for the deployment target. These OVF parameters can be inspected, optionally modified, and used as values in vcenter.ovf.library_item.resource_pool_deployment_spec.additional_parameters for the deploy operation.

Optional. 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 vcenter.ovf.ovf_params. When operations return a value of this structure as a result, the field will contain all the attributes defined in vcenter.ovf.ovf_params.

value.additional_params.type string Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters structure.

This field must be provided in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.

Errors:

HTTP Status Code Type Description
400 invalid_argument if target contains invalid arguments.
404 not_found if the library item specified by ovf_library_item_id does not exist.
500 resource_inaccessible if there was an error accessing the OVF package at the specified ovf_library_item_id.