Service - ImageManagementAsset

Class: VMware.Hv.ImageManagementAsset
See also: ImageManagementAssetId, ImageManagementAssetInfo, ImageManagementAssetSpec, ImageManagementTagId, ImageManagementVersionId, MapEntry, VirtualCenterId
Since: Horizon 7.10

Service Description

The service interface for managing Image Management Assets.

Methods

Methods defined in this Service
ImageManagementAsset_CreateAssets, ImageManagementAsset_Delete, ImageManagementAsset_Get, ImageManagementAsset_GetByImageManagementTagAndVirtualCenter, ImageManagementAsset_ListByImageManagementVersion, ImageManagementAsset_Update

ImageManagementAsset_CreateAssets

Adds multiple image management assets.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global configuration management is required to create a image management asset.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ImageManagementAsset used to make the method call.
specs	ImageManagementAssetSpec[]	attributes needed to add multiple image management assets.

Return Value

Type	Description
ImageManagementAssetId[]	Array of entity ids of each image management asset.

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
PartialFailureFault	Thrown if all operations were not successful, a PartialFailureFault will be thrown indicating which assets were successfully added and which ones failed. The index of results in the PartialFailureFault correspond to the index of the original asset in the specs. The result entry will contain either the original return type (on success) or an exception (on failure).
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
VLSI_IM_ASSET_ADDED	For every image management asset successfully created.
VLSI_IM_ASSET_ADD_FAILED	For every image management asset that could not be created.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementAsset_CreateAssets" type="vdi:ImageManagementAsset_CreateAssetsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementAsset_CreateAssetsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ImageManagementAssetId" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

ImageManagementAsset_Delete

Delete an image management asset. Allowed only if the respective stream is not in use.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global configuration management is required to delete a image management asset.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ImageManagementAsset used to make the method call.
id	ImageManagementAssetId	entity id of the image management asset entry.

Return Value

Type	Description
None

Faults

Type	Description
EntityInUse	Thrown if a desktop/farm is associated with this image management asset.
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
VLSI_IM_ASSET_DELETED	If the image management asset was successfully deleted.
VLSI_IM_ASSET_DELETE_FAILED	If the image management asset could not be deleted.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementAsset_Delete" type="vdi:ImageManagementAsset_DeleteRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementAsset_DeleteResponse">
            <complexType/>
         </element>

ImageManagementAsset_Get

Gets the image management asset information (primarily the list of attributes about configured image management asset).

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global configuration view is required to get a image management asset.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ImageManagementAsset used to make the method call.
id	ImageManagementAssetId	entity id of the image management asset entry.

Return Value

Type	Description
ImageManagementAssetInfo	ImageManagementAssetInfo (attributes about configured Image Management Asset).

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementAsset_Get" type="vdi:ImageManagementAsset_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementAsset_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ImageManagementAssetInfo"/>
               </sequence>
            </complexType>
         </element>

ImageManagementAsset_GetByImageManagementTagAndVirtualCenter

Gets the image management asset information (primarily the list of attributes about configured image management asset) associated with image management tag and virtual center.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global configuration view is required to get a image management asset.
VC_CONFIG_VIEW	privilege is required to get a image management asset.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ImageManagementAsset used to make the method call.
imageManagementTag	ImageManagementTagId	entity id of the image management tag entry.
virtualCenter	VirtualCenterId	entity id of the virtual center entry.

Return Value

Type	Description
ImageManagementAssetInfo	ImageManagementAssetInfo (attributes about configured Image Management Asset).

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementAsset_GetByImageManagementTagAndVirtualCenter" type="vdi:ImageManagementAsset_GetByImageManagementTagAndVirtualCenterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementAsset_GetByImageManagementTagAndVirtualCenterResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ImageManagementAssetInfo"/>
               </sequence>
            </complexType>
         </element>

ImageManagementAsset_ListByImageManagementVersion

Gets list of image management assets for a given image management version.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global configuration view is required to list image management assets.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ImageManagementAsset used to make the method call.
imageManagementVersion	ImageManagementVersionId	entity id of the image management version.

Return Value

Type	Description
ImageManagementAssetInfo[]	list of image management assets

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementAsset_ListByImageManagementVersion" type="vdi:ImageManagementAsset_ListByImageManagementVersionRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementAsset_ListByImageManagementVersionResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ImageManagementAssetInfo" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

ImageManagementAsset_Update

Update image management asset with the set of attributes.

Privileges

Privilege	Description
GLOBAL_CONFIG_MANAGEMENT	Global configuration management is required to update a image management asset.

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the ImageManagementAsset used to make the method call.

ImageManagementAssetId

entity id of the image management asset entry.

updates

MapEntry[]

key value pairs describing attributes to be updated

This parameter is an update map based on ImageManagementAssetInfo.

Return Value

Type	Description
None

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
VLSI_IM_ASSET_UPDATED	If the image management asset was successfully updated.
VLSI_IM_ASSET_UPDATE_FAILED	If the image management asset could not be updated.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementAsset_Update" type="vdi:ImageManagementAsset_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementAsset_UpdateResponse">
            <complexType/>
         </element>