Perform Operation

• Dt Virtual Machine

Request

URI

POST

https://{api_host}/dt-rest/v100/infrastructure/vm/{id}/perform/{operation}

COPY

Path Parameters

string

operation

Required

operation

Possible values are : POWERON, POWEROFF, RESET, SUSPEND, REBOOT, STANDBY, SHUTDOWN,

---

Request Body

DtVirtualMachineImpl of type(s) application/json

Optional

{
    "id": "string",
    "dataModel": {
        "vmId": "string",
        "name": "string",
        "ipAddress": "string",
        "externalIpAddress": "string",
        "macAddress": "string",
        "inventoryPath": "string",
        "vmPath": "string",
        "powerState": "string",
        "lifeState": "string",
        "lifeStateDate": "string",
        "type": "string",
        "description": "string",
        "templateId": "string",
        "patternId": "string",
        "numCPUs": 0,
        "dnsName": "string",
        "viewAgentVersion": "string",
        "goldPatternVersion": 0,
        "vmOsLicenseType": "string",
        "currentCpuUsage": 0,
        "maxCpuUsage": 0,
        "memSizeMB": 0,
        "hostId": "string",
        "consoleLink": "string",
        "operatingSystem": "string",
        "vcUrl": "string",
        "guestOSState": "string",
        "allocatedState": "string",
        "toolsState": "string",
        "agentState": "string",
        "agentErrorCode": "string",
        "agentVersion": "string",
        "daasAgentVersion": "string",
        "toolsVersion": "string",
        "toolsVersionStatus2": "string",
        "pcoipCommPort": "string",
        "networkId": "string",
        "hardwareVersion": "string",
        "threeDEnabled": false,
        "hotplugEnabled": false,
        "agentValidationReq": false,
        "sessionAllocationState": "string",
        "useJms": false,
        "resyncState": "string",
        "customizationState": "string",
        "getvGPU": "string",
        "sealDate": "string",
        "powerOnDate": "string",
        "refId": "string",
        "poolName": "string",
        "desktopManagerName": "string",
        "rectify": false,
        "isConvertToTemplate": "string",
        "ngvc": false,
        "agentPairingAcknowledged": false
    },
    "DtVirtualMachineState": "string",
    "type": "string",
    "description": "string",
    "vmId": "string",
    "numCPUs": 0,
    "patternId": "string",
    "templateId": "string",
    "vmPath": "string",
    "inventoryPath": "string",
    "ipAddress": "string",
    "externalIpAddress": "string",
    "refId": "string",
    "vmpowerState": "string",
    "vmlifeState": "string",
    "vmlifeStateDate": "string",
    "threeDEnabled": false,
    "hotplugEnabled": false,
    "vmhardwareVersion": "string",
    "networkId": "string",
    "daaSAgentVersion": "string",
    "daaSAgentState": "string",
    "vmwareToolsState": "string",
    "guestOS": "string",
    "computePoolId": "string",
    "memorySizeMB": 0,
    "goldPatternVersion": 0,
    "powerOnDate": "string",
    "sealDate": "string",
    "poolName": "string",
    "macAddress": "string",
    "desktopManagerName": "string",
    "viewAgentVersion": "string",
    "dnsName": "string",
    "viewAgentPaired": false,
    "agentPairingAcknowledged": false,
    "allocateState": "string",
    "resyncState": "string",
    "customizationState": "string",
    "agentErrorCode": "string",
    "sessionAllocationState": "string",
    "rectify": false,
    "name": "string",
    "location": "string",
    "DtLink": [
        {
            "href": "string",
            "rel": "string",
            "deprecated": false,
            "name": "string",
            "method": "string"
        }
    ]
}

string

id

Optional

id

VirtualMachine

dataModel

Optional

dataModel

string

DtVirtualMachineState

Required

Virtual Machine State

Possible values are : Success, Pending, Failed, Incomplete,

string

type

Optional

type

string

description

Optional

description

string

vmId

Optional

vmId

integer As int32 As int32

numCPUs

Optional

numCPUs

string

patternId

Optional

patternId

string

templateId

Optional

templateId

string

vmPath

Optional

vmPath

string

inventoryPath

Optional

inventoryPath

string

ipAddress

Optional

ipAddress

string

externalIpAddress

Optional

externalIpAddress

string

refId

Optional

refId

string

vmpowerState

Optional

vmpowerState

Possible values are : POWERED_ON, POWERED_OFF, SUSPENDED, POWER_STATE_POWERING_ON, POWER_STATE_POWERING_OFF, POWER_STATE_RESETTING, POWER_STATE_SUSPENDING,

string

vmlifeState

Optional

vmlifeState

Possible values are : CLONING, CLONE_FAILED, PREPARING, JOINING_DOMAIN, IN_DOMAIN, NOT_IN_DOMAIN, STARTING, READY, UNKNOWN, OFF, DESTROYING, INCOMPLETE,

string As date-time As date-time

vmlifeStateDate

Optional

vmlifeStateDate

boolean

threeDEnabled

Optional

threeDEnabled

boolean

hotplugEnabled

Optional

hotplugEnabled

string

vmhardwareVersion

Optional

vmhardwareVersion

string

networkId

Optional

networkId

string

daaSAgentVersion

Optional

daaSAgentVersion

string

daaSAgentState

Optional

daaSAgentState

Possible values are : ACTIVE, INACTIVE, UNKNOWN, NOT_PAIRED, DISABLED, DRAINING, DRAINING_UNTIL_RESTART,

string

vmwareToolsState

Optional

vmwareToolsState

Possible values are : UNKNOWN, NOT_RUNNING, OUT_OF_DATE, NOT_INSTALLED, OK,

string

guestOS

Optional

guestOS

Possible values are : LINUX_32, LINUX_64, OTHER, UBUNTU_32, UBUNTU_64, WIN_XP, WIN_VISTA, WIN_7, WIN_7_64, WIN_8, WIN_8_64, WIN_10, WIN_10_64, WIN_SERVER_2K8R2_64, WIN_SERVER_2K12_64, DAAS_APPLIANCE, WIN_SERVER_2K16_64, WIN_SERVER_2K19_64, WINDOWS, WIN_10_WVD_64,

string

computePoolId

Optional

computePoolId

integer As int32 As int32

memorySizeMB

Optional

memorySizeMB

integer As int64 As int64

goldPatternVersion

Optional

goldPatternVersion

string As date-time As date-time

powerOnDate

Optional

powerOnDate

string As date-time As date-time

sealDate

Optional

sealDate

string

poolName

Optional

poolName

string

macAddress

Optional

macAddress

string

desktopManagerName

Optional

desktopManagerName

string

viewAgentVersion

Optional

viewAgentVersion

string

dnsName

Optional

dnsName

boolean

viewAgentPaired

Optional

viewAgentPaired

boolean

agentPairingAcknowledged

Optional

agentPairingAcknowledged

string

allocateState

Optional

allocateState

string

resyncState

Optional

resyncState

string

customizationState

Optional

customizationState

string

agentErrorCode

Optional

agentErrorCode

string

sessionAllocationState

Optional

sessionAllocationState

boolean

rectify

Optional

rectify

string

name

Optional

name

string

location

Optional

location

array of DtLink

DtLink

Optional

DtLink

Responses

200

Hide Details

successful operation

Returns DtVirtualMachine of type(s) */*

{
    "DtVirtualMachineState": "string",
    "type": "string",
    "description": "string",
    "vmId": "string",
    "numCPUs": 0,
    "patternId": "string",
    "templateId": "string",
    "vmPath": "string",
    "inventoryPath": "string",
    "ipAddress": "string",
    "externalIpAddress": "string",
    "refId": "string",
    "vmpowerState": "string",
    "vmlifeState": "string",
    "vmlifeStateDate": "string",
    "threeDEnabled": false,
    "hotplugEnabled": false,
    "vmhardwareVersion": "string",
    "networkId": "string",
    "daaSAgentVersion": "string",
    "daaSAgentState": "string",
    "vmwareToolsState": "string",
    "guestOS": "string",
    "computePoolId": "string",
    "memorySizeMB": 0,
    "goldPatternVersion": 0,
    "powerOnDate": "string",
    "sealDate": "string",
    "poolName": "string",
    "macAddress": "string",
    "desktopManagerName": "string",
    "viewAgentVersion": "string",
    "dnsName": "string",
    "viewAgentPaired": false,
    "agentPairingAcknowledged": false,
    "allocateState": "string",
    "resyncState": "string",
    "customizationState": "string",
    "agentErrorCode": "string",
    "sessionAllocationState": "string",
    "rectify": false,
    "name": "string",
    "id": "string",
    "links": [
        {
            "href": "string",
            "rel": "string",
            "deprecated": false,
            "name": "string",
            "method": "string"
        }
    ]
}

string

DtVirtualMachineState

Required

Virtual Machine State

Possible values are : Success, Pending, Failed, Incomplete,

string

type

Optional

type

string

description

Optional

description

string

vmId

Optional

vmId

integer As int32 As int32

numCPUs

Optional

numCPUs

string

patternId

Optional

patternId

string

templateId

Optional

templateId

string

vmPath

Optional

vmPath

string

inventoryPath

Optional

inventoryPath

string

ipAddress

Optional

ipAddress

string

externalIpAddress

Optional

externalIpAddress

string

refId

Optional

refId

string

vmpowerState

Optional

vmpowerState

Possible values are : POWERED_ON, POWERED_OFF, SUSPENDED, POWER_STATE_POWERING_ON, POWER_STATE_POWERING_OFF, POWER_STATE_RESETTING, POWER_STATE_SUSPENDING,

string

vmlifeState

Optional

vmlifeState

Possible values are : CLONING, CLONE_FAILED, PREPARING, JOINING_DOMAIN, IN_DOMAIN, NOT_IN_DOMAIN, STARTING, READY, UNKNOWN, OFF, DESTROYING, INCOMPLETE,

string As date-time As date-time

vmlifeStateDate

Optional

vmlifeStateDate

boolean

threeDEnabled

Optional

threeDEnabled

boolean

hotplugEnabled

Optional

hotplugEnabled

string

vmhardwareVersion

Optional

vmhardwareVersion

string

networkId

Optional

networkId

string

daaSAgentVersion

Optional

daaSAgentVersion

string

daaSAgentState

Optional

daaSAgentState

Possible values are : ACTIVE, INACTIVE, UNKNOWN, NOT_PAIRED, DISABLED, DRAINING, DRAINING_UNTIL_RESTART,

string

vmwareToolsState

Optional

vmwareToolsState

Possible values are : UNKNOWN, NOT_RUNNING, OUT_OF_DATE, NOT_INSTALLED, OK,

string

guestOS

Optional

guestOS

Possible values are : LINUX_32, LINUX_64, OTHER, UBUNTU_32, UBUNTU_64, WIN_XP, WIN_VISTA, WIN_7, WIN_7_64, WIN_8, WIN_8_64, WIN_10, WIN_10_64, WIN_SERVER_2K8R2_64, WIN_SERVER_2K12_64, DAAS_APPLIANCE, WIN_SERVER_2K16_64, WIN_SERVER_2K19_64, WINDOWS, WIN_10_WVD_64,

string

computePoolId

Optional

computePoolId

integer As int32 As int32

memorySizeMB

Optional

memorySizeMB

integer As int64 As int64

goldPatternVersion

Optional

goldPatternVersion

string As date-time As date-time

powerOnDate

Optional

powerOnDate

string As date-time As date-time

sealDate

Optional

sealDate

string

poolName

Optional

poolName

string

macAddress

Optional

macAddress

string

desktopManagerName

Optional

desktopManagerName

string

viewAgentVersion

Optional

viewAgentVersion

string

dnsName

Optional

dnsName

boolean

viewAgentPaired

Optional

viewAgentPaired

boolean

agentPairingAcknowledged

Optional

agentPairingAcknowledged

string

allocateState

Optional

allocateState

string

resyncState

Optional

resyncState

string

customizationState

Optional

customizationState

string

agentErrorCode

Optional

agentErrorCode

string

sessionAllocationState

Optional

sessionAllocationState

boolean

rectify

Optional

rectify

string

name

Optional

name

string

id

Optional

id

array of DtLink

links

Optional

links

On This Page

Request

Path Parameters

Request Body

Response

200 Response Body

Dt Virtual Machine Operations

DELETE

Delete

GET

Get

GET

Get GP Name

POST

Perform Operation

POST

Update