%BOOK_ENTITIES; ]>

addImageStore Adds all types of secondary storage providers, S3/Swift/NFS. createSecondaryStagingStore Adds a staging secondary storage in each zone. listImageStores Lists all secondary storages, S3/Swift/NFS. listSecondaryStagingStores Lists all staging secondary storages. addIpToNic Adds an IP address to the NIC from the guest subnet. The request parameters are: nicid, ipaddress. The response parameters are: nicid, ipaddress, networkid removeIpFromNic Removes the reserved IP for the NIC. The request parameters is: id. The response parameters are: true, false listNics Lists the NIC details of the user VM; the API response also contains the Secondary IP addresses of the NIC. The request parameters are: nicid, virtualmachineid. The response parameters are: id, ipaddress, secondaryips, gateway, netmask, macaddr, broadcasturi, isolationuri, isdefault, deleteAlerts Deletes the specified alerts. The request parameters are: ids (allowed to pass one or more IDs separated by comma); type (string); olderthan (yyyy-mm-dd format). The response parameters are: true, false archiveAlerts Archives the specified alerts. The request parameters are: ids (allowed to pass one or more IDs separated by comma); type (string); olderthan (yyyy-mm-dd format). The response parameters are: true, false deleteEvents Deletes the specified events. The request parameters are: ids (allowed to pass one or more IDs separated by comma); type (string); olderthan (yyyy-mm-dd format). The response parameters are: true, false archiveEvents Archives the specified events. The request parameters are: ids (allowed to pass one or more IDs separated by comma); type (string); olderthan (yyyy-mm-dd format). The response parameters are: true, false createGlobalLoadBalancerRule Creates a GSLB rule. The request parameters are name (the name of the global load balancer rule); domain name ( the preferred domain name for the service); lb algorithm (the algorithm used to load balance the traffic across the zones); session persistence (source IP and HTTP cookie); account name; and domain Id. assignToGlobalLoadBalancerRule Assigns a load balancing rule or list of load balancing rules to GSLB. The request parameters are: id (the UUID of global load balancer rule); loadbalancerrulelist (the list load balancer rules that will be assigned to global load balancer rule. These are second tier load balancing rules created with createLoadBalancerRule API. Weight is optional, the default is 1). removeFromGlobalLoadBalancerRule Removes a load balancer rule association with global load balancer rule. The request parameters are id (the UUID of global load balancer rule); loadbalancerrulelist (the list load balancer rules that will be assigned to global load balancer rule). deleteGlobalLoadBalancerRule Deletes a global load balancer rule. The request parameters is: id (the unique ID of the global load balancer rule). listGlobalLoadBalancerRule Lists load balancer rules. The request parameters are: account (lists resources by account. Use with the domainid parameter); domainid (lists only resources belonging to the domain specified); id (the unique ID of the global load balancer rule); isrecursive (defaults to false; but if true, lists all the resources from the parent specified by the domainid); keyword (lists by keyword); listall (if set to false, lists only resources belonging to the command's caller; if set to true, lists resources that the caller is authorized to see. Default value is false); page; pagesize; projectid (lists objects by project); regionid ; tags (lists resources by tags: key/value pairs). updateGlobalLoadBalancerRule Updates global load balancer rules. The request parameters are: id (the unique ID of the global load balancer rule); account (lists resources by account. Use with the domainid parameter); description (the description of the load balancer rule); domainid (lists only resources belonging to the domain specified); gslblbmethod (the load balancer algorithm that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to round robin); gslbstickysessionmethodname (the session sticky method; if not specified defaults to sourceip); isrecursive (defaults to false, but if true, lists all resources from the parent specified by the domainid till leaves); keyword (lists by keyword); listall (if set to false, list only those resources belonging to the command's caller; if set to true, lists resources that the caller is authorized to see. Default value is false); page; pagesize; projectid (lists objects by project); regionid; tags (lists resources by tags: key/value pairs) createPortableIpRange Creates portable IP addresses in the portable public IP address pool. The request parameters are region id, start ip, end ip, netmask, gateway, and vlan. deletePortableIpRange Deletes portable IP addresses from the portable public IP address pool. The request parameters is portable ip address range id. listPortableIpRange Lists portable IP addresses in the portable public IP address pool associated with a Region. The request parameters are elastic ip id and region id. createVMSnapshot Creates a virtual machine snapshot. deleteVMSnapshot Deletes a virtual machine snapshot. listVMSnapshot Shows a virtual machine snapshot. revertToVMSnapshot Returns a virtual machine to the state and data saved in a given snapshot. createLBHealthCheckPolicy Creates a new health check policy for a load balancer rule. deleteLBHealthCheckPolicy Deletes an existing health check policy from a load balancer rule. listLBHealthCheckPolicies Displays the health check policy for a load balancer rule. createEgressFirewallRules Creates an egress firewall rule on the guest network. deleteEgressFirewallRules Deletes a egress firewall rule on the guest network. listEgressFirewallRules Lists the egress firewall rules configured for a guest network. resetSSHKeyForVirtualMachine Resets the SSHkey for virtual machine. addBaremetalHost Adds a new host. Technically, this API command was present in v3.0.6, but its functionality was disabled. addBaremetalDhcp Adds a DHCP server for bare metal hosts. addBaremetalPxePingServer Adds a PXE PING server for bare metal hosts. addBaremetalPxeKickStartServer (Adds a PXE server for bare metal hosts) listBaremetalDhcp Shows the DHCP servers currently defined for bare metal hosts. listBaremetalPxePingServer Shows the PXE PING servers currently defined for bare metal hosts. addNicToVirtualMachine Adds a new NIC to the specified VM on a selected network. removeNicFromVirtualMachine Removes the specified NIC from a selected VM. updateDefaultNicForVirtualMachine Updates the specified NIC to be the default one for a selected VM. addRegion Registers a Region into another Region. updateRegion Updates Region details: ID, Name, Endpoint, User API Key, and User Secret Key. removeRegion Removes a Region from current Region. listRegions Get all the Regions. They can be filtered by using the ID or Name. getUser This API can only be used by the Admin. Get user account details by using the API Key. getApiLimit Shows number of remaining APIs for the invoking user in current window. resetApiLimit For root admin, if account ID parameter is passed, it will reset count for that particular account, otherwise it will reset all counters. lockAccount Locks an account. lockUser Locks a user account. scaleVirtualMachine Scales the virtual machine to a new service offering. migrateVirtualMachineWithVolume Attempts migrating VM with its volumes to a different host. dedicatePublicIpRange Dedicates a Public IP range to an account. releasePublicIpRange Releases a Public IP range back to the system pool. dedicateGuestVlanRange Dedicates a guest VLAN range to an account. releaseDedicatedGuestVlanRange Releases a dedicated guest VLAN range to the system. listDedicatedGuestVlanRanges Lists dedicated guest VLAN ranges. updatePortForwardingRule Updates a port forwarding rule. Only the private port and the VM can be updated. scaleSystemVm Scales the service offering for a systemVM, console proxy, or secondary storage. listDeploymentPlanners Lists all the deployment planners available. addS3 Adds a Amazon Simple Storage Service instance. listS3s Lists all the Amazon Simple Storage Service instances. findHostsForMigration Finds hosts suitable for migrating a VM to. releaseHostReservation Releases host reservation. resizeVolume Resizes a volume. updateVolume Updates the volume. listStorageProviders Lists storage providers. findStoragePoolsForMigration Lists storage pools available for migrating a volume. createEgressFirewallRule Creates a egress firewall rule for a given network. deleteEgressFirewallRule Deletes an egress firewall rule. listEgressFirewallRules Lists all egress firewall rules for network. updateNetworkACLItem Updates ACL item with specified ID. createNetworkACLList Creates a Network ACL for the given VPC. deleteNetworkACLList Deletes a Network ACL. replaceNetworkACLList Replaces ACL associated with a Network or private gateway. listNetworkACLLists Lists all network ACLs. addResourceDetail Adds detail for the Resource. removeResourceDetail Removes details of the resource. listResourceDetails Lists resource details. addNiciraNvpDevice Adds a Nicira NVP device. deleteNiciraNvpDevice Deletes a Nicira NVP device. listNiciraNvpDevices Lists Nicira NVP devices. listNiciraNvpDeviceNetworks Lists network that are using a Nicira NVP device. addBigSwitchVnsDevice Adds a BigSwitch VNS device. deleteBigSwitchVnsDevice Deletes a BigSwitch VNS device. listBigSwitchVnsDevices Lists BigSwitch VNS devices. configureSimulator Configures a simulator. listApis Lists all the available APIs on the server, provided by the API Discovery plugin. getApiLimit Gets the API limit count for the caller. resetApiLimit Resets the API count. assignToGlobalLoadBalancerRule Assigns load balancer rule or list of load balancer rules to a global load balancer rules. removeFromGlobalLoadBalancerRule Removes a load balancer rule association with global load balancer rule. listVMSnapshot Lists virtual machine snapshot by conditions. createLoadBalancer Creates a load balancer. listLoadBalancers Lists load balancers. deleteLoadBalancer Deletes a load balancer. configureInternalLoadBalancerElement Configures an Internal Load Balancer element. createInternalLoadBalancerElement Creates an Internal Load Balancer element. listInternalLoadBalancerElements Lists all available Internal Load Balancer elements. createAffinityGroup Creates an affinity or anti-affinity group. deleteAffinityGroup Deletes an affinity group. listAffinityGroups Lists all the affinity groups. updateVMAffinityGroup Updates the affinity or anti-affinity group associations of a VM. The VM has to be stopped and restarted for the new properties to take effect. listAffinityGroupTypes Lists affinity group types available. stopInternalLoadBalancerVM Stops an Internal LB VM. startInternalLoadBalancerVM Starts an existing Internal LB VM. listInternalLoadBalancerVMs Lists internal LB VMs. listNetworkIsolationMethods Lists supported methods of network isolation. dedicateZone Dedicates a zone. dedicatePod Dedicates a pod. dedicateCluster Dedicates an existing cluster. dedicateHost Dedicates a host. releaseDedicatedZone Releases dedication of zone. releaseDedicatedPod Releases dedication for the pod. releaseDedicatedCluster Releases dedication for cluster. releaseDedicatedHost Releases dedication for host. listDedicatedZones Lists dedicated zones. listDedicatedPods Lists dedicated pods. listDedicatedClusters Lists dedicated clusters. listDedicatedHosts Lists dedicated hosts.