3.2. What's New in the API for 3.0

Reply-To: cloudstack-dev@incubator.apache.org Delivered-To: mailing list cloudstack-commits@incubator.apache.org Received: (qmail 81777 invoked by uid 99); 6 Dec 2012 08:09:13 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 06 Dec 2012 08:09:13 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 7592A819519; Thu, 6 Dec 2012 08:09:13 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: muralireddy@apache.org To: cloudstack-commits@incubator.apache.org X-Mailer: ASF-Git Admin Mailer Subject: [87/100] [abbrv] [partial] Revised en-US/network-setup.xml to include the correct file. Message-Id: <20121206080913.7592A819519@tyr.zones.apache.org> Date: Thu, 6 Dec 2012 08:09:13 +0000 (UTC) http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d8e31c7a/docs/tmp/en-US/html/whats-new-in-api-3.0.html ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/html/whats-new-in-api-3.0.html b/docs/tmp/en-US/html/whats-new-in-api-3.0.html deleted file mode 100644 index e9819bd..0000000 --- a/docs/tmp/en-US/html/whats-new-in-api-3.0.html +++ /dev/null @@ -1,628 +0,0 @@ - - -3.2. What's New in the API for 3.0

3.2. What's New in the API for 3.0

3.2.1. Enabling Port 8096

- Port 8096, which allows API calls without authentication, is closed and disabled by default on any fresh 3.0.1 installations. You can enable 8096 (or another port) for this purpose as follows: -

- Ensure that the first Management Server is installed and running. -
- Set the global configuration parameter integration.api.port to the desired port. -
- Restart the Management Server. -
- On the Management Server host machine, create an iptables rule allowing access to that port. -

3.2.2. Stopped VM

- CloudStack now supports creating a VM without starting it. You can determine whether the VM needs to be started as part of the VM deployment. A VM can now be deployed in two ways: create and start a VM (the default method); or create a VM and leave it in the stopped state. -

- A new request parameter, startVM, is introduced in the deployVm API to support the stopped VM feature. -

- The possible values are: -

- true - The VM starts as a part of the VM deployment. -
- false - The VM is left in the stopped state at the end of the VM deployment. -

- The default value is true. -

3.2.3. Change to Behavior of List Commands

- There was a major change in how our List* API commands work in CloudStack 3.0 compared to 2.2.x. The rules below apply only for managed resources – those that belong to an account, domain, or project. They are irrelevant for the List* commands displaying unmanaged (system) resources, such as hosts, clusters, and external network resources. -

- When no parameters are passed in to the call, the caller sees only resources owned by the caller (even when the caller is the administrator). Previously, the administrator saw everyone else's resources by default. -

- When accountName and domainId are passed in: -

- The caller sees the resources dedicated to the account specified. -
- If the call is executed by a regular user, the user is authorized to specify only the user's own account and domainId. -
- If the caller is a domain administrator, CloudStack performs an authorization check to see whether the caller is permitted to view resources for the given account and domainId. -

- When projectId is passed in, only resources belonging to that project are listed. -

- When domainId is passed in, the call returns only resources belonging to the domain specified. To see the resources of subdomains, use the parameter isRecursive=true. Again, the regular user can see only resources owned by that user, the root administrator can list anything, and a domain administrator is authorized to see only resources of the administrator's own domain and subdomains. -

- To see all resources the caller is authorized to see, except for Project resources, use the parameter listAll=true. -

- To see all Project resources the caller is authorized to see, use the parameter projectId=-1. -

- There is one API command that doesn't fall under the rules above completely: the listTemplates command. This command has its own flags defining the list rules: -

- - listTemplates Flag - -	- - Description - -
- - featured - -	- - Returns templates that have been marked as featured and public. - -
- - self - -	- - Returns templates that have been registered or created by the calling user. - -
- - selfexecutable - -	- - Same as self, but only returns templates that are ready to be deployed with. - -
- - sharedexecutable - -	- - Ready templates that have been granted to the calling user by another user. - -
- - executable - -	- - Templates that are owned by the calling user, or public templates, that can be used to deploy a new VM. - -
- - community - -	- - Returns templates that have been marked as public but not featured. - -
- - all - -	- - Returns all templates (only usable by admins). - -

- The CloudStack UI on a general view will display all resources that the logged-in user is authorized to see, except for project resources. To see the project resources, select the project view. -

3.2.4. Removed API commands

- createConfiguration (Adds configuration value) -
- configureSimulator (Configures simulator) -

3.2.5. Added API commands in 3.0

3.2.5.1. Added in 3.0.2

- changeServiceForSystemVm -
- Changes the service offering for a system VM (console proxy or secondary storage). The system VM must be in a "Stopped" state for this command to take effect. -

3.2.5.2. Added in 3.0.1

- changeServiceForSystemVm -
- Changes the service offering for a system VM (console proxy or secondary storage). The system VM must be in a "Stopped" state for this command to take effect. -

3.2.5.3. Added in 3.0.0

- - assignVirtualMachine (Move a user VM to another user under same domain.) - -	- - restoreVirtualMachine (Restore a VM to original template or specific snapshot) - -	- - createLBStickinessPolicy (Creates a Load Balancer stickiness policy ) - -
- - deleteLBStickinessPolicy (Deletes a LB stickiness policy.) - -	- - listLBStickinessPolicies (Lists LBStickiness policies.) - -	- - ldapConfig (Configure the LDAP context for this site.) - -
- - addSwift (Adds Swift.) - -	- - listSwifts (List Swift.) - -	- - migrateVolume (Migrate volume) - -
- - updateStoragePool (Updates a storage pool.) - -	- - authorizeSecurityGroupEgress (Authorizes a particular egress rule for this security group) - -	- - revokeSecurityGroupEgress (Deletes a particular egress rule from this security group) - -
- - createNetworkOffering (Creates a network offering.) - -	- - deleteNetworkOffering (Deletes a network offering.) - -	- - createProject (Creates a project) - -
- - deleteProject (Deletes a project) - -	- - updateProject (Updates a project) - -	- - activateProject (Activates a project) - -
- - suspendProject (Suspends a project) - -	- - listProjects (Lists projects and provides detailed information for listed projects) - -	- - addAccountToProject (Adds acoount to a project) - -
- - deleteAccountFromProject (Deletes account from the project) - -	- - listProjectAccounts (Lists project's accounts) - -	- - listProjectInvitations (Lists an account's invitations to join projects) - -
- - updateProjectInvitation (Accepts or declines project invitation) - -	- - deleteProjectInvitation (Deletes a project invitation) - -	- - updateHypervisorCapabilities (Updates a hypervisor capabilities.) - -
- - listHypervisorCapabilities (Lists all hypervisor capabilities.) - -	- - createPhysicalNetwork (Creates a physical network) - -	- - deletePhysicalNetwork (Deletes a Physical Network.) - -
- - listPhysicalNetworks (Lists physical networks) - -	- - updatePhysicalNetwork (Updates a physical network) - -	- - listSupportedNetworkServices (Lists all network services provided by CloudStack or for the given Provider.) - -
- - addNetworkServiceProvider (Adds a network serviceProvider to a physical network) - -	- - deleteNetworkServiceProvider (Deletes a Network Service Provider.) - -	- - listNetworkServiceProviders (Lists network serviceproviders for a given physical network.) - -
- - updateNetworkServiceProvider (Updates a network serviceProvider of a physical network) - -	- - addTrafficType (Adds traffic type to a physical network) - -	- - deleteTrafficType (Deletes traffic type of a physical network) - -
- - listTrafficTypes (Lists traffic types of a given physical network.) - -	- - updateTrafficType (Updates traffic type of a physical network) - -	- - listTrafficTypeImplementors (Lists implementors of implementor of a network traffic type or implementors of all network traffic types) - -
- - createStorageNetworkIpRange (Creates a Storage network IP range.) - -	- - deleteStorageNetworkIpRange (Deletes a storage network IP Range.) - -	- - listStorageNetworkIpRange (List a storage network IP range.) - -
- - updateStorageNetworkIpRange (Update a Storage network IP range, only allowed when no IPs in this range have been allocated.) - -	- - listUsageTypes (List Usage Types) - -	- - addF5LoadBalancer (Adds a F5 BigIP load balancer device) - -
- - configureF5LoadBalancer (configures a F5 load balancer device) - -	- - deleteF5LoadBalancer ( delete a F5 load balancer device) - -	- - listF5LoadBalancers (lists F5 load balancer devices) - -
- - listF5LoadBalancerNetworks (lists network that are using a F5 load balancer device) - -	- - addSrxFirewall (Adds a SRX firewall device) - -	- - deleteSrxFirewall ( delete a SRX firewall device) - -
- - listSrxFirewalls (lists SRX firewall devices in a physical network) - -	- - listSrxFirewallNetworks (lists network that are using SRX firewall device) - -	- - addNetscalerLoadBalancer (Adds a netscaler load balancer device) - -
- - deleteNetscalerLoadBalancer ( delete a netscaler load balancer device) - -	- - configureNetscalerLoadBalancer (configures a netscaler load balancer device) - -	- - listNetscalerLoadBalancers (lists netscaler load balancer devices) - -
- - listNetscalerLoadBalancerNetworks (lists network that are using a netscaler load balancer device) - -	- - createVirtualRouterElement (Create a virtual router element.) - -	- - configureVirtualRouterElement (Configures a virtual router element.) - -
- - listVirtualRouterElements (Lists all available virtual router elements.) - -	- - -	- - -

3.2.6. Added CloudStack Error Codes

- You can now find the CloudStack-specific error code in the exception response for each type of exception. The following list of error codes is added to the new class named CSExceptionErrorCode. These codes are applicable in CloudStack 3.0.3 and later versions. -

- - 4250 : "com.cloud.utils.exception.CloudRuntimeException" - -	- - 4255 : "com.cloud.utils.exception.ExceptionUtil" - -	- - 4260 : "com.cloud.utils.exception.ExecutionException" - -
- - 4265 : "com.cloud.utils.exception.HypervisorVersionChangedException" - -	- - 4270 : "com.cloud.utils.exception.RuntimeCloudException" - -	- - 4275 : "com.cloud.exception.CloudException" - -
- - 4280 : "com.cloud.exception.AccountLimitException" - -	- - 4285 : "com.cloud.exception.AgentUnavailableException" - -	- - 4290 : "com.cloud.exception.CloudAuthenticationException" - -
- - 4295 : "com.cloud.exception.CloudExecutionException" - -	- - 4300 : "com.cloud.exception.ConcurrentOperationException" - -	- - 4305 : "com.cloud.exception.ConflictingNetworkSettingsException" - -
- - 4310 : "com.cloud.exception.DiscoveredWithErrorException" - -	- - 4315 : "com.cloud.exception.HAStateException" - -	- - 4320 : "com.cloud.exception.InsufficientAddressCapacityException" - -
- - 4325 : "com.cloud.exception.InsufficientCapacityException" - -	- - 4330 : "com.cloud.exception.InsufficientNetworkCapacityException" - -	- - 4335 : "com.cloud.exception.InsufficientServerCapacityException" - -
- - 4340 : "com.cloud.exception.InsufficientStorageCapacityException" - -	- - 4345 : "com.cloud.exception.InternalErrorException" - -	- - 4350 : "com.cloud.exception.InvalidParameterValueException" - -
- - 4355 : "com.cloud.exception.ManagementServerException" - -	- - 4360 : "com.cloud.exception.NetworkRuleConflictException" - -	- - 4365 : "com.cloud.exception.PermissionDeniedException" - -
- - 4370 : "com.cloud.exception.ResourceAllocationException" - -	- - 4375 : "com.cloud.exception.ResourceInUseException" - -	- - 4380 : "com.cloud.exception.ResourceUnavailableException" - -
- - 4385 : "com.cloud.exception.StorageUnavailableException" - -	- - 4390 : "com.cloud.exception.UnsupportedServiceException" - -	- - 4395 : "com.cloud.exception.VirtualMachineMigrationException" - -
- - 4400 : "com.cloud.exception.AccountLimitException" - -	- - 4405 : "com.cloud.exception.AgentUnavailableException" - -	- - 4410 : "com.cloud.exception.CloudAuthenticationException" - -
- - 4415 : "com.cloud.exception.CloudException" - -	- - 4420 : "com.cloud.exception.CloudExecutionException" - -	- - 4425 : "com.cloud.exception.ConcurrentOperationException" - -
- - 4430 : "com.cloud.exception.ConflictingNetworkSettingsException" - -	- - 4435 : "com.cloud.exception.ConnectionException" - -	- - 4440 : "com.cloud.exception.DiscoveredWithErrorException" - -
- - 4445 : "com.cloud.exception.DiscoveryException" - -	- - 4450 : "com.cloud.exception.HAStateException" - -	- - 4455 : "com.cloud.exception.InsufficientAddressCapacityException" - -
- - 4460 : "com.cloud.exception.InsufficientCapacityException" - -	- - 4465 : "com.cloud.exception.InsufficientNetworkCapacityException" - -	- - 4470 : "com.cloud.exception.InsufficientServerCapacityException" - -
- - 4475 : "com.cloud.exception.InsufficientStorageCapacityException" - -	- - 4480 : "com.cloud.exception.InsufficientVirtualNetworkCapcityException" - -	- - 4485 : "com.cloud.exception.InternalErrorException" - -
- - 4490 : "com.cloud.exception.InvalidParameterValueException" - -	- - 4495 : "com.cloud.exception.ManagementServerException" - -	- - 4500 : "com.cloud.exception.NetworkRuleConflictException" - -
- - 4505 : "com.cloud.exception.PermissionDeniedException" - -	- - 4510 : "com.cloud.exception.ResourceAllocationException" - -	- - 4515 : "com.cloud.exception.ResourceInUseException" - -
- - 4520 : "com.cloud.exception.ResourceUnavailableException" - -	- - 4525 : "com.cloud.exception.StorageUnavailableException" - -	- - 4530 : "com.cloud.exception.UnsupportedServiceException" - -
- - 4535 : "com.cloud.exception.VirtualMachineMigrationException" - -	- - 9999 : "com.cloud.api.ServerApiException" - -	- - -

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d8e31c7a/docs/tmp/en-US/html/whats-new-in-api-4.0.html ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/html/whats-new-in-api-4.0.html b/docs/tmp/en-US/html/whats-new-in-api-4.0.html deleted file mode 100644 index 09e4ebd..0000000 --- a/docs/tmp/en-US/html/whats-new-in-api-4.0.html +++ /dev/null @@ -1,538 +0,0 @@ - - -3.1. What's New in the API for 4.0

3.1. What's New in the API for 4.0

3.1.1. Changed API Commands in 4.0.0-incubating

- - API Commands - -	- - Description - -
- - copyTemplate - - - prepareTemplate - - - registerTemplate - - - updateTemplate - - - createProject - - - activateProject - - - suspendProject - - - updateProject - - - listProjectAccounts - - - createVolume - - - migrateVolume - - - attachVolume - - - detachVolume - - - uploadVolume - - - createSecurityGroup - - - registerIso - - - copyIso - - - updateIso - - - createIpForwardingRule - - - listIpForwardingRules - - - createLoadBalancerRule - - - updateLoadBalancerRule - - - createSnapshot - - -	- - The commands in this list have a single new response parameter, and no other changes. - - - New response parameter: tags() - - Note - Many other commands also have the new tags() parameter in addition to other changes; those commands are listed separately. - -
- - rebootVirtualMachine - - - attachIso - - - detachIso - - - listLoadBalancerRuleInstances - - - resetPasswordForVirtualMachine - - - changeServiceForVirtualMachine - - - recoverVirtualMachine - - - startVirtualMachine - - - migrateVirtualMachine - - - deployVirtualMachine - - - assignVirtualMachine - - - updateVirtualMachine - - - restoreVirtualMachine - - - stopVirtualMachine - - - destroyVirtualMachine - - -	- - The commands in this list have two new response parameters, and no other changes. - - - New response parameters: keypair, tags(*) - - -
- - listSecurityGroups - - - listFirewallRules - - - listPortForwardingRules - - - listSnapshots - - - listIsos - - - listProjects - - - listTemplates - - - listLoadBalancerRules - - -	- - The commands in this list have the following new parameters, and no other changes. - - - New request parameter: tags (optional) - - - New response parameter: tags(*) - - -
- - listF5LoadBalancerNetworks - - - listNetscalerLoadBalancerNetworks - - - listSrxFirewallNetworks - - - updateNetwork - - -	- - The commands in this list have three new response parameters, and no other changes. - - - New response parameters: canusefordeploy, vpcid, tags(*) - - -
- - createZone - - - updateZone - - -	- - The commands in this list have the following new parameters, and no other changes. - - - New request parameter: localstorageenabled (optional) - - - New response parameter: localstorageenabled - - -
- - listZones - -	- - New response parameter: localstorageenabled - -
- - rebootRouter - - - changeServiceForRouter - - - startRouter - - - destroyRouter - - - stopRouter - - -	- - The commands in this list have two new response parameters, and no other changes. - - - New response parameters: vpcid, nic(*) - -
- - updateAccount - - - disableAccount - - - listAccounts - - - markDefaultZoneForAccount - - - enableAccount - - -	- - The commands in this list have three new response parameters, and no other changes. - - - New response parameters: vpcavailable, vpclimit, vpctotal - -
- - listRouters - -	- - New request parameters: forvpc (optional), vpcid (optional) - - - New response parameters: vpcid, nic(*) - - -
- - listNetworkOfferings - -	- - New request parameters: forvpc (optional) - - - New response parameters: forvpc - - -
- - listVolumes - -	- - New request parameters: details (optional), tags (optional) - - - New response parameters: tags(*) - - -
- - addTrafficMonitor - -	- - New request parameters: excludezones (optional), includezones (optional) - - -
- - createNetwork - -	- - New request parameters: vpcid (optional) - - - New response parameters: canusefordeploy, vpcid, tags(*) - - -
- - listPublicIpAddresses - -	- - New request parameters: tags (optional), vpcid (optional) - - - New response parameters: vpcid, tags(*) - - -
- - listNetworks - -	- - New request parameters: canusefordeploy (optional), forvpc (optional), tags (optional), vpcid (optional) - - - New response parameters: canusefordeploy, vpcid, tags(*) - - -
- - restartNetwork - -	- - New response parameters: vpcid, tags(*) - - -
- - enableStaticNat - -	- - New request parameter: networkid (optional) - - -
- - createDiskOffering - -	- - New request parameter: storagetype (optional) - - - New response parameter: storagetype - - -
- - listDiskOfferings - -	- - New response parameter: storagetype - - -
- - updateDiskOffering - -	- - New response parameter: storagetype - - -
- - createFirewallRule - -	- - Changed request parameters: ipaddressid (old version - optional, new version - required) - - - New response parameter: tags(*) - - -
- - listVirtualMachines - -	- - New request parameters: isoid (optional), tags (optional), templateid (optional) - - - New response parameters: keypair, tags(*) - - -
- - updateStorageNetworkIpRange - -	- - New response parameters: id, endip, gateway, netmask, networkid, podid, startip, vlan, zoneid - - -

3.1.2. Added API Commands in 4.0.0-incubating

- createCounter (Adds metric counter) -
- deleteCounter (Deletes a counter) -
- listCounters (List the counters) -
- createCondition (Creates a condition) -
- deleteCondition (Removes a condition) -
- listConditions (List Conditions for the specific user) -

- createTags. Add tags to one or more resources. Example: -

command=createTags
-&resourceIds=1,10,12
-&resourceType=userVm
-&tags[0].key=region
-&tags[0].value=canada
-&tags[1].key=city
-&tags[1].value=Toronto

- deleteTags. Remove tags from one or more resources. Example: -

command=deleteTags
-&resourceIds=1,12
-&resourceType=Snapshot
-&tags[0].key=city

- listTags (Show currently defined resource tags) -
- createVPC (Creates a VPC) -
- listVPCs (Lists VPCs) -
- deleteVPC (Deletes a VPC) -
- updateVPC (Updates a VPC) -
- restartVPC (Restarts a VPC) -
- createVPCOffering (Creates VPC offering) -
- updateVPCOffering (Updates VPC offering) -
- deleteVPCOffering (Deletes VPC offering) -
- listVPCOfferings (Lists VPC offerings) -
- createPrivateGateway (Creates a private gateway) -
- listPrivateGateways (List private gateways) -
- deletePrivateGateway (Deletes a Private gateway) -
- createNetworkACL (Creates a ACL rule the given network (the network has to belong to VPC)) -
- deleteNetworkACL (Deletes a Network ACL) -
- listNetworkACLs (Lists all network ACLs) -
- createStaticRoute (Creates a static route) -
- deleteStaticRoute (Deletes a static route) -
- listStaticRoutes (Lists all static routes) -
- createVpnCustomerGateway (Creates site to site vpn customer gateway) -
- createVpnGateway (Creates site to site vpn local gateway) -
- createVpnConnection (Create site to site vpn connection) -
- deleteVpnCustomerGateway (Delete site to site vpn customer gateway) -
- deleteVpnGateway (Delete site to site vpn gateway) -
- deleteVpnConnection (Delete site to site vpn connection) -
- updateVpnCustomerGateway (Update site to site vpn customer gateway) -
- resetVpnConnection (Reset site to site vpn connection) -
- listVpnCustomerGateways (Lists site to site vpn customer gateways) -
- listVpnGateways (Lists site 2 site vpn gateways) -
- listVpnConnections (Lists site to site vpn connection gateways) -
- enableCiscoNexusVSM (Enables Nexus 1000v dvSwitch in CloudStack.) -
- disableCiscoNexusVSM (Disables Nexus 1000v dvSwitch in CloudStack.) -
- deleteCiscoNexusVSM (Deletes Nexus 1000v dvSwitch in CloudStack.) -
- listCiscoNexusVSMs (Lists the control VLAN ID, packet VLAN ID, and data VLAN ID, as well as the IP address of the Nexus 1000v dvSwitch.) -

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d8e31c7a/docs/tmp/en-US/html/whats-new.html ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/html/whats-new.html b/docs/tmp/en-US/html/whats-new.html deleted file mode 100644 index 64ee2cd..0000000 --- a/docs/tmp/en-US/html/whats-new.html +++ /dev/null @@ -1,5 +0,0 @@ - - -Chapter 3. What's New in the API?

Chapter 3. What's New in the API?

3.1. What's New in the API for 4.0

3.1.1. Changed API Commands in 4.0.0-incubating
3.1.2. Added API Commands in 4.0.0-incubating

3.2 . What's New in the API for 3.0

3.2.1. Enabling Port 8096
3.2.2. Stopped VM
3.2.3. Change to Behavior of List Commands
3.2.4. Removed API commands
3.2.5. Added API commands in 3.0
3.2.6. Added CloudStack Error Codes

- The following describes any new major features of each CloudStack version as it applies to API usage. -

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d8e31c7a/docs/tmp/en-US/html/who-should-read-installation.html ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/html/who-should-read-installation.html b/docs/tmp/en-US/html/who-should-read-installation.html deleted file mode 100644 index 65dffee..0000000 --- a/docs/tmp/en-US/html/who-should-read-installation.html +++ /dev/null @@ -1,5 +0,0 @@ - - -4.1. Who Should Read This

4.1. Who Should Read This

- For those who have already gone through a design phase and planned a more sophisticated deployment, or those who are ready to start scaling up a trial installation. With the following procedures, you can start using the more powerful features of CloudStack, such as advanced VLAN networking, high availability, additional network elements such as load balancers and firewalls, and support for multiple hypervisors including Citrix XenServer, KVM, and VMware vSphere. -

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d8e31c7a/docs/tmp/en-US/html/work-with-usage.html ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/html/work-with-usage.html b/docs/tmp/en-US/html/work-with-usage.html deleted file mode 100644 index 2331216..0000000 --- a/docs/tmp/en-US/html/work-with-usage.html +++ /dev/null @@ -1,9 +0,0 @@ - - -Chapter 14. Working with Usage

Chapter 14. Working with Usage

14.1. Configuring the Usage Server
14.2. Setting Usage Limits
14.3. Globally Configured Limits
14.4. Default Account Resource Limits
14.5. Per-Domain Limits

- The Usage Server is an optional, separately-installed part of CloudStack that provides aggregated usage records which you can use to create billing integration for CloudStack. The Usage Server works by taking data from the events log and creating summary usage records that you can access using the listUsageRecords API call. -

- The usage records show the amount of resources, such as VM run time or template storage space, consumed by guest instances. -

- The Usage Server runs at least once per day. It can be configured to run multiple times per day. -

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d8e31c7a/docs/tmp/en-US/html/working-with-hosts.html ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/html/working-with-hosts.html b/docs/tmp/en-US/html/working-with-hosts.html deleted file mode 100644 index 0feebfb..0000000 --- a/docs/tmp/en-US/html/working-with-hosts.html +++ /dev/null @@ -1,3 +0,0 @@ - - -Chapter 11. Working With Hosts

Chapter 11. Working With Hosts

11.1. Adding Hosts

11.2. Scheduled Maintenance and Maintenance Mode for Hosts

11.3. Disabling and Enabling Zones, Pods, and Clusters

11.4. Removing Hosts

11.4.1. Removing XenServer and KVM Hosts
11.4.2. Removing vSphere Hosts

11.5. Re-Installing Hosts

11.6. Maintaining Hypervisors on Hosts

11.7. Changing Host Password

11.8. Host Allocation

11.9. VLAN Provisioning

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d8e31c7a/docs/tmp/en-US/html/working-with-iso.html ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/html/working-with-iso.html b/docs/tmp/en-US/html/working-with-iso.html deleted file mode 100644 index 675513b..0000000 --- a/docs/tmp/en-US/html/working-with-iso.html +++ /dev/null @@ -1,125 +0,0 @@ - - -10.11. Working with ISOs

10.11. Working with ISOs

- CloudStack supports ISOs and their attachment to guest VMs. An ISO is a read-only file that has an ISO/CD-ROM style file system. Users can upload their own ISOs and mount them on their guest VMs. -

- ISOs are uploaded based on a URL. HTTP is the supported protocol. Once the ISO is available via HTTP specify an upload URL such as http://my.web.server/filename.iso. -

- ISOs may be public or private, like templates.ISOs are not hypervisor-specific. That is, a guest on vSphere can mount the exact same image that a guest on KVM can mount. -

- ISO images may be stored in the system and made available with a privacy level similar to templates. ISO images are classified as either bootable or not bootable. A bootable ISO image is one that contains an OS image. CloudStack allows a user to boot a guest VM off of an ISO image. Users can also attach ISO images to guest VMs. For example, this enables installing PV drivers into Windows. ISO images are not hypervisor-specific. -

10.11.1. Adding an ISO

- To make additional operating system or other software available for use with guest VMs, you can add an ISO. The ISO is typically thought of as an operating system image, but you can also add ISOs for other types of software, such as desktop applications that you want to be installed as part of a template. -

- Log in to the CloudStack UI as an administrator or end user. -
- In the left navigation bar, click Templates. -
- In Select View, choose ISOs. -
- Click Add ISO. -

- In the Add ISO screen, provide the following: -

- Name: Short name for the ISO image. For example, CentOS 6.2 64-bit. -
- Description: Display test for the ISO image. For example, CentOS 6.2 64-bit. -
- URL: The URL that hosts the ISO image. The Management Server must be able to access this location via HTTP. If needed you can place the ISO image directly on the Management Server -
- Zone: Choose the zone where you want the ISO to be available, or All Zones to make it available throughout CloudStack. -
- Bootable: Whether or not a guest could boot off this ISO image. For example, a CentOS ISO is bootable, a Microsoft Office ISO is not bootable. -

- OS Type: This helps CloudStack and the hypervisor perform certain operations and make assumptions that improve the performance of the guest. Select one of the following. -

- If the operating system of your desired ISO image is listed, choose it. -
- If the OS Type of the ISO is not listed or if the ISO is not bootable, choose Other. -
- (XenServer only) If you want to boot from this ISO in PV mode, choose Other PV (32-bit) or Other PV (64-bit) -

- (KVM only) If you choose an OS that is PV-enabled, the VMs created from this ISO will have a SCSI (virtio) root disk. If the OS is not PV-enabled, the VMs will have an IDE root disk. The PV-enabled types are: -

- - Fedora 13 - -	- - Fedora 12 - -	- - Fedora 11 - -
- - Fedora 10 - -	- - Fedora 9 - -	- - Other PV - -
- - Debian GNU/Linux - -	- - CentOS 5.3 - -	- - CentOS 5.4 - -
- - CentOS 5.5 - -	- - Red Hat Enterprise Linux 5.3 - -	- - Red Hat Enterprise Linux 5.4 - -
- - Red Hat Enterprise Linux 5.5 - -	- - Red Hat Enterprise Linux 6 - -	-

Note

- It is not recommended to choose an older version of the OS than the version in the image. For example, choosing CentOS 5.4 to support a CentOS 6.2 image will usually not work. In these cases, choose Other. -

- Extractable: Choose Yes if the ISO should be available for extraction. -
- Public: Choose Yes if this ISO should be available to other users. -
- Featured: Choose Yes if you would like this ISO to be more prominent for users to select. The ISO will appear in the Featured ISOs list. Only an administrator can make an ISO Featured. -

- Click OK. -
- The Management Server will download the ISO. Depending on the size of the ISO, this may take a long time. The ISO status column will display Ready once it has been successfully downloaded into secondary storage. Clicking Refresh updates the download percentage. -
- Important: Wait for the ISO to finish downloading. If you move on to the next task and try to use the ISO right away, it will appear to fail. The entire ISO must be available before CloudStack can work with it. -

10.11.2. Attaching an ISO to a VM

- In the left navigation, click Instances. -
- Choose the virtual machine you want to work with. -
- Click the Attach ISO button - -
- In the Attach ISO dialog box, select the desired ISO. -
- Click OK -

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d8e31c7a/docs/tmp/en-US/html/working-with-snapshots.html ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/html/working-with-snapshots.html b/docs/tmp/en-US/html/working-with-snapshots.html deleted file mode 100644 index 81b8674..0000000 --- a/docs/tmp/en-US/html/working-with-snapshots.html +++ /dev/null @@ -1,13 +0,0 @@ - - -13.5. Working with Snapshots

13.5. Working with Snapshots

- (Supported for the following hypervisors: XenServer, VMware vSphere, and KVM) -

- CloudStack supports snapshots of disk volumes. Snapshots are a point-in-time capture of virtual machine disks. Memory and CPU states are not captured. -

- Snapshots may be taken for volumes, including both root and data disks. The administrator places a limit on the number of stored snapshots per user. Users can create new volumes from the snapshot for recovery of particular files and they can create templates from snapshots to boot from a restored disk. -

- Users can create snapshots manually or by setting up automatic recurring snapshot policies. Users can also create disk volumes from snapshots, which may be attached to a VM like any other disk volume. Snapshots of both root disks and data disks are supported. However, CloudStack does not currently support booting a VM from a recovered root disk. A disk recovered from snapshot of a root disk is treated as a regular data disk; the data on recovered disk can be accessed by attaching the disk to a VM. -

- A completed snapshot is copied from primary storage to secondary storage, where it is stored until deleted or purged by newer snapshot. -

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d8e31c7a/docs/tmp/en-US/html/working-with-system-vm.html ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/html/working-with-system-vm.html b/docs/tmp/en-US/html/working-with-system-vm.html deleted file mode 100644 index 0b1e9b3..0000000 --- a/docs/tmp/en-US/html/working-with-system-vm.html +++ /dev/null @@ -1,5 +0,0 @@ - - -Chapter 16. Working with System Virtual Machines

Chapter 16. Working with System Virtual Machines

16.1. The System VM Template
16.2. Multiple System VM Support for VMware
16.3. Console Proxy
16.4. Virtual Router
16.5. Secondary Storage VM

- CloudStack uses several types of system virtual machines to perform tasks in the cloud. In general CloudStack manages these system VMs and creates, starts, and stops them as needed based on scale and immediate needs. However, the administrator should be aware of them and their roles to assist in debugging issues. -

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/d8e31c7a/docs/tmp/en-US/html/working-with-templates.html ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/html/working-with-templates.html b/docs/tmp/en-US/html/working-with-templates.html deleted file mode 100644 index 41a61b6..0000000 --- a/docs/tmp/en-US/html/working-with-templates.html +++ /dev/null @@ -1,9 +0,0 @@ - - -Chapter 12. Working with Templates

Chapter 12. Working with Templates

12.1. Creating Templates: Overview

12.2. Requirements for Templates

12.3. Best Practices for Templates

12.4. The Default Template

12.5. Private and Public Templates

12.6. Creating a Template from an Existing Virtual Machine

12.7. Creating a Template from a Snapshot

12.8. Uploading Templates

12.9. Exporting Templates

12.10. Creating a Windows Template

12.10.1. System Preparation for Windows Server 2008 R2
12.10.2. Sysprep for Windows Server 2003 R2

12.11. Importing Amazon Machine Images

12.12. Converting a Hyper-V VM to a Template

12.13. Adding Password Management to Your Templates

12.13.1. Linux OS Installation
12.13.2. Windows OS Installation

12.14. Deleting Templates

- A template is a reusable configuration for virtual machines. When users launch VMs, they can choose from a list of templates in CloudStack. -

- Specifically, a template is a virtual disk image that includes one of a variety of operating systems, optional additional software such as office applications, and settings such as access control to determine who can use the template. Each template is associated with a particular type of hypervisor, which is specified when the template is added to CloudStack. -

- CloudStack ships with a default template. In order to present more choices to users, CloudStack administrators and users can create templates and add them to CloudStack. -