Create Virtual Lab API

Select

SaaS

Customer Managed

API to create virtual lab

application/json

Request Body

Request body for create virtual lab API

• name string

  Lab name

• description string

  Description of lab

• target object

  Details of target associated to virtual machine

  id int32

  name string
• count int32

  Number of labs

• expirationTime int32

  Lab expiration time in UNIX timestamp format

• vmPassword object

  savedCredentials object

  id int32

  name string

  credentials object

  name string

  username to access the network path

  password string

  password to access the network path

• labVMConfiguration object[]

  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

Responses

• 200
• 400
• 401
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

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

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

Bad Request

application/json

• Schema
• Example (from schema)

---

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

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

Unauthorized

application/json

• Schema
• Example (from schema)

---

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

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

Internal Server Error

application/json

• Schema
• Example (from schema)

---

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

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

Loading...