DesktopPoolPushImageSpec

DesktopPoolPushImageSpec
DesktopPoolPushImageSpec

Information required to schedule push image operation on a desktop pool.

JSON Example
{
    "add_virtual_tpm": false,
    "im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
    "im_tag_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
    "logoff_policy": "WAIT_FOR_LOGOFF",
    "parent_vm_id": "vm-1",
    "snapshot_id": "snapshot-1",
    "start_time": 1587081283000,
    "stop_on_first_error": true
}
boolean
add_virtual_tpm
Optional

Indicates whether to add Virtual TPM device. Default: false

string
im_stream_id
Optional

New image management stream for the desktop pool.
Either parent VM and snapshot or image management stream and tag are to be specified.

string
im_tag_id
Optional

New image management tag for the desktop pool. This must be a tag of the image management stream.

string
logoff_policy
Required

Determines when to perform the operation on machines which have an active session.

  • FORCE_LOGOFF: Users will be forced to log off when the system is ready to execute the operation. Before being forcibly logged off, users may have a grace period in which to save their work which can be configured in Global Settings.
  • WAIT_FOR_LOGOFF: Wait for connected users to disconnect before the task starts. The operation starts immediately when there are no active sessions.
Possible values are : FORCE_LOGOFF, WAIT_FOR_LOGOFF,
string
parent_vm_id
Optional

New base image virtual machine for the desktop pool. This must be in the same datacenter as the base image of the desktop pool.
Either parent VM and snapshot or image management stream and tag are to be specified.

string
snapshot_id
Optional

New base image snapshot for the desktop pool. This must be a snapshot of the parent VM.

integer As int64 As int64
start_time
Optional

When to start the operation. If unset or the time is in the past, the operation will begin immediately. Measured as epoch time.

boolean
stop_on_first_error
Optional

Indicates that the operation should stop on first error. Default: true