Cosmic Admin API Reference
scaleSystemVm
Scale the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect.
Request parameters
Parameter Name | Description | Required |
id | The ID of the system vm | true |
serviceofferingid | the service offering ID to apply to the system vm | true |
details | name value pairs of custom parameters for cpu, memory and cpunumber. example details[i].name=value | 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 |
created | the date and time the system VM was created |
dns1 | the first DNS for the system VM |
dns2 | the second DNS for the system VM |
gateway | the gateway 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 |
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 |
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 |
state | the state of the system VM |
systemvmtype | the system VM type |
templateid | the template ID for the system VM |
zoneid | the Zone ID for the system VM |
zonename | the Zone name for the system VM |