Update IM Stream | VMware Horizon Server API

Update IM Stream

Updates image management stream.

Request

URI

PUT

https://{api_host}//localhost/rest/config/v1/im-streams/{id}

COPY

Path Parameters

string

Required

Request Body

Image management stream object to be updated.

ImageManagementStreamUpdateSpec of type(s) application/json

Required

{
    "description": "Windows 10 Stream",
    "name": "Win10",
    "operating_system": "WINDOWS_10",
    "publisher": "VMware",
    "source": "MARKET_PLACE",
    "status": "AVAILABLE"
}

object

additional_details

Optional

Additional details about image management stream.

string

description

Optional

Image management stream description.

string

name

Required

Image management stream name.

string

operating_system

Required

Operating system.

UNKNOWN: Unknown
WINDOWS_XP: Windows XP
WINDOWS_VISTA: Windows Vista
WINDOWS_7: Windows 7
WINDOWS_8: Windows 8
WINDOWS_10: Windows 10
WINDOWS_SERVER_2003: Windows Server 2003
WINDOWS_SERVER_2008: Windows Server 2008
WINDOWS_SERVER_2008_R2: Windows Server 2008 R2
WINDOWS_SERVER_2012: Windows Server 2012
WINDOWS_SERVER_2012_R2: Windows Server 2012 R2
WINDOWS_SERVER_2016_OR_ABOVE: Windows Server 2016 or above
LINUX_OTHER: Linux (other)
LINUX_SERVER_OTHER: Linux server (other)
LINUX_UBUNTU: Linux (Ubuntu)
LINUX_RHEL: Linux (Red Hat Enterprise)
LINUX_SUSE: Linux (Suse)
LINUX_CENTOS: Linux (CentOS)

Possible values are : UNKNOWN, WINDOWS_XP, WINDOWS_VISTA, WINDOWS_7, WINDOWS_8, WINDOWS_10, WINDOWS_SERVER_2003, WINDOWS_SERVER_2008, WINDOWS_SERVER_2008_R2, WINDOWS_SERVER_2012, WINDOWS_SERVER_2012_R2, WINDOWS_SERVER_2016_OR_ABOVE, LINUX_OTHER, LINUX_SERVER_OTHER, LINUX_UBUNTU, LINUX_RHEL, LINUX_SUSE, LINUX_CENTOS,

string

publisher

Optional

Image management stream publisher

string

source

Required

Image management stream source.

MARKET_PLACE: Image management stream is from market place.
UPLOADED: Image management stream is uploaded.
COPIED_FROM_STREAM: Image management stream is copied from another stream.
COPIED_FROM_VERSION: Image management stream is copied from a version.

Possible values are : MARKET_PLACE, UPLOADED, COPIED_FROM_STREAM, COPIED_FROM_VERSION,

string

status

Required

Image management stream status.

AVAILABLE: Image management stream is available for desktop pools/farms to be created.
DELETED: Image management stream is deleted.
DISABLED: Image management stream is disabled and no further desktop pools/farms can be created using the same.
FAILED: Image management stream creation has failed.
IN_PROGRESS: Image management stream creation is in progress.
PARTIALLY_AVAILABLE: Image management version for this stream could not be created in one or more environments.
PENDING: Image management stream is in pending state.