DesktopPoolPushImageSpecV2

DesktopPoolPushImageSpecV2
DesktopPoolPushImageSpecV2

Specification for the push image operation.

JSON Example
{
    "add_virtual_tpm": false,
    "compute_profile_num_cores_per_socket": 1,
    "compute_profile_num_cpus": 4,
    "compute_profile_ram_mb": 4096,
    "im_stream_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
    "im_tag_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
    "logoff_policy": "WAIT_FOR_LOGOFF",
    "machine_ids": [
        "816d44cb-b486-3c97-adcb-cf3806d53657",
        "414927f3-1a3b-3e4c-81b3-d39602f634dc"
    ],
    "parent_vm_id": "vm-1",
    "selective_push_image": true,
    "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

integer As int32 As int32
compute_profile_num_cores_per_socket
Optional

Indicates the number of cores per socket for the CPU in the compute profile to be configured on clones. If set, both compute_profile_num_cpus and compute_profile_ram_mb need to be set.

integer As int32 As int32
compute_profile_num_cpus
Optional

Indicates the number of CPUs in the compute profile to be configured on clones. If set, this must be a multiple of compute_profile_num_cores_per_socket.

integer As int32 As int32
compute_profile_ram_mb
Optional

Indicates the RAM in MB in the compute profile to be configured on clones.

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,
array of string
machine_ids
Optional

Set of machines from the desktop pool on which the new image is to be applied. This can be set when selective_push_image is set to true.

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.

boolean
selective_push_image
Optional

Indicates whether selective push image is to be applied. If set to true, the new image will be applied to specified machine_ids in the desktop pool. The image published with this option will be held as a pending image, unless it is promoted or cancelled. The default value is false.

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