Get IM Stream | VMware Horizon Server API

Get IM Stream

At least one of the listed privileges is required -

Privileges	Description
GLOBAL_CONFIG_VIEW	Caller should have permission to this privilege, to perform this operation.
VC_CONFIG_VIEW	Caller should have permission to this privilege, to perform this operation.

Request

URI

GET

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

COPY

Path Parameters

string

Required

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns ImageManagementStreamInfo of type(s) */*

{
    "description": "Windows 10 Stream",
    "id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
    "name": "Win10",
    "operating_system": "WINDOWS_10",
    "publisher": "VMware",
    "source": "MARKET_PLACE",
    "status": "AVAILABLE",
    "usable": true
}

object

additional_details

Optional

Additional details about image management stream.

string

description

Optional

Image management stream description. This property can be used for sorting.

string

Optional

Unique ID representing image management stream. Supported Filters: 'Equals'.

string

name

Optional

Image management stream name. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.

string

operating_system

Optional

Operating system. Supported Filters: 'Equals'. This property can be used for sorting.

LINUX_CENTOS: Linux (CentOS)
LINUX_OTHER: Linux (other)
LINUX_RHEL: Linux (Red Hat Enterprise)
LINUX_SERVER_OTHER: Linux server (other)
LINUX_SUSE: Linux (Suse)
LINUX_UBUNTU: Linux (Ubuntu)
UNKNOWN: Unknown
WINDOWS_10: Windows 10
WINDOWS_11: Windows 11
WINDOWS_7: Windows 7
WINDOWS_8: Windows 8
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
WINDOWS_VISTA: Windows Vista
WINDOWS_XP: Windows XP

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

string

publisher

Optional

Image management stream publisher. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.

string

source

Optional

Image management stream source. Supported Filters: 'Equals'. This property can be used for sorting.

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

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

string

status

Optional

Image management stream status. Supported Filters: 'Equals'. This property can be used for sorting.

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.

Possible values are : AVAILABLE, DELETED, DISABLED, FAILED, IN_PROGRESS, PARTIALLY_AVAILABLE, PENDING,

boolean

usable

Optional

Specifies whether the image management stream can be used in desktop pool or farm. This will be set to true when:

Image management stream is in AVAILABLE or PARTIALLY_AVAILABLE state.
There is at least one image management version in AVAILABLE or PARTIALLY_AVAILABLE state for this stream.
There is at least one image management tag associated with the image management version.

For a specific virtual center, image management tag information will be retrieved. This property can be used for sorting.

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page

Description