Service - ImageManagementStream

Class: VMware.Hv.ImageManagementStream
See also: ImageManagementStreamBase, ImageManagementStreamId, ImageManagementStreamInfo, ImageManagementStreamQuerySpec, MapEntry
Since: Horizon 7.10

Service Description

The service interface for managing Image Management Streams.

Methods

Methods defined in this Service
ImageManagementStream_CreateStreams, ImageManagementStream_Delete, ImageManagementStream_Get, ImageManagementStream_ListBySpec, ImageManagementStream_Update

ImageManagementStream_CreateStreams

Adds multiple image management streams.

Privileges

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

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ImageManagementStream used to make the method call.
bases	ImageManagementStreamBase[]	attributes needed to add multiple image management streams.

Return Value

Type	Description
ImageManagementStreamId[]	Array of entity ids of each image management stream.

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 streams were successfully added and which ones failed. The index of results in the PartialFailureFault correspond to the index of the original stream. 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_STREAM_ADDED	For every image management stream successfully created.
VLSI_IM_STREAM_ADD_FAILED	For every image management stream 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="ImageManagementStream_CreateStreams" type="vdi:ImageManagementStream_CreateStreamsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementStream_CreateStreamsResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ImageManagementStreamId" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

ImageManagementStream_Delete

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

Privileges

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

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ImageManagementStream used to make the method call.
id	ImageManagementStreamId	entity id of the image management stream entry.

Return Value

Type	Description
None

Faults

Type	Description
EntityInUse	Thrown if a desktop/farm is associated with this image management stream.
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_STREAM_DELETED	If the image management stream was successfully deleted.
VLSI_IM_STREAM_DELETE_FAILED	If the image management stream delete fails.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementStream_Delete" type="vdi:ImageManagementStream_DeleteRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementStream_DeleteResponse">
            <complexType/>
         </element>

ImageManagementStream_Get

Gets the image management stream information (primarily the list of attributes about configured image management stream). Requires at least one of the listed privileges.

Privileges

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

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ImageManagementStream used to make the method call.
id	ImageManagementStreamId	entity id of the image management stream entry.

Return Value

Type	Description
ImageManagementStreamInfo	ImageManagementStreamInfo (attributes about configured Image Management Stream).

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="ImageManagementStream_Get" type="vdi:ImageManagementStream_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementStream_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ImageManagementStreamInfo"/>
               </sequence>
            </complexType>
         </element>

ImageManagementStream_ListBySpec

Returns list of image management streams based on the spec. Requires at least one of the listed privileges.

Privileges

Privilege	Description
GLOBAL_CONFIG_VIEW	Global configuration view is required to list image management streams.
VC_CONFIG_VIEW	privilege is required to list image management streams.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ImageManagementStream used to make the method call.
spec	ImageManagementStreamQuerySpec	query spec for filtering image management stream.

Return Value

Type	Description
ImageManagementStreamInfo[]	list of image management streams.

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="ImageManagementStream_ListBySpec" type="vdi:ImageManagementStream_ListBySpecRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementStream_ListBySpecResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:ImageManagementStreamInfo" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

ImageManagementStream_Update

Update image management stream with the set of attributes.

Privileges

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

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

ImageManagementStreamId

entity id of the image management stream entry.

updates

MapEntry[]

key value pairs describing attributes to be updated

This parameter is an update map based on ImageManagementStreamInfo.

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_STREAM_UPDATED	If the image management stream was successfully updated.
VLSI_IM_STREAM_UPDATE_FAILED	If the image management stream update fails.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementStream_Update" type="vdi:ImageManagementStream_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="ImageManagementStream_UpdateResponse">
            <complexType/>
         </element>