{"deployVirtualMachine":[["serviceofferingid","the ID of the service offering for the virtual machine","true"],["templateid","the ID of the template for the virtual machine","true"],["zoneid","availability zone for the virtual machine","true"],["account","an optional account for the virtual machine. Must be used with domainId.","false"],["diskofferingid","the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.","false"],["displayname","an optional user generated name for the virtual machine","false"],["domainid","an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.","false"],["group","an optional group for the virtual machine","false"],["hostid","destination Host ID to deploy the VM to - parameter available for root admin only","false"],["hypervisor","the hypervisor on which to deploy the virtual machine","false"],["ipaddress","the ip address for default vm's network","false"],["iptonetworklist","ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].networkid=204 - requests to use ip 10.10.10.11 in network id=204","false"],["keyboard","an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us","false"],["keypair","name of the ssh key pair used to login to the virtual machine","false"],["name","host name for the virtual machine","false"],["networkids","list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter","false"],["securitygroupids","comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter","false"],["securitygroupnames","comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter","false"],["size","the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId","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. Currently only HTTP GET is supported. Using HTTP GET (via querystring), you can send up to 2KB of data after base64 encoding.","false"]],"destroyVirtualMachine":[["id","The ID of the virtual machine","true"]],"rebootVirtualMachine":[["id","The ID of the virtual machine","true"]],"startVirtualMachine":[["id","The ID of the virtual machine","true"]],"stopVirtualMachine":[["id","The ID of the virtual machine","true"],["forced","Force stop the VM. The caller knows the VM is stopped.","false"]],"resetPasswordForVirtualMachine":[["id","The ID of the virtual machine","true"]],"changeServiceForVirtualMachine":[["id","The ID of the virtual machine","true"],["serviceofferingid","the service offering ID to apply to the virtual machine","true"]],"updateVirtualMachine":[["id","The ID of the virtual machine","true"],["displayname","user generated name","false"],["group","group of the virtual machine","false"],["haenable","true if high-availability is enabled for the virtual machine, false otherwise","false"],["ostypeid","the ID of the OS type that best represents this VM.","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. Currently only HTTP GET is supported. Using HTTP GET (via querystring), you can send up to 2KB of data after base64 encoding.","false"]],"recoverVirtualMachine":[["id","The ID of the virtual machine","true"]],"listVirtualMachines":[["account","account. Must be used with the domainId parameter.","false"],["domainid","the domain ID. If used with the account parameter, lists virtual machines for the specified account in this domain.","false"],["forvirtualnetwork","list by network type; true if need to list vms using Virtual Network, false otherwise","false"],["groupid","the group ID","false"],["hostid","the host ID","false"],["hypervisor","the target hypervisor for the template","false"],["id","the ID of the virtual machine","false"],["isrecursive","Must be used with domainId parameter. Defaults to false, but if true, lists all vms from the parent specified by the domain id till leaves.","false"],["keyword","List by keyword","false"],["name","name of the virtual machine","false"],["networkid","list by network id","false"],["page","","false"],["pagesize","","false"],["podid","the pod ID","false"],["state","state of the virtual machine","false"],["storageid","the storage ID where vm's volumes belong to","false"],["zoneid","the availability zone ID","false"]],"getVMPassword":[["id","The ID of the virtual machine","true"]],"migrateVirtualMachine":[["hostid","destination Host ID to migrate VM to","true"],["virtualmachineid","the ID of the virtual machine","true"]],"createUser":[["account","Creates the user under the specified account. If no account is specified, the username will be used as the account name.","true"],["email","email","true"],["firstname","firstname","true"],["lastname","lastname","true"],["password","Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.","true"],["username","Unique username.","true"],["domainid","Creates the user under the specified domain. Has to be accompanied with the account parameter","false"],["timezone","Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.","false"]],"deleteUser":[["id","Deletes a user","true"]],"updateUser":[["id","User id","true"],["email","email","false"],["firstname","first name","false"],["lastname","last name","false"],["password","Hashed password (default is MD5). If you wish to use any other hasing algorithm, you would need to write a custom authentication adapter","false"],["timezone","Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.","false"],["userapikey","The API key for the user. Must be specified with userSecretKey","false"],["username","Unique username","false"],["usersecretkey","The secret key for the user. Must be specified with userApiKey","false"]],"listUsers":[["account","List user by account. Must be used with the domainId parameter.","false"],["accounttype","List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.","false"],["domainid","List all users in a domain. If used with the account parameter, lists an account in a specific domain.","false"],["id","List user by ID.","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"],["state","List users by state of the user account.","false"],["username","List user by the username","false"]],"disableUser":[["id","Disables user by user ID.","true"]],"enableUser":[["id","Enables user by user ID.","true"]],"registerUserKeys":[["id","User id","true"]],"addVpnUser":[["password","password for the username","true"],["username","username for the vpn user","true"],["account","an optional account for the vpn user. Must be used with domainId.","false"],["domainid","an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.","false"]],"removeVpnUser":[["username","username for the vpn user","true"],["account","an optional account for the vpn user. Must be used with domainId.","false"],["domainid","an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.","false"]],"listVpnUsers":[["account","the account of the remote access vpn. Must be used with the domainId parameter.","false"],["domainid","the domain ID of the remote access vpn. If used with the account parameter, lists remote access vpns for the account in the specified domain.","false"],["id","the ID of the vpn user","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"],["username","the username of the vpn user.","false"]],"createTemplate":[["displaytext","the display text of the template. This is usually used for display purposes.","true"],["name","the name of the template","true"],["ostypeid","the ID of the OS Type that best represents the OS of this template.","true"],["bits","32 or 64 bit","false"],["details","Template details in key/value pairs.","false"],["isfeatured","true if this template is a featured template, false otherwise","false"],["ispublic","true if this template is a public template, false otherwise","false"],["passwordenabled","true if the template supports the password reset feature; default is false","false"],["requireshvm","true if the template requres HVM, false otherwise","false"],["snapshotid","the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in","false"],["templatetag","the tag for this template.","false"],["url","Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server","false"],["virtualmachineid","Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal","false"],["volumeid","the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in","false"]],"registerTemplate":[["displaytext","the display text of the template. This is usually used for display purposes.","true"],["format","the format for the template. Possible values include QCOW2, RAW, and VHD.","true"],["hypervisor","the target hypervisor for the template","true"],["name","the name of the template","true"],["ostypeid","the ID of the OS Type that best represents the OS of this template.","true"],["url","the URL of where the template is hosted. Possible URL include http:// and https://","true"],["zoneid","the ID of the zone the template is to be hosted on","true"],["account","an optional accountName. Must be used with domainId.","false"],["bits","32 or 64 bits support. 64 by default","false"],["checksum","the MD5 checksum value of this template","false"],["details","Template details in key/value pairs.","false"],["domainid","an optional domainId. If the account parameter is used, domainId must also be used.","false"],["isextractable","true if the template or its derivatives are extractable; default is false","false"],["isfeatured","true if this template is a featured template, false otherwise","false"],["ispublic","true if the template is available to all accounts; default is true","false"],["passwordenabled","true if the template supports the password reset feature; default is false","false"],["requireshvm","true if this template requires HVM","false"],["templatetag","the tag for this template.","false"]],"updateTemplate":[["id","the ID of the image file","true"],["bootable","true if image is bootable, false otherwise","false"],["displaytext","the display text of the image","false"],["format","the format for the image","false"],["name","the name of the image file","false"],["ostypeid","the ID of the OS type that best represents the OS of this image.","false"],["passwordenabled","true if the image supports the password reset feature; default is false","false"]],"copyTemplate":[["id","Template ID.","true"],["destzoneid","ID of the zone the template is being copied to.","true"],["sourcezoneid","ID of the zone the template is currently hosted on.","true"]],"deleteTemplate":[["id","the ID of the template","true"],["zoneid","the ID of zone of the template","false"]],"listTemplates":[["templatefilter","possible values are \"featured\", \"self\", \"self-executable\", \"executable\", and \"community\".* featured-templates that are featured and are public* self-templates that have been registered/created by the owner* selfexecutable-templates that have been registered/created by the owner that can be used to deploy a new VM* executable-all templates that can be used to deploy a new VM* community-templates that are public.","true"],["account","list template by account. Must be used with the domainId parameter.","false"],["domainid","list all templates in specified domain. If used with the account parameter, lists all templates for an account in the specified domain.","false"],["hypervisor","the hypervisor for which to restrict the search","false"],["id","the template ID","false"],["keyword","List by keyword","false"],["name","the template name","false"],["page","","false"],["pagesize","","false"],["zoneid","list templates by zoneId","false"]],"updateTemplatePermissions":[["id","the template ID","true"],["accounts","a comma delimited list of accounts. If specified, \"op\" parameter has to be passed in.","false"],["isextractable","true if the template/iso is extractable, false other wise. Can be set only by root admin","false"],["isfeatured","true for featured template/iso, false otherwise","false"],["ispublic","true for public template/iso, false for private templates/isos","false"],["op","permission operator (add, remove, reset)","false"]],"listTemplatePermissions":[["id","the template ID","true"],["account","List template visibility and permissions for the specified account. Must be used with the domainId parameter.","false"],["domainid","List template visibility and permissions by domain. If used with the account parameter, specifies in which domain the specified account exists.","false"]],"extractTemplate":[["id","the ID of the template","true"],["mode","the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD","true"],["zoneid","the ID of the zone where the ISO is originally located","true"],["url","the url to which the ISO would be extracted","false"]],"prepareTemplate":[["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"]],"updateNetworkOffering":[["availability","the availability of network offering. Default value is Required for Guest Virtual network offering; Optional for Guest Direct network offering","false"],["displaytext","the display text of the network offering","false"],["id","the id of the network offering","false"],["name","the name of the network offering","false"]],"listNetworkOfferings":[["availability","the availability of network offering. Default value is Required","false"],["displaytext","list network offerings by display text","false"],["guestiptype","the guest ip type for the network offering, supported types are Direct and Virtual.","false"],["id","list network offerings by id","false"],["isdefault","true if need to list only default network offerings. Default value is false","false"],["isshared","true is network offering supports vlans","false"],["keyword","List by keyword","false"],["name","list network offerings by name","false"],["page","","false"],["pagesize","","false"],["specifyvlan","the tags for the network offering.","false"],["traffictype","list by traffic type","false"],["zoneid","list netowrk offerings available for network creation in specific zone","false"]],"createNetwork":[["displaytext","the display text of the network","true"],["name","the name of the network","true"],["networkofferingid","the network offering id","true"],["zoneid","the Zone ID for the network","true"],["account","account who will own the network","false"],["domainid","domain ID of the account owning a network","false"],["endip","the ending IP address in the network IP range. If not specified, will be defaulted to startIP","false"],["gateway","the gateway of the network","false"],["isdefault","true if network is default, false otherwise","false"],["isshared","true is network is shared across accounts in the Zone","false"],["netmask","the netmask of the network","false"],["networkdomain","network domain","false"],["startip","the beginning IP address in the network IP range","false"],["tags","Tag the network","false"],["vlan","the ID or VID of the network","false"]],"deleteNetwork":[["id","the ID of the network","true"]],"listNetworks":[["account","account who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited","false"],["domainid","domain ID of the account owning a VLAN","false"],["id","list networks by id","false"],["isdefault","true if network is default, false otherwise","false"],["isshared","true if network is shared across accounts in the Zone, false otherwise","false"],["issystem","true if network is system, false otherwise","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"],["traffictype","type of the traffic","false"],["type","the type of the network","false"],["zoneid","the Zone ID of the network","false"]],"restartNetwork":[["id","The id of the network to restart.","true"],["cleanup","If cleanup old network elements","false"]],"updateNetwork":[["id","the ID of the network","true"],["displaytext","the new display text for the network","false"],["name","the new name for the network","false"],["networkdomain","network domain","false"],["tags","tags for the network","false"]],"addNetworkDevice":[["networkdeviceparameterlist","parameters for network device","false"],["networkdevicetype","Network device type, now supports ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer","false"]],"listNetworkDevice":[["keyword","List by keyword","false"],["networkdeviceparameterlist","parameters for network device","false"],["networkdevicetype","Network device type, now supports ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer","false"],["page","","false"],["pagesize","","false"]],"deleteNetworkDevice":[["id","Id of network device to delete","false"]],"attachIso":[["id","the ID of the ISO file","true"],["virtualmachineid","the ID of the virtual machine","true"]],"detachIso":[["virtualmachineid","The ID of the virtual machine","true"]],"listIsos":[["account","the account of the ISO file. Must be used with the domainId parameter.","false"],["bootable","true if the ISO is bootable, false otherwise","false"],["domainid","lists all available ISO files by ID of a domain. If used with the account parameter, lists all available ISO files for the account in the ID of a domain.","false"],["hypervisor","the hypervisor for which to restrict the search","false"],["id","list all isos by id","false"],["isofilter","possible values are \"featured\", \"self\", \"self-executable\",\"executable\", and \"community\". * featured-ISOs that are featured and are publicself-ISOs that have been registered/created by the owner. * selfexecutable-ISOs that have been registered/created by the owner that can be used to deploy a new VM. * executable-all ISOs that can be used to deploy a new VM * community-ISOs that are public.","false"],["ispublic","true if the ISO is publicly available to all users, false otherwise.","false"],["isready","true if this ISO is ready to be deployed","false"],["keyword","List by keyword","false"],["name","list all isos by name","false"],["page","","false"],["pagesize","","false"],["zoneid","the ID of the zone","false"]],"registerIso":[["displaytext","the display text of the ISO. This is usually used for display purposes.","true"],["name","the name of the ISO","true"],["url","the URL to where the ISO is currently being hosted","true"],["zoneid","the ID of the zone you wish to register the ISO to.","true"],["account","an optional account name. Must be used with domainId.","false"],["bootable","true if this ISO is bootable","false"],["domainid","an optional domainId. If the account parameter is used, domainId must also be used.","false"],["isextractable","true if the iso or its derivatives are extractable; default is false","false"],["isfeatured","true if you want this ISO to be featured","false"],["ispublic","true if you want to register the ISO to be publicly available to all users, false otherwise.","false"],["ostypeid","the ID of the OS Type that best represents the OS of this ISO","false"]],"updateIso":[["id","the ID of the image file","true"],["bootable","true if image is bootable, false otherwise","false"],["displaytext","the display text of the image","false"],["format","the format for the image","false"],["name","the name of the image file","false"],["ostypeid","the ID of the OS type that best represents the OS of this image.","false"],["passwordenabled","true if the image supports the password reset feature; default is false","false"]],"deleteIso":[["id","the ID of the ISO file","true"],["zoneid","the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones","false"]],"copyIso":[["id","Template ID.","true"],["destzoneid","ID of the zone the template is being copied to.","true"],["sourcezoneid","ID of the zone the template is currently hosted on.","true"]],"updateIsoPermissions":[["id","the template ID","true"],["accounts","a comma delimited list of accounts. If specified, \"op\" parameter has to be passed in.","false"],["isextractable","true if the template/iso is extractable, false other wise. Can be set only by root admin","false"],["isfeatured","true for featured template/iso, false otherwise","false"],["ispublic","true for public template/iso, false for private templates/isos","false"],["op","permission operator (add, remove, reset)","false"]],"listIsoPermissions":[["id","the template ID","true"],["account","List template visibility and permissions for the specified account. Must be used with the domainId parameter.","false"],["domainid","List template visibility and permissions by domain. If used with the account parameter, specifies in which domain the specified account exists.","false"]],"extractIso":[["id","the ID of the ISO file","true"],["mode","the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD","true"],["zoneid","the ID of the zone where the ISO is originally located","true"],["url","the url to which the ISO would be extracted","false"]],"attachVolume":[["id","the ID of the disk volume","true"],["virtualmachineid","\tthe ID of the virtual machine","true"],["deviceid","the ID of the device to map the volume to within the guest OS. If no deviceId is passed in, the next available deviceId will be chosen. Possible values for a Linux OS are:* 1 - /dev/xvdb* 2 - /dev/xvdc* 4 - /dev/xvde* 5 - /dev/xvdf* 6 - /dev/xvdg* 7 - /dev/xvdh* 8 - /dev/xvdi* 9 - /dev/xvdj","false"]],"detachVolume":[["deviceid","the device ID on the virtual machine where volume is detached from","false"],["id","the ID of the disk volume","false"],["virtualmachineid","the ID of the virtual machine where the volume is detached from","false"]],"createVolume":[["name","the name of the disk volume","true"],["account","the account associated with the disk volume. Must be used with the domainId parameter.","false"],["diskofferingid","the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.","false"],["domainid","the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.","false"],["size","Arbitrary volume size","false"],["snapshotid","the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.","false"],["zoneid","the ID of the availability zone","false"]],"deleteVolume":[["id","The ID of the disk volume","true"]],"listVolumes":[["account","the account associated with the disk volume. Must be used with the domainId parameter.","false"],["domainid","Lists all disk volumes for the specified domain ID. If used with the account parameter, returns all disk volumes for an account in the specified domain ID.","false"],["hostid","list volumes on specified host","false"],["id","the ID of the disk volume","false"],["isrecursive","defaults to false, but if true, lists all volumes from the parent specified by the domain id till leaves.","false"],["keyword","List by keyword","false"],["name","the name of the disk volume","false"],["page","","false"],["pagesize","","false"],["podid","the pod id the disk volume belongs to","false"],["type","the type of disk volume","false"],["virtualmachineid","the ID of the virtual machine","false"],["zoneid","the ID of the availability zone","false"]],"extractVolume":[["id","the ID of the volume","true"],["mode","the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD","true"],["zoneid","the ID of the zone where the volume is located","true"],["url","the url to which the volume would be extracted","false"]],"createVolumeOnFiler":[["aggregatename","aggregate name.","true"],["ipaddress","ip address.","true"],["password","password.","true"],["poolname","pool name.","true"],["size","volume size.","true"],["username","user name.","true"],["volumename","volume name.","true"],["snapshotpolicy","snapshot policy.","false"],["snapshotreservation","snapshot reservation.","false"]],"destroyVolumeOnFiler":[["aggregatename","aggregate name.","true"],["ipaddress","ip address.","true"],["volumename","volume name.","true"]],"listVolumesOnFiler":[["poolname","pool name.","true"]],"addHost":[["hypervisor","hypervisor type of the host","true"],["password","the password for the host","true"],["url","the host URL","true"],["username","the username for the host","true"],["zoneid","the Zone ID for the host","true"],["allocationstate","Allocation state of this Host for allocation of new resources","false"],["clusterid","the cluster ID for the host","false"],["clustername","the cluster name for the host","false"],["hosttags","list of tags to be added to the host","false"],["podid","the Pod ID for the host","false"]],"reconnectHost":[["id","the host ID","true"]],"updateHost":[["id","the ID of the host to update","true"],["allocationstate","Allocation state of this Host for allocation of new resources","false"],["hosttags","list of tags to be added to the host","false"],["oscategoryid","the id of Os category to update the host with","false"]],"deleteHost":[["id","the host ID","true"],["forced","Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped","false"],["forcedestroylocalstorage","Force destroy local storage on this host. All VMs created on this local storage will be destroyed","false"]],"prepareHostForMaintenance":[["id","the host ID","true"]],"cancelHostMaintenance":[["id","the host ID","true"]],"listHosts":[["allocationstate","list hosts by allocation state","false"],["clusterid","lists hosts existing in particular cluster","false"],["details","give details. 1 = minimal; 2 = include static info; 3 = include events; 4 = include allocation and statistics","false"],["id","the id of the host","false"],["keyword","List by keyword","false"],["name","the name of the host","false"],["page","","false"],["pagesize","","false"],["podid","the Pod ID for the host","false"],["state","the state of the host","false"],["type","the host type","false"],["virtualmachineid","lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM","false"],["zoneid","the Zone ID for the host","false"]],"addSecondaryStorage":[["url","the URL for the secondary storage","true"],["zoneid","the Zone ID for the secondary storage","false"]],"updateHostPassword":[["password","the new password for the host/cluster","true"],["username","the username for the host/cluster","true"],["clusterid","the cluster ID. Either this parameter, or hostId has to be passed in","false"],["hostid","the host ID. Either this parameter, or clusterId has to be passed in","false"]],"listStoragePools":[["clusterid","list storage pools belongig to the specific cluster","false"],["id","the ID of the storage pool","false"],["ipaddress","the IP address for the storage pool","false"],["keyword","List by keyword","false"],["name","the name of the storage pool","false"],["page","","false"],["pagesize","","false"],["path","the storage pool path","false"],["podid","the Pod ID for the storage pool","false"],["zoneid","the Zone ID for the storage pool","false"]],"createStoragePool":[["name","the name for the storage pool","true"],["url","the URL of the storage pool","true"],["zoneid","the Zone ID for the storage pool","true"],["clusterid","the cluster ID for the storage pool","false"],["details","the details for the storage pool","false"],["podid","the Pod ID for the storage pool","false"],["tags","the tags for the storage pool","false"]],"deleteStoragePool":[["id","Storage pool id","true"]],"createPool":[["algorithm","algorithm.","true"],["name","pool name.","true"]],"deletePool":[["poolname","pool name.","true"]],"modifyPool":[["algorithm","algorithm.","true"],["poolname","pool name.","true"]],"listPools":[],"createLoadBalancerRule":[["algorithm","load balancer algorithm (source, roundrobin, leastconn)","true"],["name","name of the load balancer rule","true"],["privateport","the private port of the private ip address/virtual machine where the network traffic will be load balanced to","true"],["publicport","the public port from where the network traffic will be load balanced from","true"],["account","the account associated with the load balancer. Must be used with the domainId parameter.","false"],["cidrlist","the cidr list to forward traffic from","false"],["description","the description of the load balancer rule","false"],["domainid","the domain ID associated with the load balancer","false"],["openfirewall","if true, firewall rule for source/end pubic port is automatically created; if false - firewall rule has to be created explicitely. Has value true by default","false"],["publicipid","public ip address id from where the network traffic will be load balanced from","false"],["zoneid","public ip address id from where the network traffic will be load balanced from","false"]],"deleteLoadBalancerRule":[["id","the ID of the load balancer rule","true"]],"removeFromLoadBalancerRule":[["id","The ID of the load balancer rule","true"],["virtualmachineids","the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)","true"]],"assignToLoadBalancerRule":[["id","the ID of the load balancer rule","true"],["virtualmachineids","the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)","true"]],"listLoadBalancerRules":[["account","the account of the load balancer rule. Must be used with the domainId parameter.","false"],["domainid","the domain ID of the load balancer rule. If used with the account parameter, lists load balancer rules for the account in the specified domain.","false"],["id","the ID of the load balancer rule","false"],["keyword","List by keyword","false"],["name","the name of the load balancer rule","false"],["page","","false"],["pagesize","","false"],["publicipid","the public IP address id of the load balancer rule\t","false"],["virtualmachineid","the ID of the virtual machine of the load balancer rule","false"],["zoneid","the availability zone ID","false"]],"listLoadBalancerRuleInstances":[["id","the ID of the load balancer rule","true"],["applied","true if listing all virtual machines currently applied to the load balancer rule; default is true","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"]],"updateLoadBalancerRule":[["id","the id of the load balancer rule to update","true"],["algorithm","load balancer algorithm (source, roundrobin, leastconn)","false"],["description","the description of the load balancer rule","false"],["name","the name of the load balancer rule","false"]],"startSystemVm":[["id","The ID of the system virtual machine","true"]],"rebootSystemVm":[["id","The ID of the system virtual machine","true"]],"stopSystemVm":[["id","The ID of the system virtual machine","true"],["forced","Force stop the VM. The caller knows the VM is stopped.","false"]],"destroySystemVm":[["id","The ID of the system virtual machine","true"]],"listSystemVms":[["hostid","the host ID of the system VM","false"],["id","the ID of the system VM","false"],["keyword","List by keyword","false"],["name","the name of the system VM","false"],["page","","false"],["pagesize","","false"],["podid","the Pod ID of the system VM","false"],["state","the state of the system VM","false"],["systemvmtype","the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".","false"],["zoneid","the Zone ID of the system VM","false"]],"migrateSystemVm":[["hostid","destination Host ID to migrate VM to","true"],["virtualmachineid","the ID of the virtual machine","true"]],"createSnapshot":[["volumeid","The ID of the disk volume","true"],["account","The account of the snapshot. The account parameter must be used with the domainId parameter.","false"],["domainid","The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume.","false"],["policyid","policy id of the snapshot, if this is null, then use MANUAL_POLICY.","false"]],"listSnapshots":[["account","lists snapshot belongig to the specified account. Must be used with the domainId parameter.","false"],["domainid","the domain ID. If used with the account parameter, lists snapshots for the specified account in this domain.","false"],["id","lists snapshot by snapshot ID","false"],["intervaltype","valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.","false"],["isrecursive","defaults to false, but if true, lists all snapshots from the parent specified by the domain id till leaves.","false"],["keyword","List by keyword","false"],["name","lists snapshot by snapshot name","false"],["page","","false"],["pagesize","","false"],["snapshottype","valid values are MANUAL or RECURRING.","false"],["volumeid","the ID of the disk volume","false"]],"deleteSnapshot":[["id","The ID of the snapshot","true"]],"createSnapshotPolicy":[["intervaltype","valid values are HOURLY, DAILY, WEEKLY, and MONTHLY","true"],["maxsnaps","maximum number of snapshots to retain","true"],["schedule","time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28)","true"],["timezone","Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.","true"],["volumeid","the ID of the disk volume","true"]],"deleteSnapshotPolicies":[["id","the Id of the snapshot","false"],["ids","list of snapshots IDs separated by comma","false"]],"listSnapshotPolicies":[["volumeid","the ID of the disk volume","true"],["account","lists snapshot policies for the specified account. Must be used with domainid parameter.","false"],["domainid","the domain ID. If used with the account parameter, lists snapshot policies for the specified account in this domain.","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"]],"startRouter":[["id","the ID of the router","true"]],"rebootRouter":[["id","the ID of the router","true"]],"stopRouter":[["id","the ID of the router","true"],["forced","Force stop the VM. The caller knows the VM is stopped.","false"]],"destroyRouter":[["id","the ID of the router","true"]],"changeServiceForRouter":[["id","The ID of the router","true"],["serviceofferingid","the service offering ID to apply to the domain router","true"]],"listRouters":[["account","the name of the account associated with the router. Must be used with the domainId parameter.","false"],["domainid","the domain ID associated with the router. If used with the account parameter, lists all routers associated with an account in the specified domain.","false"],["hostid","the host ID of the router","false"],["id","the ID of the disk router","false"],["keyword","List by keyword","false"],["name","the name of the router","false"],["networkid","list by network id","false"],["page","","false"],["pagesize","","false"],["podid","the Pod ID of the router","false"],["state","the state of the router","false"],["zoneid","the Zone ID of the router","false"]],"listPortForwardingRules":[["account","account. Must be used with the domainId parameter.","false"],["domainid","the domain ID. If used with the account parameter, lists port forwarding rules for the specified account in this domain.","false"],["id","Lists rule with the specified ID.","false"],["ipaddressid","the id of IP address of the port forwarding services","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"]],"createPortForwardingRule":[["ipaddressid","the IP address id of the port forwarding rule","true"],["privateport","the starting port of port forwarding rule's private port range","true"],["protocol","the protocol for the port fowarding rule. Valid values are TCP or UDP.","true"],["publicport","the starting port of port forwarding rule's public port range","true"],["virtualmachineid","the ID of the virtual machine for the port forwarding rule","true"],["cidrlist","the cidr list to forward traffic from","false"],["openfirewall","if true, firewall rule for source/end pubic port is automatically created; if false - firewall rule has to be created explicitely. Has value true by default","false"],["privateendport","the ending port of port forwarding rule's private port range","false"],["publicendport","the ending port of port forwarding rule's private port range","false"]],"deletePortForwardingRule":[["id","the ID of the port forwarding rule","true"]],"createFirewallRule":[["ipaddressid","the IP address id of the port forwarding rule","true"],["protocol","the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.","true"],["cidrlist","the cidr list to forward traffic from","false"],["endport","the ending port of firewall rule","false"],["icmpcode","error code for this icmp message","false"],["icmptype","type of the icmp message being sent","false"],["startport","the starting port of firewall rule","false"]],"deleteFirewallRule":[["id","the ID of the firewall rule","true"]],"listFirewallRules":[["account","account. Must be used with the domainId parameter.","false"],["domainid","the domain ID. If used with the account parameter, lists firewall rules for the specified account in this domain.","false"],["id","Lists rule with the specified ID.","false"],["ipaddressid","the id of IP address of the firwall services","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"]],"createAccount":[["accounttype","Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin","true"],["email","email","true"],["firstname","firstname","true"],["lastname","lastname","true"],["password","Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.","true"],["username","Unique username.","true"],["account","Creates the user under the specified account. If no account is specified, the username will be used as the account name.","false"],["domainid","Creates the user under the specified domain.","false"],["networkdomain","Network domain for the account's networks","false"],["timezone","Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.","false"]],"deleteAccount":[["id","Account id","true"]],"updateAccount":[["account","the current account name","true"],["domainid","the ID of the domain where the account exists","true"],["newname","new name for the account","true"],["networkdomain","Network domain for the account's networks","false"]],"disableAccount":[["account","Disables specified account.","true"],["domainid","Disables specified account in this domain.","true"],["lock","If true, only lock the account; else disable the account","true"]],"enableAccount":[["account","Enables specified account.","true"],["domainid","Enables specified account in this domain.","true"]],"listAccounts":[["accounttype","list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).","false"],["domainid","list all accounts in specified domain. If used with the name parameter, retrieves account information for the account with specified name in specified domain.","false"],["id","list account by account ID","false"],["iscleanuprequired","list accounts by cleanuprequred attribute (values are true or false)","false"],["isrecursive","defaults to false, but if true, lists all accounts from the parent specified by the domain id till leaves.","false"],["keyword","List by keyword","false"],["name","list account by account name","false"],["page","","false"],["pagesize","","false"],["state","list accounts by state. Valid states are enabled, disabled, and locked.","false"]],"generateUsageRecords":[["enddate","End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.","true"],["startdate","Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.","true"],["domainid","List events for the specified domain.","false"]],"listUsageRecords":[["enddate","End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03.","true"],["startdate","Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.","true"],["account","List usage records for the specified user.","false"],["accountid","List usage records for the specified account","false"],["domainid","List usage records for the specified domain.","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"]],"addTrafficMonitor":[["url","URL of the traffic monitor Host","true"],["zoneid","Zone in which to add the external firewall appliance.","true"]],"deleteTrafficMonitor":[["id","Id of the Traffic Monitor Host.","true"]],"listTrafficMonitors":[["zoneid","zone Id","true"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"]],"createLunOnFiler":[["name","pool name.","true"],["size","LUN size.","true"]],"destroyLunOnFiler":[["path","LUN path.","true"]],"listLunsOnFiler":[["poolname","pool name.","true"]],"associateLun":[["iqn","Guest IQN to which the LUN associate.","true"],["name","LUN name.","true"]],"dissociateLun":[["iqn","Guest IQN.","true"],["path","LUN path.","true"]],"createSecurityGroup":[["name","name of the security group","true"],["account","an optional account for the security group. Must be used with domainId.","false"],["description","the description of the security group","false"],["domainid","an optional domainId for the security group. If the account parameter is used, domainId must also be used.","false"]],"deleteSecurityGroup":[["account","the account of the security group. Must be specified with domain ID","false"],["domainid","the domain ID of account owning the security group","false"],["id","The ID of the security group. Mutually exclusive with name parameter","false"],["name","The ID of the security group. Mutually exclusive with id parameter","false"]],"authorizeSecurityGroupIngress":[["account","an optional account for the virtual machine. Must be used with domainId.","false"],["cidrlist","the cidr list associated","false"],["domainid","an optional domainId for the security group. If the account parameter is used, domainId must also be used.","false"],["endport","end port for this ingress rule","false"],["icmpcode","error code for this icmp message","false"],["icmptype","type of the icmp message being sent","false"],["protocol","TCP is default. UDP is the other supported protocol","false"],["securitygroupid","The ID of the security group. Mutually exclusive with securityGroupName parameter","false"],["securitygroupname","The name of the security group. Mutually exclusive with securityGroupName parameter","false"],["startport","start port for this ingress rule","false"],["usersecuritygrouplist","user to security group mapping","false"]],"revokeSecurityGroupIngress":[["id","The ID of the ingress rule","true"]],"listSecurityGroups":[["account","lists all available port security groups for the account. Must be used with domainID parameter","false"],["domainid","lists all available security groups for the domain ID. If used with the account parameter, lists all available security groups for the account in the specified domain ID.","false"],["id","list the security group by the id provided","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"],["securitygroupname","lists security groups by name","false"],["virtualmachineid","lists security groups by virtual machine id","false"]],"enableStaticNat":[["ipaddressid","the public IP address id for which static nat feature is being enabled","true"],["virtualmachineid","the ID of the virtual machine for enabling static nat feature","true"]],"createIpForwardingRule":[["ipaddressid","the public IP address id of the forwarding rule, already associated via associateIp","true"],["protocol","the protocol for the rule. Valid values are TCP or UDP.","true"],["startport","the start port for the rule","true"],["cidrlist","the cidr list to forward traffic from","false"],["endport","the end port for the rule","false"],["openfirewall","if true, firewall rule for source/end pubic port is automatically created; if false - firewall rule has to be created explicitely. Has value true by default","false"]],"deleteIpForwardingRule":[["id","the id of the forwarding rule","true"]],"listIpForwardingRules":[["account","the account associated with the ip forwarding rule. Must be used with the domainId parameter.","false"],["domainid","Lists all rules for this id. If used with the account parameter, returns all rules for an account in the specified domain ID.","false"],["id","Lists rule with the specified ID.","false"],["ipaddressid","list the rule belonging to this public ip address","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"],["virtualmachineid","Lists all rules applied to the specified Vm.","false"]],"disableStaticNat":[["ipaddressid","the public IP address id for which static nat feature is being disableed","true"]],"createDomain":[["name","creates domain with this name","true"],["networkdomain","Network domain for networks in the domain","false"],["parentdomainid","assigns new domain a parent domain by domain ID of the parent. If no parent domain is specied, the ROOT domain is assumed.","false"]],"updateDomain":[["id","ID of domain to update","true"],["name","updates domain with this name","false"],["networkdomain","Network domain for the domain's networks","false"]],"deleteDomain":[["id","ID of domain to delete","true"],["cleanup","true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise","false"]],"listDomains":[["id","List domain by domain ID.","false"],["keyword","List by keyword","false"],["level","List domains by domain level.","false"],["name","List domain by domain name.","false"],["page","","false"],["pagesize","","false"]],"listDomainChildren":[["id","list children domain by parent domain ID.","false"],["isrecursive","to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".","false"],["keyword","List by keyword","false"],["name","list children domains by name","false"],["page","","false"],["pagesize","","false"]],"createZone":[["dns1","the first DNS for the Zone","true"],["internaldns1","the first internal DNS for the Zone","true"],["name","the name of the Zone","true"],["networktype","network type of the zone, can be Basic or Advanced","true"],["allocationstate","Allocation state of this Zone for allocation of new resources","false"],["dns2","the second DNS for the Zone","false"],["domain","Network domain name for the networks in the zone","false"],["domainid","the ID of the containing domain, null for public zones","false"],["guestcidraddress","the guest CIDR address for the Zone","false"],["internaldns2","the second internal DNS for the Zone","false"],["securitygroupenabled","true if network is security group enabled, false otherwise","false"],["vlan","the VLAN for the Zone","false"]],"updateZone":[["id","the ID of the Zone","true"],["allocationstate","Allocation state of this cluster for allocation of new resources","false"],["details","the details for the Zone","false"],["dhcpprovider","the dhcp Provider for the Zone","false"],["dns1","the first DNS for the Zone","false"],["dns2","the second DNS for the Zone","false"],["dnssearchorder","the dns search order list","false"],["domain","Network domain name for the networks in the zone","false"],["guestcidraddress","the guest CIDR address for the Zone","false"],["internaldns1","the first internal DNS for the Zone","false"],["internaldns2","the second internal DNS for the Zone","false"],["ispublic","updates a private zone to public if set, but not vice-versa","false"],["name","the name of the Zone","false"],["vlan","the VLAN for the Zone","false"]],"deleteZone":[["id","the ID of the Zone","true"]],"listZones":[["available","true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.","false"],["domainid","the ID of the domain associated with the zone","false"],["id","the ID of the zone","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"]],"createInstanceGroup":[["name","the name of the instance group","true"],["account","the account of the instance group. The account parameter must be used with the domainId parameter.","false"],["domainid","the domain ID of account owning the instance group","false"]],"deleteInstanceGroup":[["id","the ID of the instance group","true"]],"updateInstanceGroup":[["id","Instance group ID","true"],["name","new instance group name","false"]],"listInstanceGroups":[["account","list instance group belonging to the specified account. Must be used with domainid parameter","false"],["domainid","the domain ID. If used with the account parameter, lists virtual machines for the specified account in this domain.","false"],["id","list instance groups by ID","false"],["keyword","List by keyword","false"],["name","list instance groups by name","false"],["page","","false"],["pagesize","","false"]],"createServiceOffering":[["cpunumber","the CPU number of the service offering","true"],["cpuspeed","the CPU speed of the service offering in MHz.","true"],["displaytext","the display text of the service offering","true"],["memory","the total memory of the service offering in MB","true"],["name","the name of the service offering","true"],["domainid","the ID of the containing domain, null for public offerings","false"],["hosttags","the host tag for this service offering.","false"],["issystem","is this a system vm offering","false"],["limitcpuuse","restrict the CPU usage to committed service offering","false"],["networkrate","data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype","false"],["offerha","the HA for the service offering","false"],["storagetype","the storage type of the service offering. Values are local and shared.","false"],["systemvmtype","the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".","false"],["tags","the tags for this service offering.","false"]],"deleteServiceOffering":[["id","the ID of the service offering","true"]],"updateServiceOffering":[["id","the ID of the service offering to be updated","true"],["displaytext","the display text of the service offering to be updated","false"],["name","the name of the service offering to be updated","false"]],"listServiceOfferings":[["domainid","the ID of the domain associated with the service offering","false"],["id","ID of the service offering","false"],["issystem","is this a system vm offering","false"],["keyword","List by keyword","false"],["name","name of the service offering","false"],["page","","false"],["pagesize","","false"],["systemvmtype","the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".","false"],["virtualmachineid","the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.","false"]],"createPod":[["gateway","the gateway for the Pod","true"],["name","the name of the Pod","true"],["netmask","the netmask for the Pod","true"],["startip","the starting IP address for the Pod","true"],["zoneid","the Zone ID in which the Pod will be created\t","true"],["allocationstate","Allocation state of this Pod for allocation of new resources","false"],["endip","the ending IP address for the Pod","false"]],"updatePod":[["id","the ID of the Pod","true"],["allocationstate","Allocation state of this cluster for allocation of new resources","false"],["endip","the ending IP address for the Pod","false"],["gateway","the gateway for the Pod","false"],["name","the name of the Pod","false"],["netmask","the netmask of the Pod","false"],["startip","the starting IP address for the Pod","false"]],"deletePod":[["id","the ID of the Pod","true"]],"listPods":[["allocationstate","list pods by allocation state","false"],["id","list Pods by ID","false"],["keyword","List by keyword","false"],["name","list Pods by name","false"],["page","","false"],["pagesize","","false"],["zoneid","list Pods by Zone ID","false"]],"createDiskOffering":[["displaytext","alternate display text of the disk offering","true"],["name","name of the disk offering","true"],["customized","whether disk offering is custom or not","false"],["disksize","size of the disk offering in GB","false"],["domainid","the ID of the containing domain, null for public offerings","false"],["tags","tags for the disk offering","false"]],"updateDiskOffering":[["id","ID of the disk offering","true"],["displaytext","updates alternate display text of the disk offering with this value","false"],["name","updates name of the disk offering with this value","false"]],"deleteDiskOffering":[["id","ID of the disk offering","true"]],"listDiskOfferings":[["domainid","the ID of the domain of the disk offering.","false"],["id","ID of the disk offering","false"],["keyword","List by keyword","false"],["name","name of the disk offering","false"],["page","","false"],["pagesize","","false"]],"updateConfiguration":[["name","the name of the configuration","true"],["value","the value of the configuration","false"]],"listConfigurations":[["category","lists configurations by category","false"],["keyword","List by keyword","false"],["name","lists configuration by name","false"],["page","","false"],["pagesize","","false"]],"createConfiguration":[["category","component's category","true"],["component","the component of the configuration","true"],["instance","the instance of the configuration","true"],["name","the name of the configuration","true"],["description","the description of the configuration","false"],["value","the value of the configuration","false"]],"listCapabilities":[],"addCluster":[["clustername","the cluster name","true"],["clustertype","type of the cluster: CloudManaged, ExternalManaged","true"],["hypervisor","hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator","true"],["zoneid","the Zone ID for the cluster","true"],["allocationstate","Allocation state of this cluster for allocation of new resources","false"],["password","the password for the host","false"],["podid","the Pod ID for the host","false"],["url","the URL","false"],["username","the username for the cluster","false"]],"deleteCluster":[["id","the cluster ID","true"]],"updateCluster":[["id","the ID of the Cluster","true"],["allocationstate","Allocation state of this cluster for allocation of new resources","false"],["clustername","the cluster name","false"],["clustertype","hypervisor type of the cluster","false"],["hypervisor","hypervisor type of the cluster","false"],["managedstate","whether this cluster is managed by cloudstack","false"]],"listClusters":[["allocationstate","lists clusters by allocation state","false"],["clustertype","lists clusters by cluster type","false"],["hypervisor","lists clusters by hypervisor type","false"],["id","lists clusters by the cluster ID","false"],["keyword","List by keyword","false"],["managedstate","whether this cluster is managed by cloudstack","false"],["name","lists clusters by the cluster name","false"],["page","","false"],["pagesize","","false"],["podid","lists clusters by Pod ID","false"],["zoneid","lists clusters by Zone ID","false"]],"createRemoteAccessVpn":[["publicipid","public ip address id of the vpn server","true"],["account","an optional account for the VPN. Must be used with domainId.","false"],["domainid","an optional domainId for the VPN. If the account parameter is used, domainId must also be used.","false"],["iprange","the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server","false"],["openfirewall","if true, firewall rule for source/end pubic port is automatically created; if false - firewall rule has to be created explicitely. Has value true by default","false"]],"deleteRemoteAccessVpn":[["publicipid","public ip address id of the vpn server","true"]],"listRemoteAccessVpns":[["publicipid","public ip address id of the vpn server","true"],["account","the account of the remote access vpn. Must be used with the domainId parameter.","false"],["domainid","the domain ID of the remote access vpn rule. If used with the account parameter, lists remote access vpns for the account in the specified domain.","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"]],"createVlanIpRange":[["startip","the beginning IP address in the VLAN IP range","true"],["account","account who will own the VLAN. If VLAN is Zone wide, this parameter should be ommited","false"],["domainid","domain ID of the account owning a VLAN","false"],["endip","the ending IP address in the VLAN IP range","false"],["forvirtualnetwork","true if VLAN is of Virtual type, false if Direct","false"],["gateway","the gateway of the VLAN IP range","false"],["netmask","the netmask of the VLAN IP range","false"],["networkid","the network id","false"],["podid","optional parameter. Have to be specified for Direct Untagged vlan only.","false"],["vlan","the ID or VID of the VLAN. Default is an \"untagged\" VLAN.","false"],["zoneid","the Zone ID of the VLAN IP range","false"]],"deleteVlanIpRange":[["id","the id of the VLAN IP range","true"]],"listVlanIpRanges":[["account","the account with which the VLAN IP range is associated. Must be used with the domainId parameter.","false"],["domainid","the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.","false"],["forvirtualnetwork","true if VLAN is of Virtual type, false if Direct","false"],["id","the ID of the VLAN IP range","false"],["keyword","List by keyword","false"],["networkid","network id of the VLAN IP range","false"],["page","","false"],["pagesize","","false"],["podid","the Pod ID of the VLAN IP range","false"],["vlan","the ID or VID of the VLAN. Default is an \"untagged\" VLAN.","false"],["zoneid","the Zone ID of the VLAN IP range","false"]],"createSSHKeyPair":[["name","Name of the keypair","true"],["account","an optional account for the ssh key. Must be used with domainId.","false"],["domainid","an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.","false"]],"deleteSSHKeyPair":[["name","Name of the keypair","true"],["account","the account associated with the keypair. Must be used with the domainId parameter.","false"],["domainid","the domain ID associated with the keypair","false"]],"listSSHKeyPairs":[["fingerprint","A public key fingerprint to look for","false"],["keyword","List by keyword","false"],["name","A key pair name to look for","false"],["page","","false"],["pagesize","","false"]],"updateResourceLimit":[["resourcetype","Type of resource to update. Values are 0, 1, 2, 3, and 4. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create.3 - Snapshot. Number of snapshots a user can create.4 - Template. Number of templates that a user can register/create.","true"],["account","Update resource for a specified account. Must be used with the domainId parameter.","false"],["domainid","Update resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.","false"],["max","\tMaximum resource limit.","false"]],"updateResourceCount":[["domainid","If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.","true"],["account","Update resource count for a specified account. Must be used with the domainId parameter.","false"],["resourcetype","Type of resource to update. If specifies valid values are 0, 1, 2, 3, and 4. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create.3 - Snapshot. Number of snapshots a user can create.4 - Template. Number of templates that a user can register/create.","false"]],"listResourceLimits":[["account","Lists resource limits by account. Must be used with the domainId parameter.","false"],["domainid","Lists resource limits by domain ID. If used with the account parameter, lists resource limits for a specified account in a specified domain.","false"],["id","Lists resource limits by ID.","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"],["resourcetype","Type of resource to update. Values are 0, 1, 2, 3, and 4. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create.3 - Snapshot. Number of snapshots a user can create.4 - Template. Number of templates that a user can register/create.","false"]],"addExternalLoadBalancer":[["password","Password of the external load balancer appliance.","true"],["url","URL of the external load balancer appliance.","true"],["username","Username of the external load balancer appliance.","true"],["zoneid","Zone in which to add the external load balancer appliance.","true"]],"deleteExternalLoadBalancer":[["id","Id of the external loadbalancer appliance.","true"]],"listExternalLoadBalancers":[["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"],["zoneid","zone Id","false"]],"addExternalFirewall":[["password","Password of the external firewall appliance.","true"],["url","URL of the external firewall appliance.","true"],["username","Username of the external firewall appliance.","true"],["zoneid","Zone in which to add the external firewall appliance.","true"]],"deleteExternalFirewall":[["id","Id of the external firewall appliance.","true"]],"listExternalFirewalls":[["zoneid","zone Id","true"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"]],"associateIpAddress":[["zoneid","the ID of the availability zone you want to acquire an public IP address from","true"],["account","the account to associate with this IP address","false"],["domainid","the ID of the domain to associate with this IP address","false"],["networkid","The network this ip address should be associated to.","false"]],"disassociateIpAddress":[["id","the id of the public ip address to disassociate","true"]],"listPublicIpAddresses":[["account","lists all public IP addresses by account. Must be used with the domainId parameter.","false"],["allocatedonly","limits search results to allocated public IP addresses","false"],["domainid","lists all public IP addresses by domain ID. If used with the account parameter, lists all public IP addresses by account for specified domain.","false"],["forloadbalancing","list only ips used for load balancing","false"],["forvirtualnetwork","the virtual network for the IP address","false"],["id","lists ip address by id","false"],["ipaddress","lists the specified IP address","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"],["vlanid","lists all public IP addresses by VLAN ID","false"],["zoneid","lists all public IP addresses by Zone ID","false"]],"enableStorageMaintenance":[["id","Primary storage ID","true"]],"cancelStorageMaintenance":[["id","the primary storage ID","true"]],"listOsTypes":[["id","list by Os type Id","false"],["keyword","List by keyword","false"],["oscategoryid","list by Os Category id","false"],["page","","false"],["pagesize","","false"]],"listOsCategories":[["id","list Os category by id","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"]],"listEvents":[["account","the account for the event. Must be used with the domainId parameter.","false"],["domainid","the domain ID for the event. If used with the account parameter, returns all events for an account in the specified domain ID.","false"],["duration","the duration of the event","false"],["enddate","the end date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")","false"],["entrytime","the time the event was entered","false"],["id","the ID of the event","false"],["keyword","List by keyword","false"],["level","the event level (INFO, WARN, ERROR)","false"],["page","","false"],["pagesize","","false"],["startdate","the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")","false"],["type","the event type (see event types)","false"]],"listEventTypes":[],"queryAsyncJobResult":[["jobid","the ID of the asychronous job","true"]],"listAsyncJobs":[["account","the account associated with the async job. Must be used with the domainId parameter.","false"],["domainid","the domain ID associated with the async job. If used with the account parameter, returns async jobs for the account in the specified domain.","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"],["startdate","the start date of the async job","false"]],"listCapacity":[["hostid","lists capacity by the Host ID","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"],["podid","lists capacity by the Pod ID","false"],["type","lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6","false"],["zoneid","lists capacity by the Zone ID","false"]],"configureSimulator":[["name","which command needs to be configured","true"],["value","configuration options for this command, which is seperated by ;","true"],["clusterid","configure range: in a cluster","false"],["hostid","configure range: in a host","false"],["podid","configure range: in a pod","false"],["zoneid","configure range: in a zone","false"]],"registerSSHKeyPair":[["name","Name of the keypair","true"],["publickey","Public key material of the keypair","true"],["account","an optional account for the ssh key. Must be used with domainId.","false"],["domainid","an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.","false"]],"logout":[],"login":[["username","Username","true"],["password","Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.","true"],["domain","path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT domain is assumed.","false"]],"listHypervisors":[["zoneid","the zone id for listing hypervisors.","false"]],"getCloudIdentifier":[["userid","the user ID for the cloud identifier","true"]],"uploadCustomCertificate":[["certificate","the custom cert to be uploaded","true"],["domainsuffix","DNS domain suffix that the certificate is granted for","true"],["id","the custom cert id in the chain","false"],["name","the alias of the certificate","false"],["privatekey","the private key for the certificate","false"]],"listAlerts":[["id","the ID of the alert","false"],["keyword","List by keyword","false"],["page","","false"],["pagesize","","false"],["type","list by alert type","false"]]}