Apache CloudStack 4.18.0.0 Root Admin API Reference
migrateSystemVm
Attempts Migration of a system virtual machine to the host specified.
Request parameters
| Parameter Name | Description | Required |
| virtualmachineid | the ID of the virtual machine | true |
| autoselect | Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default | false |
| hostid | destination Host ID to migrate VM to | false |
| storageid | Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume | false |
Response Tags
| Response Name | Description |
| id | the ID of the system VM |
| activeviewersessions | the number of active console sessions for the console proxy system vm |
| agentstate | the agent state of the system VM |
| created | the date and time the system VM was created |
| disconnected | the last disconnected date of host |
| dns1 | the first DNS for the system VM |
| dns2 | the second DNS for the system VM |
| gateway | the gateway for the system VM |
| guestvlan | guest vlan range |
| hostcontrolstate | the control state of the host for the system VM |
| hostid | the host ID for the system VM |
| hostname | the hostname for the system VM |
| hypervisor | the hypervisor on which the template runs |
| isdynamicallyscalable | true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. |
| jobid | the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. |
| jobstatus | the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job. |
| linklocalip | the link local IP address for the system vm |
| linklocalmacaddress | the link local MAC address for the system vm |
| linklocalnetmask | the link local netmask for the system vm |
| name | the name of the system VM |
| networkdomain | the network domain for the system VM |
| podid | the Pod ID for the system VM |
| podname | the Pod name for the system VM |
| privateip | the private IP address for the system VM |
| privatemacaddress | the private MAC address for the system VM |
| privatenetmask | the private netmask for the system VM |
| publicip | the public IP address for the system VM |
| publicmacaddress | the public MAC address for the system VM |
| publicnetmask | the public netmask for the system VM |
| publicvlan | public vlan range |
| state | the state of the system VM |
| systemvmtype | the system VM type |
| templateid | the template ID for the system VM |
| templatename | the template name for the system VM |
| version | the systemvm agent version |
| zoneid | the Zone ID for the system VM |
| zonename | the Zone name for the system VM |