Apache CloudStack Root Admin API Reference


Creates a system virtual-machine that implements network services

Request parameters

Parameter NameDescriptionRequired
leftnetworkidThe left (inside) network for service instancetrue
nameThe name of the service instancetrue
rightnetworkidThe right (outside) network ID for the service instancetrue
serviceofferingidThe service offering ID that defines the resources consumed by the service appliancetrue
templateidThe template ID that specifies the image for the service appliancetrue
zoneidAvailability zone for the service instancetrue
accountAn optional account for the virtual machine. Must be used with domainId.false
domainidAn optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.false
projectidProject ID for the service instancefalse

Response Tags

Response NameDescription
idthe ID of the virtual machine
accountthe account associated with the virtual machine
displaynameuser generated name. The name of the virtual machine is returned if no displayname exists.
domainthe name of the domain in which the virtual machine exists
domainidthe ID of the domain in which the virtual machine exists
namethe name of the virtual machine
projectthe project name of the vm
projectidthe project id of the vm