Cosmic Domain Admin API Reference

updateVirtualMachine

Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.

Request parameters

Parameter Name	Description	Required
id	The ID of the virtual machine	true
bootmenutimeout	Timeout (in ms) to for the boot menu	false
bootorder	Comma seperated list from which device to boot from first, can one of 'hd','cdrom','network'	false
customid	an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only	false
details	Details in key/value pairs.	false
displayname	user generated name	false
displayvm	an optional field, whether to the display the vm to the end user or not.	false
group	group of the virtual machine	false
haenable	true if high-availability is enabled for the virtual machine, false otherwise	false
instancename	instance name of the user vm	false
isdynamicallyscalable	true if VM contains XS tools inorder to support dynamic scaling of VM cpu/memory	false
maintenancepolicy	either 'LiveMigrate' or 'ShutdownAndStart' when performing hypervisor maintenance	false
manufacturerstring	Manufacturer String to put in hardware info, defaults to 'Mission Critical Cloud'	false
name	new host name of the vm. The VM has to be stopped/started for this update to take affect	false
optimisefor	Optimise for 'Windows' or 'Generic'	false
ostypeid	the ID of the OS type that best represents this VM.	false
restartrequired	true if VM needs to a stop/start to receive updated VM specs on the hypervisor	false
userdata	an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 2KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 32K of data after base64 encoding.	false

Response Tags

Response Name	Description
id	the ID of the virtual machine
account	the account associated with the virtual machine
bootmenutimeout	Timeout of the boot menu (in ms)
bootorder	Boot order priority
cpunumber	the number of cpu this virtual machine is running with
cpuused	the amount of the vm's CPU currently used
created	the date when this virtual machine was created
details	Vm details in key/value pairs.
diskioread	the read (io) of disk on the vm
diskiowrite	the write (io) of disk on the vm
diskkbsread	the read (bytes) of disk on the vm
diskkbswrite	the write (bytes) of disk on the vm
diskofferingid	the ID of the disk offering of the virtual machine
diskofferingname	the name of the disk offering of the virtual machine
displayname	user generated name. The name of the virtual machine is returned if no displayname exists.
displayvm	an optional field whether to the display the vm to the end user or not.
domain	the name of the domain in which the virtual machine exists
domainid	the ID of the domain in which the virtual machine exists
forvirtualnetwork	the virtual network for the service offering
group	the group name of the virtual machine
groupid	the group ID of the virtual machine
guestosid	Os type ID of the virtual machine
haenable	true if high-availability is enabled, false otherwise
hostid	the ID of the host for the virtual machine
hostname	the name of the host for the virtual machine
hypervisor	the hypervisor on which the template runs
instancename	instance name of the user vm; this parameter is returned to the ROOT admin only
isdynamicallyscalable	true if vm contains XS tools inorder to support dynamic scaling of VM cpu/memory.
isodisplaytext	an alternate display text of the ISO attached to the virtual machine
isoid	the ID of the ISO attached to the virtual machine
isoname	the name of the ISO attached to the virtual machine
keypair	ssh key-pair
laststartdate	Timestamp of last start of VM
laststartversion	What Cosmic version did the VM start with
maintenancepolicy	Maintenance Policy of the VM
manufacturerstring	Manufacturer String to put in hardware info, defaults to 'Mission Critical Cloud'
memory	the memory allocated for the virtual machine
name	the name of the virtual machine
networkkbsread	the incoming network traffic on the vm
networkkbswrite	the outgoing network traffic on the host
optimisefor	Optimise for 'Windows' or 'Generic'
ostypeid	OS type id of the vm
password	the password (if exists) of the virtual machine
passwordenabled	true if the password rest feature is enabled, false otherwise
project	the project name of the vm
projectid	the project id of the vm
publicip	public IP address id associated with vm via Static nat rule
publicipid	public IP address id associated with vm via Static nat rule
restartrequired	true if VM needs to a stop/start to receive updated VM specs on the hypervisor
rootdevicecontroller	controller type of the root volume
rootdeviceid	device ID of the root volume
rootdevicetype	device type of the root volume
serviceofferingid	the ID of the service offering of the virtual machine
serviceofferingname	the name of the service offering of the virtual machine
servicestate	State of the Service from LB rule
state	the state of the virtual machine
templatedisplaytext	an alternate display text of the template for the virtual machine
templateid	the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.
templatename	the name of the template for the virtual machine
userid	the user's ID who deployed the virtual machine
username	the user's name who deployed the virtual machine
vgpu	the vgpu type used by the virtual machine
zoneid	the ID of the availablility zone for the virtual machine
zonename	the name of the availability zone for the virtual machine
*affinitygroup()**	list of affinity groups associated with the virtual machine
id	the ID of the affinity group
account	the account owning the affinity group
description	the description of the affinity group
domain	the domain name of the affinity group
domainid	the domain ID of the affinity group
name	the name of the affinity group
project	the project name of the affinity group
projectid	the project ID of the affinity group
type	the type of the affinity group
virtualmachineIds	virtual machine IDs associated with this affinity group
*nic()**	the list of nics associated with vm
id	the ID of the nic
broadcasturi	the broadcast uri of the nic
gateway	the gateway of the nic
ip6address	the IPv6 address of network
ip6cidr	the cidr of IPv6 network
ip6gateway	the gateway of IPv6 network
ipaddress	the ip address of the nic
isdefault	true if nic is default, false otherwise
isolationuri	the isolation uri of the nic
macaddress	true if nic is default, false otherwise
mirroripaddress	the mirror ip address for the nic
mirrorkey	the mirror key for the nic
netmask	the netmask of the nic
networkid	the ID of the corresponding network
networkname	the name of the corresponding network
secondaryip	the Secondary ipv4 addr of nic
traffictype	the traffic type of the nic
type	the type of the nic
virtualmachineid	Id of the vm to which the nic belongs
*tags()**	the list of resource tags associated with vm
account	the account associated with the tag
customer	customer associated with the tag
domain	the domain associated with the tag
domainid	the ID of the domain associated with the tag
key	tag key name
project	the project name where tag belongs to
projectid	the project id the tag belongs to
resourceid	id of the resource
resourcetype	resource type
value	tag value
jobid	the ID of the latest async job acting on this object
jobstatus	the current status of the latest async job acting on this object