Perform Pool Batch Power Operation

Perform Pool Batch Power Operation
Request
URI
POST
https://{api_host}/dt-rest/v100/pool/manager/{poolId}/vms/perform/{operation}
COPY
Path Parameters
string
poolId
Required

poolId

string
operation
Required

operation

Possible values are : POWERON, POWEROFF, RESET, SUSPEND, REBOOT, STANDBY, SHUTDOWN,
Request Body
Array of 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"
            }
        ]
    }
]
Responses
200
Returns DtPoolTask of type(s) */* 
"DtPoolTask Object"
string
type
Optional

type

string
agentVersion
Optional

agentVersion

string
vmName
Optional

vmName

string
status
Optional

status

Possible values are : OTHER, RUNNING, SUCCESSFUL, FAILED, QUEUED, CANCELLING, CANCELLED, PARTIAL_SUCCESSFUL,
object
pattern
Optional

pattern

string
desktopPoolId
Optional

desktopPoolId

string
statusDescription
Optional

statusDescription

integer As int32 As int32
percentageComplete
Optional

percentageComplete

string
agentDisplayName
Optional

agentDisplayName

string As date-time As date-time
startDate
Optional

startDate

object
pool
Optional

pool

array of object
taskHistory
Optional

taskHistory

boolean
cancellable
Optional

cancellable

array of string
taskPatternsOrVmIds
Optional

taskPatternsOrVmIds

boolean
hasChildTasks
Optional

hasChildTasks

string
createdBy
Optional

createdBy

string
assignmentType
Optional

assignmentType

string
id
Optional

id

array of object
links
Optional

links


202
Returns DtPoolTask of type(s) */* 
"DtPoolTask Object"
string
type
Optional

type

string
agentVersion
Optional

agentVersion

string
vmName
Optional

vmName

string
status
Optional

status

Possible values are : OTHER, RUNNING, SUCCESSFUL, FAILED, QUEUED, CANCELLING, CANCELLED, PARTIAL_SUCCESSFUL,
object
pattern
Optional

pattern

string
desktopPoolId
Optional

desktopPoolId

string
statusDescription
Optional

statusDescription

integer As int32 As int32
percentageComplete
Optional

percentageComplete

string
agentDisplayName
Optional

agentDisplayName

string As date-time As date-time
startDate
Optional

startDate

object
pool
Optional

pool

array of object
taskHistory
Optional

taskHistory

boolean
cancellable
Optional

cancellable

array of string
taskPatternsOrVmIds
Optional

taskPatternsOrVmIds

boolean
hasChildTasks
Optional

hasChildTasks

string
createdBy
Optional

createdBy

string
assignmentType
Optional

assignmentType

string
id
Optional

id

array of object
links
Optional

links


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/dt-rest/v100/pool/manager/{poolId}/vms/perform/{operation}
On This Page
Dt Pool Manager Operations
POST
Set Agent Update Cache Path
GET
Find Applications
PUT
Assign User To Static Desktop Pattern
POST
Schedule Check Agent Updates Job
POST
Clear Machine Id For VM
POST
Convert To Gold Pattern
Deprecated
POST
Convert VM To Gold Pattern
Deprecated
POST
Convert Vm To Gold Pattern
POST
Create Application Session Pool
POST
Create Application Session Pool
POST
Create Desktop Pool
POST
Create Desktop Pool
POST
Create Session Pool
POST
Create Session Pool
POST
Create User Defined App
GET
Create Pattern Filter
GET
Create Pool Filter
GET
Create Virtual Machine Filter
POST
Delete User Defined App
GET
Get Gold Patterns
Deprecated
GET
Get Gold Patterns For Desktop Model
GET
Get Gold Patterns By Attrs
POST
Get Entitled User Count For Pools
POST
Find Desktop Patterns
POST
Find Virtual Machines
POST
Find Pools
GET
Get Gold Patterns For Pool Type
GET
Is GP Sync Enabled
GET
Last GP Conversion Error
GET
List Vms With Older Agents
GET
Get Desktop Pools Of Groups
GET
Get Default Mapping Of Users
GET
Get Patterns Of Users
GET
Get Desktop Pool Of Users
POST
Migrate Desktop Patterns
Deprecated
POST
Migrate Patterns
POST
Migrate Pool Vms
PUT
Modify User Defined App
Deprecated
GET
Get Occupancy For Pools
GET
Get Patterns
GET
Get Agent Update Config
POST
Get Available Agent Updates On Pools
POST
Update Agents On Pool By Filter
POST
Get Update Agent Status On Pools
GET
Get Pool
POST
Get Available Agent Update Details
POST
Get Available Agent Update Details
GET
Get Available Agent Update On Pool
Deprecated
POST
Update Agents On Pool
Deprecated
POST
Get Update Agent Status On Pool
Deprecated
GET
Create Agent Update Filter
POST
Refresh Dynamic Pool
POST
Resync Pool
GET
Get Pools
GET
Get Pools With Entitled User Counts
POST
Push Machine Id To VM
GET
Get RDP
POST
Rectify Migrated Pool Vms
POST
Purge Recycle Pool
POST
Reserve Desktop Pattern
POST
Reset Agent Pairing State For Patterns
POST
Reset Agent Pairing State For Pool V Ms
POST
Reset Pairing State For VM
Deprecated
POST
Unreserve Pattern
PUT
Upload User Defined App Icon
GET
Get Virtual Machine
POST
Target Pools For Vm Migration
GET
Get Virtual Machines
GET
Get Desktop Manager Id For Pool Id
POST
Rebuild Dynamic Pool V Ms API
POST
Perform Pool Batch Power Operation
GET
Get Pool With Entitled User Count