Create IM Asset | VMware Horizon Server API

Create IM Asset

All the listed privileges are required -

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

Request

URI

POST

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

COPY

Request Body

Image management asset object to be created.

ImageManagementAssetCreateSpec of type(s) application/json

Required

{
    "base_snapshot_id": "snapshot-1",
    "base_vm_id": "vm-2",
    "clone_type": "INSTANT_CLONE",
    "im_stream_id": "abc16e8f-9ba0-4789-a5dd-6880f32c52df",
    "im_version_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
    "image_type": "RDSH_APPS",
    "status": "AVAILABLE",
    "vcenter_id": "f148f3e8-db0e-4abb-9c33-7e5205ccd360",
    "vm_template_id": "vm-1"
}

object

additional_details

Optional

Additional details about image management asset.

string

base_snapshot_id

Optional

Virtual machine snapshot. Must be set if vm_template_id is unset.

string

base_vm_id

Optional

Virtual machine ID. Must be set if vm_template_id is unset.

string

clone_type

Required

Image management asset clone type.

FULL_CLONE: Image management asset to be used in full clone automated desktop pool.
INSTANT_CLONE: Image management asset to be used in instant clone desktop pool/farm.

Possible values are : FULL_CLONE, INSTANT_CLONE,

string

im_stream_id

Required

Image management stream to which this asset belongs to.

string

im_version_id

Required

Image management version to which this asset belongs to.

string

image_type

Required

Image management asset image type.

RDSH_APPS: Image management asset to be used for farm creation which is be used in application.
RDSH_DESKTOP: Image management asset is for farm creation to be created.
VDI_DESKTOP: Image management asset is available for desktops/farms to be created.

Possible values are : RDSH_APPS, RDSH_DESKTOP, VDI_DESKTOP,

string

status

Required

Image management asset status.

AVAILABLE: Image management asset is available for desktop pools/farms to be created.
DEPLOYING_VM: Image management asset is deploying VM on the virtual center.
DEPLOYMENT_DONE: Image management asset VM deployed on the virtual center.
DELETED: Image management asset has been deleted.
DISABLED: Image management asset has been disabled and no further pool/farm operation can be done using the same.
FAILED: Image management asset creation has failed.
REPLICATING: Copying the specialized images across all virtual centers.
RETRY_PENDING: When image management asset creation has failed, retry action is pending for asset to be created.
SPECIALIZING_VM: Image management asset is being published and specialized internally like installing agents etc.