Skip to main content

Perform virtual machine operations​

Select

SaaS
Customer Managed

Perform VM operations :- PowerOn, PowerOff, Delete, Reset, Edit Owners, Edit Creators

Request Body

VMs list request body

  • operation VMOperationEnum

    Possible values: [CREATE = 0, RESTART = 1, SHUTDOWN = 2, SNAPSHOT = 3, RESTORE_SNAP = 4, DELETE = 5, CLONE = 6, PAUSE = 7, POWERON = 10, EDIT = 11, VIEW_SNAPSHOTS = 12, DELETE_SNAP_VM = 15, RENEW_VM = 17, REFRESH_VM = 20, EDIT_OWNERS = 21, POWER_OFF = 29, EDIT_CREATOR = 30, REFRESH = 31, LIST_OWNERS = 32, CREATE_LAB = 34]

  • virtualMachines object[]
  • GUID string

    GUID of virtual machine

  • owners string[]

    list of owners for the virtual machine

  • creator string

    creator of virtual machine

  • vmOperationConfig object

    Request body for create virtual machine

  • name string

    Name of VM

  • description string

    VM description

  • expirationTime int32

    VM expiration time in UNIX timestamp format

  • count int32

    Number of VMs to be created

  • userDetails object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • target object
  • id int32
  • name string
  • template object
  • vmName string

    VM name of template

  • vmGUID string

    VM guid of template

  • operatingSystem string

    Possible values: [WINDOWS, UNIX]

    OS types

  • operatingSystemDisplayName string

    Operating System version

  • memory int64

    Memory size of VM in GBs

  • numCPUs int32

    Number of CPUs for VM

  • numNICs int32

    Number of NICs associated to VM

  • vmSize string

    VM instance

  • createPublicIP boolean

    Is public IP enabled

  • vmIOPS int32

    IOPS limit for Amazon VM

  • isoPath string

    ISO path for HyperV VM

  • vmBackup boolean

    Enable VM backup

  • vmDisk object[]

    New disk configuration

  • name string

    Name of the disk

  • snapshotId string

    Unique identifier of the snapshot, applicable if the disk is created from a snapshot

  • provisioningType string

    Possible values: [THIN, THICK]

    Disk provisioning type

  • diskSize int64

    Disk size in bytes

  • diskType string

    Possible values: [ISCSI, IDE]

    Type of disk controller

  • sourceHardDiskType SourceHardDiskType

    Possible values: [None, EmptyHardDisk, ExistingHardDisk, ExistingSnapShot, RootHardDisk]

    Type of hard disk

  • network object[]
  • networkDisplayName string

    Selected network display name

  • network string

    Name of network switch

  • subnetId string

    Subnet id of the subnet

  • networkId string

    VPC id for the amazon network

  • destinationNetworks string[]

    Destination network name

  • networkNames string[]

    Name of network to which the nic is connected

  • domainOptions object
  • domainName string

    Unique name for network domain

  • OUPath string

    Organizational unit path of VM

  • snapOption object[]
  • id string

    ID of snapshot

  • name string

    Name of snapshot

  • desc string

    Description of snapshot

  • volumeId string

    ID of volume for snapshot creation

Responses

OK

Schema
  • errorMessage string

    Tells about the error occured

  • errorCode ErrorCode

    Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID]

    Error code value

Loading...