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
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
Return Value
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
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
Return Value
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
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
Return Value
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
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
Return Value
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
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
Return Value
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
© 2020 VMware, Inc. All rights reserved.
Revision Jun-2020 Version 8.0.0