X-Mailer: ASF-Git Admin Mailer Subject: [18/51] [partial] cloudstack-www git commit: Latest API build http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/markDefaultZoneForAccount.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/markDefaultZoneForAccount.html b/content/api/apidocs-4.0.0/root_admin/markDefaultZoneForAccount.html new file mode 100644 index 0000000..683c5ff --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/markDefaultZoneForAccount.html @@ -0,0 +1,241 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

markDefaultZoneForAccount

Marks a default zone for this account

+ +

Request parameters

+ + + + + + + + + + + + + +

Parameter Name	Description	Required
account	Name of the account that is to be marked.	true
domainid	Marks the account that belongs to the specified domain.	true
zoneid	The Zone ID with which the account is to be marked.	true

Response Tags

Response Name	Description
id	the id of the account
accountdetails	details for the account
accounttype	account type (admin, domain-admin, user)
defaultzoneid	the default zone of the account
domain	name of the Domain the account belongs too
domainid	id of the Domain the account belongs too
ipavailable	the total number of public ip addresses available for this account to acquire
iplimit	the total number of public ip addresses this account can acquire
iptotal	the total number of public ip addresses allocated for this account
iscleanuprequired	true if the account requires cleanup
name	the name of the account
networkavailable	the total number of networks available to be created for this account
networkdomain	the network domain
networklimit	the total number of networks the account can own
networktotal	the total number of networks owned by account
projectavailable	the total number of projects available for administration by this account
projectlimit	the total number of projects the account can own
projecttotal	the total number of projects being administrated by this account
receivedbytes	the total number of network traffic bytes received
sentbytes	the total number of network traffic bytes sent
snapshotavailable	the total number of snapshots available for this account
snapshotlimit	the total number of snapshots which can be stored by this account
snapshottotal	the total number of snapshots stored by this account
state	the state of the account
templateavailable	the total number of templates available to be created by this account
templatelimit	the total number of templates which can be created by this account
templatetotal	the total number of templates which have been created by this account
vmavailable	the total number of virtual machines available for this account to acquire
vmlimit	the total number of virtual machines that can be deployed by this account
vmrunning	the total number of virtual machines running for this account
vmstopped	the total number of virtual machines stopped for this account
vmtotal	the total number of virtual machines deployed by this account
volumeavailable	the total volume available for this account
volumelimit	the total volume which can be used by this account
volumetotal	the total volume being used by this account
vpcavailable	the total number of vpcs available to be created for this account
vpclimit	the total number of vpcs the account can own
vpctotal	the total number of vpcs owned by account
*user()**	the list of users associated with account
id	the user ID
account	the account name of the user
accountid	the account ID of the user
accounttype	the account type of the user
apikey	the api key of the user
created	the date and time the user account was created
domain	the domain name of the user
domainid	the domain ID of the user
email	the user email address
firstname	the user firstname
lastname	the user lastname
secretkey	the secret key of the user
state	the user state
timezone	the timezone user was created in
username	the user name

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/migrateSystemVm.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/migrateSystemVm.html b/content/api/apidocs-4.0.0/root_admin/migrateSystemVm.html new file mode 100644 index 0000000..078d794 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/migrateSystemVm.html @@ -0,0 +1,94 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

migrateSystemVm

Attempts Migration of a system virtual machine to the host specified.

+ +

Request parameters

+ + + + + + + + + + +

Parameter Name	Description	Required
hostid	destination Host ID to migrate VM to	true
virtualmachineid	the ID of the virtual machine	true

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the ID of the system VM
hostid	the host ID for the system VM
name	the name of the system VM
role	the role of the system VM
state	the state of the system VM
systemvmtype	the system VM type

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/migrateVirtualMachine.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/migrateVirtualMachine.html b/content/api/apidocs-4.0.0/root_admin/migrateVirtualMachine.html new file mode 100644 index 0000000..661242e --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/migrateVirtualMachine.html @@ -0,0 +1,409 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

migrateVirtualMachine

Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool

+ +

Request parameters

+ + + + + + + + + + + + + +

Parameter Name	Description	Required
virtualmachineid	the ID of the virtual machine	true
hostid	Destination Host ID to migrate VM to. Required for live migrating a VM from host to host	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 virtual machine
account	the account associated with the virtual machine
cpunumber	the number of cpu this virtual machine is running with
cpuspeed	the speed of each cpu
cpuused	the amount of the vm's CPU currently used
created	the date when this virtual machine was created
displayname	user generated name. The name of the virtual machine is returned if no displayname exists.
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
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
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
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
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
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
zoneid	the ID of the availablility zone for the virtual machine
zonename	the name of the availability zone for the virtual machine
*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
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
netmask	the netmask of the nic
networkid	the ID of the corresponding network
networkname	the name of the corresponding network
traffictype	the traffic type of the nic
type	the type of the nic
*securitygroup()**	list of security groups associated with the virtual machine
id	the ID of the security group
account	the account owning the security group
description	the description of the security group
domain	the domain name of the security group
domainid	the domain ID of the security group
name	the name of the security group
project	the project name of the group
projectid	the project id of the group
*egressrule()**	the list of egress rules associated with the security group
account	account owning the security group rule
cidr	the CIDR notation for the base IP address of the security group rule
endport	the ending IP of the security group rule
icmpcode	the code for the ICMP message response
icmptype	the type of the ICMP message response
protocol	the protocol of the security group rule
ruleid	the id of the security group rule
securitygroupname	security group name
startport	the starting IP of the security group rule
*ingressrule()**	the list of ingress rules associated with the security group
account	account owning the security group rule
cidr	the CIDR notation for the base IP address of the security group rule
endport	the ending IP of the security group rule
icmpcode	the code for the ICMP message response
icmptype	the type of the ICMP message response
protocol	the protocol of the security group rule
ruleid	the id of the security group rule
securitygroupname	security group name
startport	the starting IP of the security group rule
*tags()**	the list of resource tags associated with the rule
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
*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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/migrateVolume.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/migrateVolume.html b/content/api/apidocs-4.0.0/root_admin/migrateVolume.html new file mode 100644 index 0000000..04d0ac1 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/migrateVolume.html @@ -0,0 +1,211 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

migrateVolume

Migrate volume

+ +

Request parameters

+ + + + + + + + + + +

Parameter Name	Description	Required
storageid	destination storage pool ID to migrate the volume to	true
volumeid	the ID of the volume	true

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	ID of the disk volume
account	the account associated with the disk volume
attached	the date the volume was attached to a VM instance
created	the date the disk volume was created
destroyed	the boolean state of whether the volume is destroyed or not
deviceid	the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.
diskofferingdisplaytext	the display text of the disk offering
diskofferingid	ID of the disk offering
diskofferingname	name of the disk offering
domain	the domain associated with the disk volume
domainid	the ID of the domain associated with the disk volume
hypervisor	Hypervisor the volume belongs to
isextractable	true if the volume is extractable, false otherwise
name	name of the disk volume
project	the project name of the vpn
projectid	the project id of the vpn
serviceofferingdisplaytext	the display text of the service offering for root disk
serviceofferingid	ID of the service offering for root disk
serviceofferingname	name of the service offering for root disk
size	size of the disk volume
snapshotid	ID of the snapshot from which this volume was created
state	the state of the disk volume
status	the status of the volume
storage	name of the primary storage hosting the disk volume
storagetype	shared or local storage
type	type of the disk volume (ROOT or DATADISK)
virtualmachineid	id of the virtual machine
vmdisplayname	display name of the virtual machine
vmname	name of the virtual machine
vmstate	state of the virtual machine
zoneid	ID of the availability zone
zonename	name of the availability zone
*tags()**	the list of resource tags associated with volume
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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/prepareHostForMaintenance.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/prepareHostForMaintenance.html b/content/api/apidocs-4.0.0/root_admin/prepareHostForMaintenance.html new file mode 100644 index 0000000..2a53b25 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/prepareHostForMaintenance.html @@ -0,0 +1,208 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

prepareHostForMaintenance

Prepares a host for maintenance.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	the host ID	true

Response Tags

Response Name	Description
id	the ID of the host
averageload	the cpu average load on the host
capabilities	capabilities of the host
clusterid	the cluster ID of the host
clustername	the cluster name of the host
clustertype	the cluster type of the cluster that host belongs to
cpuallocated	the amount of the host's CPU currently allocated
cpunumber	the CPU number of the host
cpuspeed	the CPU speed of the host
cpuused	the amount of the host's CPU currently used
cpuwithoverprovisioning	the amount of the host's CPU after applying the cpu.overprovisioning.factor
created	the date and time the host was created
disconnected	true if the host is disconnected. False otherwise.
disksizeallocated	the host's currently allocated disk size
disksizetotal	the total disk size of the host
events	events available for the host
hahost	true if the host is Ha host (dedicated to vms started by HA process; false otherwise
hasenoughcapacity	true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise
hosttags	comma-separated list of tags for the host
hypervisor	the host hypervisor
hypervisorversion	the hypervisor version
ipaddress	the IP address of the host
islocalstorageactive	true if local storage is active, false otherwise
lastpinged	the date and time the host was last pinged
managementserverid	the management server ID of the host
memoryallocated	the amount of the host's memory currently allocated
memorytotal	the memory total of the host
memoryused	the amount of the host's memory currently used
name	the name of the host
networkkbsread	the incoming network traffic on the host
networkkbswrite	the outgoing network traffic on the host
oscategoryid	the OS category ID of the host
oscategoryname	the OS category name of the host
podid	the Pod ID of the host
podname	the Pod name of the host
removed	the date and time the host was removed
resourcestate	the resource state of the host
state	the state of the host
suitableformigration	true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise
type	the host type
version	the host version
zoneid	the Zone ID of the host
zonename	the Zone name of the host
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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/prepareTemplate.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/prepareTemplate.html b/content/api/apidocs-4.0.0/root_admin/prepareTemplate.html new file mode 100644 index 0000000..36afff2 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/prepareTemplate.html @@ -0,0 +1,214 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

prepareTemplate

load template into primary storage

+ +

Request parameters

+ + + + + + + + + + +

Parameter Name	Description	Required
templateid	template ID of the template to be prepared in primary storage(s).	true
zoneid	zone ID of the template to be prepared in primary storage(s).	true

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
id	the template ID
account	the account name to which the template belongs
accountid	the account id to which the template belongs
bootable	true if the ISO is bootable, false otherwise
checksum	checksum of the template
created	the date this template was created
crossZones	true if the template is managed across all Zones, false otherwise
details	additional key/value details tied with template
displaytext	the template display text
domain	the name of the domain to which the template belongs
domainid	the ID of the domain to which the template belongs
format	the format of the template.
hostid	the ID of the secondary storage host for the template
hostname	the name of the secondary storage host for the template
hypervisor	the hypervisor on which the template runs
isextractable	true if the template is extractable, false otherwise
isfeatured	true if this template is a featured template, false otherwise
ispublic	true if this template is a public template, false otherwise
isready	true if the template is ready to be deployed from, false otherwise.
name	the template name
ostypeid	the ID of the OS type for this template.
ostypename	the name of the OS type for this template.
passwordenabled	true if the reset password feature is enabled, false otherwise
project	the project name of the template
projectid	the project id of the template
removed	the date this template was removed
size	the size of the template
sourcetemplateid	the template ID of the parent template if present
status	the status of the template
templatetag	the tag of this template
templatetype	the type of the template
zoneid	the ID of the zone for this template
zonename	the name of the zone for this template
*tags()**	the list of resource tags associated with tempate
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

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/queryAsyncJobResult.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/queryAsyncJobResult.html b/content/api/apidocs-4.0.0/root_admin/queryAsyncJobResult.html new file mode 100644 index 0000000..a43d116 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/queryAsyncJobResult.html @@ -0,0 +1,109 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

queryAsyncJobResult

Retrieves the current status of asynchronous job.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
jobid	the ID of the asychronous job	true

Response Tags

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Response Name	Description
accountid	the account that executed the async command
cmd	the async command executed
created	the created date of the job
jobinstanceid	the unique ID of the instance/entity object related to the job
jobinstancetype	the instance/entity object related to the job
jobprocstatus	the progress information of the PENDING job
jobresult	the result reason
jobresultcode	the result code for the job
jobresulttype	the result type
jobstatus	the current job status-should be 0 for PENDING
userid	the user that executed the async command
jobid	the ID of the async job

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/rebootRouter.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/rebootRouter.html b/content/api/apidocs-4.0.0/root_admin/rebootRouter.html new file mode 100644 index 0000000..2089509 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/rebootRouter.html @@ -0,0 +1,226 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

rebootRouter

Starts a router.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	the ID of the router	true

Response Tags

Response Name	Description
id	the id of the router
account	the account associated with the router
created	the date and time the router was created
dns1	the first DNS for the router
dns2	the second DNS for the router
domain	the domain associated with the router
domainid	the domain ID associated with the router
gateway	the gateway for the router
guestipaddress	the guest IP address for the router
guestmacaddress	the guest MAC address for the router
guestnetmask	the guest netmask for the router
guestnetworkid	the ID of the corresponding guest network
hostid	the host ID for the router
hostname	the hostname for the router
isredundantrouter	if this router is an redundant virtual router
linklocalip	the link local IP address for the router
linklocalmacaddress	the link local MAC address for the router
linklocalnetmask	the link local netmask for the router
linklocalnetworkid	the ID of the corresponding link local network
name	the name of the router
networkdomain	the network domain for the router
podid	the Pod ID for the router
project	the project name of the address
projectid	the project id of the ipaddress
publicip	the public IP address for the router
publicmacaddress	the public MAC address for the router
publicnetmask	the public netmask for the router
publicnetworkid	the ID of the corresponding public network
redundantstate	the state of redundant virtual router
scriptsversion	the version of scripts
serviceofferingid	the ID of the service offering of the virtual machine
serviceofferingname	the name of the service offering of the virtual machine
state	the state of the router
templateid	the template ID for the router
templateversion	the version of template
vpcid	VPC the network belongs to
zoneid	the Zone ID for the router
zonename	the Zone name for the router
*nic()**	the list of nics associated with the router
id	the ID of the nic
broadcasturi	the broadcast uri of the nic
gateway	the gateway of the nic
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
netmask	the netmask of the nic
networkid	the ID of the corresponding network
networkname	the name of the corresponding network
traffictype	the traffic type of the nic
type	the type of the nic

+ +

+ + http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/edeec656/content/api/apidocs-4.0.0/root_admin/rebootSystemVm.html ---------------------------------------------------------------------- diff --git a/content/api/apidocs-4.0.0/root_admin/rebootSystemVm.html b/content/api/apidocs-4.0.0/root_admin/rebootSystemVm.html new file mode 100644 index 0000000..6fcf128 --- /dev/null +++ b/content/api/apidocs-4.0.0/root_admin/rebootSystemVm.html @@ -0,0 +1,154 @@ + + + + + + + +Apache CloudStack | The Power Behind Your Cloud + + +

+ +

+ + Apache CloudStack 4.0.0-incubating Root Admin API Reference + +

rebootSystemVm

Reboots a system VM.

+ +

Request parameters

+ + + + + + + +

Parameter Name	Description	Required
id	The ID of the system virtual machine	true

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
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

+ +