cloudstack-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From seb...@apache.org
Subject [1/3] lots of cleanup of the admin guide
Date Mon, 24 Feb 2014 19:03:03 GMT
Repository: cloudstack-docs-admin
Updated Branches:
  refs/heads/master 077f90ff4 -> 767f408f1


http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/blob/767f408f/source/ui.rst
----------------------------------------------------------------------
diff --git a/source/ui.rst b/source/ui.rst
index 9638800..49354db 100644
--- a/source/ui.rst
+++ b/source/ui.rst
@@ -12,13 +12,12 @@
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
-   
 
 User Interface
 ==============
 
 Log In to the UI
----------------------
+----------------
 
 CloudStack provides a web-based UI that can be used by both
 administrators and end users. The appropriate version of the UI is
@@ -27,7 +26,7 @@ available in popular browsers including IE7, IE8, IE9, Firefox 3.5+,
 Firefox 4, Safari 4, and Safari 5. The URL is: (substitute your own
 management server IP address)
 
-.. code:: bash
+.. sourcecode:: bash
 
     http://<management-server-ip-address>:8080/client
 
@@ -35,21 +34,12 @@ On a fresh Management Server installation, a guided tour splash screen
 appears. On later visits, you’ll see a login screen where you specify
 the following to proceed to your Dashboard:
 
-Username
-''''''''
+Username -> The user ID of your account. The default username is admin.
 
-The user ID of your account. The default username is admin.
-
-Password
-''''''''
-
-The password associated with the user ID. The password for the default
+Password -> The password associated with the user ID. The password for the default
 username is password.
 
-Domain
-''''''
-
-If you are a root user, leave this field blank.
+Domain -> If you are a root user, leave this field blank.
 
 If you are a user in the sub-domains, enter the full path to the domain,
 excluding the root domain.
@@ -63,7 +53,7 @@ For more guidance about the choices that appear when you log in to this
 UI, see Logging In as the Root Administrator.
 
 End User's UI Overview
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~
 
 The CloudStack UI helps users of cloud infrastructure to view and use
 their cloud resources, including virtual machines, templates and ISOs,
@@ -72,7 +62,7 @@ user is a member or administrator of one or more CloudStack projects,
 the UI can provide a project-oriented view.
 
 Root Administrator's UI Overview
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The CloudStack UI helps the CloudStack administrator provision, view,
 and manage the cloud infrastructure, domains, user accounts, projects,
@@ -85,7 +75,7 @@ administrative functions. The root administrator can also use the UI to
 perform all the same tasks that are present in the end-user’s UI.
 
 Logging In as the Root Administrator
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 After the Management Server software is installed and running, you can
 run the CloudStack user interface. This UI is there to help you
@@ -96,7 +86,7 @@ provision, view, and manage your cloud infrastructure.
    Open your favorite Web browser and go to this URL. Substitute the IP
    address of your own Management Server:
 
-   .. code:: bash
+   .. sourcecode:: bash
 
        http://<management-server-ip-address>:8080/client
 
@@ -143,15 +133,12 @@ provision, view, and manage your cloud infrastructure.
    chose experienced user, use the steps in `Section 5.1.4, “Changing
    the Root Password” <#changing-root-password>`__.
 
-.. warning:: You are logging in as the root administrator. This account manages the
-CloudStack deployment, including physical infrastructure. The root
-administrator can modify configuration settings to change basic
-functionality, create or delete user accounts, and take many actions
-that should be performed only by an authorized person. Please change the
-default password to a new, unique password.
+.. warning:: 
+
+   You are logging in as the root administrator. This account manages the CloudStack deployment,
including physical infrastructure. The root administrator can modify configuration settings
to change basic functionality, create or delete user accounts, and take many actions that
should be performed only by an authorized person. Please change the default password to a
new, unique password.
 
 Changing the Root Password
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 During installation and ongoing cloud administration, you will need to
 log in to the UI as the root administrator. The root administrator
@@ -167,7 +154,7 @@ new, unique value.
    Open your favorite Web browser and go to this URL. Substitute the IP
    address of your own Management Server:
 
-   .. code:: bash
+   .. sourcecode:: bash
 
        http://<management-server-ip-address>:8080/client
 
@@ -202,7 +189,7 @@ new, unique value.
    Type the new password, and click OK.
 
 Using SSH Keys for Authentication
---------------------------------------
+---------------------------------
 
 In addition to the username and password authentication, CloudStack
 supports using SSH keys to log in to the cloud infrastructure for
@@ -214,9 +201,9 @@ in to another cloud user's instances unless they share their SSH key
 files. Using a single SSH key pair, you can manage multiple instances.
 
 Creating an Instance Template that Supports SSH Keys
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Create a instance template that supports SSH Keys.
+Create an instance template that supports SSH Keys.
 
 #. 
 
@@ -230,7 +217,7 @@ Create a instance template that supports SSH Keys.
    Script <http://sourceforge.net/projects/cloudstack/files/SSH%20Key%20Gen%20Script/>`__\
to
    the instance you have created.
 
-   .. code:: bash
+   .. sourcecode:: bash
 
        wget http://downloads.sourceforge.net/project/cloudstack/SSH%20Key%20Gen%20Script/cloud-set-guest-sshkey.in?r=http%3A%2F%2Fsourceforge.net%2Fprojects%2Fcloudstack%2Ffiles%2FSSH%2520Key%2520Gen%2520Script%2F&ts=1331225219&use_mirror=iweb
 
@@ -238,7 +225,7 @@ Create a instance template that supports SSH Keys.
 
    Copy the file to /etc/init.d.
 
-   .. code:: bash
+   .. sourcecode:: bash
 
        cp cloud-set-guest-sshkey.in /etc/init.d/
 
@@ -246,7 +233,7 @@ Create a instance template that supports SSH Keys.
 
    Give the necessary permissions on the script:
 
-   .. code:: bash
+   .. sourcecode:: bash
 
        chmod +x /etc/init.d/cloud-set-guest-sshkey.in
 
@@ -254,7 +241,7 @@ Create a instance template that supports SSH Keys.
 
    Run the script while starting up the operating system:
 
-   .. code:: bash
+   .. sourcecode:: bash
 
        chkconfig --add cloud-set-guest-sshkey.in
 
@@ -263,7 +250,7 @@ Create a instance template that supports SSH Keys.
    Stop the instance.
 
 Creating the SSH Keypair
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 You must make a call to the createSSHKeyPair api method. You can either
 use the CloudStack Python API library or the curl commands to make the
@@ -272,21 +259,19 @@ call to the cloudstack api.
 For example, make a call from the cloudstack server to create a SSH
 keypair called "keypair-doc" for the admin account in the root domain:
 
-.. note:: Ensure that you adjust these values to meet your needs. If you are
-making the API call from a different server, your URL/PORT will be
-different, and you will need to use the API keys.
+.. note:: Ensure that you adjust these values to meet your needs. If you are making the API
call from a different server, your URL/PORT will be different, and you will need to use the
API keys.
 
 #. 
 
    Run the following curl command:
 
-   .. code:: bash
+   .. sourcecode:: bash
 
        curl --globoff "http://localhost:8096/?command=createSSHKeyPair&name=keypair-doc&account=admin&domainid=5163440e-c44b-42b5-9109-ad75cae8e8a2"
 
    The output is something similar to what is given below:
 
-   .. code:: bash
+   .. sourcecode:: bash
 
        <?xml version="1.0" encoding="ISO-8859-1"?><createsshkeypairresponse cloud-stack-version="3.0.0.20120228045507"><keypair><name>keypair-doc</name><fingerprint>f6:77:39:d5:5e:77:02:22:6a:d8:7f:ce:ab:cd:b3:56</fingerprint><privatekey>-----BEGIN
RSA PRIVATE KEY-----
        MIICXQIBAAKBgQCSydmnQ67jP6lNoXdX3noZjQdrMAWNQZ7y5SrEu4wDxplvhYci
@@ -306,7 +291,7 @@ different, and you will need to use the API keys.
 
    Copy the key data into a file. The file looks like this:
 
-   .. code:: bash
+   .. sourcecode:: bash
 
        -----BEGIN RSA PRIVATE KEY-----
        MIICXQIBAAKBgQCSydmnQ67jP6lNoXdX3noZjQdrMAWNQZ7y5SrEu4wDxplvhYci
@@ -326,7 +311,7 @@ different, and you will need to use the API keys.
    Save the file.
 
 Creating an Instance
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~
 
 After you save the SSH keypair file, you must create an instance by
 using the template that you created at `Section 5.2.1, “ Creating an
@@ -334,12 +319,13 @@ Instance Template that Supports SSH Keys” <#create-ssh-template>`__.
 Ensure that you use the same SSH key name that you created at
 `Section 5.2.2, “Creating the SSH Keypair” <#create-ssh-keypair>`__.
 
-.. note:: You cannot create the instance by using the GUI at this time and
-associate the instance with the newly created SSH keypair.
+.. note:: 
+
+   You cannot create the instance by using the GUI at this time and associate the instance
with the newly created SSH keypair.
 
 A sample curl command to create a new instance is:
 
-.. code:: bash
+.. sourcecode:: bash
 
     curl --globoff http://localhost:<port number>/?command=deployVirtualMachine\&zoneId=1\&serviceOfferingId=18727021-7556-4110-9322-d625b52e0813\&templateId=e899c18a-ce13-4bbf-98a9-625c5026e0b5\&securitygroupids=ff03f02f-9e3b-48f8-834d-91b822da40c5\&account=admin\&domainid=1\&keypair=keypair-doc
 
@@ -348,27 +334,25 @@ are using the security group feature) that are in your cloud
 environment.
 
 Logging In Using the SSH Keypair
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 To test your SSH key generation is successful, check whether you can log
 in to the cloud setup.
 
-For exaple, from a Linux OS, run:
+For example, from a Linux OS, run:
 
-.. code:: bash
+.. sourcecode:: bash
 
     ssh -i ~/.ssh/keypair-doc <ip address>
 
 The -i parameter tells the ssh client to use a ssh key found at
 ~/.ssh/keypair-doc.
 
-5.2.5. Resetting SSH Keys
-~~~~~~~~~~~~~~~~~~~~~~~~~
+Resetting SSH Keys
+~~~~~~~~~~~~~~~~~~
 
 With the API command resetSSHKeyForVirtualMachine, a user can set or
 reset the SSH keypair assigned to a virtual machine. A lost or
 compromised SSH keypair can be changed, and the user can access the VM
 by using the new keypair. Just create or register a new keypair, then
-call resetSSHKeyForVirtualMachine.
-
-
+call resetSSHKeyForVirtualMachine.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/blob/767f408f/source/usage.rst
----------------------------------------------------------------------
diff --git a/source/usage.rst b/source/usage.rst
index 07a252f..ed27b86 100644
--- a/source/usage.rst
+++ b/source/usage.rst
@@ -75,13 +75,9 @@ To configure the usage server:
 The following table shows the global configuration settings that control
 the behavior of the Usage Server.
 
-Parameter Name
-
-Description
+Parameter Name  Description
 
-enable.usage.server
-
-Whether the Usage Server is active.
+enable.usage.server  Whether the Usage Server is active.
 
 usage.aggregation.timezone
 
@@ -190,13 +186,8 @@ resource usage by users. Some of these limits are global configuration
 parameters. Others are applied at the ROOT domain and may be overridden
 on a per-account basis.
 
-Aggregate limits may be set on a per-domain basis. For example, you may
-limit a domain and all subdomains to the creation of 100 VMs.
-
-This section covers the following topics:
-
 Globally Configured Limits
---------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 In a zone, the guest virtual network has a 24 bit CIDR by default. This
 limits the guest virtual network to 254 running instances. It can be
@@ -206,77 +197,40 @@ addresses.
 
 The following table lists limits set in the Global Configuration:
 
-Parameter Name
-
-Definition
-
-max.account.public.ips
-
-Number of public IP addresses that can be owned by an account
-
-max.account.snapshots
-
-Number of snapshots that can exist for an account
-
-max.account.templates
-
-Number of templates that can exist for an account
-
-max.account.user.vms
-
-Number of virtual machine instances that can exist for an account
-
-max.account.volumes
-
-Number of disk volumes that can exist for an account
-
-max.template.iso.size
-
-Maximum size for a downloaded template or ISO in GB
-
-max.volume.size.gb
-
-Maximum size for a volume in GB
-
-network.throttling.rate
-
-Default data transfer rate in megabits per second allowed per user
-(supported on XenServer)
-
-snapshot.max.hourly
-
-Maximum recurring hourly snapshots to be retained for a volume. If the
-limit is reached, early snapshots from the start of the hour are deleted
-so that newer ones can be saved. This limit does not apply to manual
-snapshots. If set to 0, recurring hourly snapshots can not be scheduled
-
-snapshot.max.daily
-
-Maximum recurring daily snapshots to be retained for a volume. If the
-limit is reached, snapshots from the start of the day are deleted so
-that newer ones can be saved. This limit does not apply to manual
-snapshots. If set to 0, recurring daily snapshots can not be scheduled
-
-snapshot.max.weekly
-
-Maximum recurring weekly snapshots to be retained for a volume. If the
-limit is reached, snapshots from the beginning of the week are deleted
-so that newer ones can be saved. This limit does not apply to manual
-snapshots. If set to 0, recurring weekly snapshots can not be scheduled
-
-snapshot.max.monthly
-
-Maximum recurring monthly snapshots to be retained for a volume. If the
-limit is reached, snapshots from the beginning of the month are deleted
-so that newer ones can be saved. This limit does not apply to manual
-snapshots. If set to 0, recurring monthly snapshots can not be
-scheduled.
++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Parameter Name            | Definition                                                
                                                                                         
                                                                                         
                                                  |
++===========================+==================================================================================================================================================================================================================================================================================================+
+| max.account.public.ips    | Number of public IP addresses that can be owned by an account
                                                                                         
                                                                                         
                                               |
++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| max.account.snapshots     | Number of snapshots that can exist for an account         
                                                                                         
                                                                                         
                                                  |
++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| max.account.templates     | Number of templates that can exist for an account         
                                                                                         
                                                                                         
                                                  |
++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| max.account.user.vms      | Number of virtual machine instances that can exist for an account
                                                                                         
                                                                                         
                                           |
++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| max.account.volumes       | Number of disk volumes that can exist for an account      
                                                                                         
                                                                                         
                                                  |
++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| max.template.iso.size     | Maximum size for a downloaded template or ISO in GB       
                                                                                         
                                                                                         
                                                  |
++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| max.volume.size.gb        | Maximum size for a volume in GB                           
                                                                                         
                                                                                         
                                                  |
++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| network.throttling.rate   | Default data transfer rate in megabits per second allowed per
user (supported on XenServer)                                                            
                                                                                         
                                               |
++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| snapshot.max.hourly       | Maximum recurring hourly snapshots to be retained for a volume.
If the limit is reached, early snapshots from the start of the hour are deleted so that newer
ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring hourly
snapshots can not be scheduled     |
++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| snapshot.max.daily        | Maximum recurring daily snapshots to be retained for a volume.
If the limit is reached, snapshots from the start of the day are deleted so that newer ones
can be saved. This limit does not apply to manual snapshots. If set to 0, recurring daily
snapshots can not be scheduled              |
++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| snapshot.max.weekly       | Maximum recurring weekly snapshots to be retained for a volume.
If the limit is reached, snapshots from the beginning of the week are deleted so that newer
ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring weekly
snapshots can not be scheduled       |
++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| snapshot.max.monthly      | Maximum recurring monthly snapshots to be retained for a volume.
If the limit is reached, snapshots from the beginning of the month are deleted so that newer
ones can be saved. This limit does not apply to manual snapshots. If set to 0, recurring monthly
snapshots can not be scheduled.   |
++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 To modify global configuration parameters, use the global configuration
 screen in the CloudStack UI. See Setting Global Configuration Parameters
 
+
 Limiting Resource Usage
------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~
 
 CloudStack allows you to control resource usage based on the types of
 resources, such as CPU, RAM, Primary storage, and Secondary storage. A
@@ -617,3 +571,636 @@ resource limit.
 
    Click Apply.
 
+
+Usage Record Format
+-------------------
+
+Virtual Machine Usage Record Format
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For running and allocated virtual machine usage, the following fields
+exist in a usage record:
+
+-  
+
+   account – name of the account
+
+-  
+
+   accountid – ID of the account
+
+-  
+
+   domainid – ID of the domain in which this account resides
+
+-  
+
+   zoneid – Zone where the usage occurred
+
+-  
+
+   description – A string describing what the usage record is tracking
+
+-  
+
+   usage – String representation of the usage, including the units of
+   usage (e.g. 'Hrs' for VM running time)
+
+-  
+
+   usagetype – A number representing the usage type (see Usage Types)
+
+-  
+
+   rawusage – A number representing the actual usage in hours
+
+-  
+
+   virtualMachineId – The ID of the virtual machine
+
+-  
+
+   name – The name of the virtual machine
+
+-  
+
+   offeringid – The ID of the service offering
+
+-  
+
+   templateid – The ID of the template or the ID of the parent template.
+   The parent template value is present when the current template was
+   created from a volume.
+
+-  
+
+   usageid – Virtual machine
+
+-  
+
+   type – Hypervisor
+
+-  
+
+   startdate, enddate – The range of time for which the usage is
+   aggregated; see Dates in the Usage Record
+
+Network Usage Record Format
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For network usage (bytes sent/received), the following fields exist in a
+usage record.
+
+-  
+
+   account – name of the account
+
+-  
+
+   accountid – ID of the account
+
+-  
+
+   domainid – ID of the domain in which this account resides
+
+-  
+
+   zoneid – Zone where the usage occurred
+
+-  
+
+   description – A string describing what the usage record is tracking
+
+-  
+
+   usagetype – A number representing the usage type (see Usage Types)
+
+-  
+
+   rawusage – A number representing the actual usage in hours
+
+-  
+
+   usageid – Device ID (virtual router ID or external device ID)
+
+-  
+
+   type – Device type (domain router, external load balancer, etc.)
+
+-  
+
+   startdate, enddate – The range of time for which the usage is
+   aggregated; see Dates in the Usage Record
+
+IP Address Usage Record Format
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For IP address usage the following fields exist in a usage record.
+
+-  
+
+   account - name of the account
+
+-  
+
+   accountid - ID of the account
+
+-  
+
+   domainid - ID of the domain in which this account resides
+
+-  
+
+   zoneid - Zone where the usage occurred
+
+-  
+
+   description - A string describing what the usage record is tracking
+
+-  
+
+   usage - String representation of the usage, including the units of
+   usage
+
+-  
+
+   usagetype - A number representing the usage type (see Usage Types)
+
+-  
+
+   rawusage - A number representing the actual usage in hours
+
+-  
+
+   usageid - IP address ID
+
+-  
+
+   startdate, enddate - The range of time for which the usage is
+   aggregated; see Dates in the Usage Record
+
+-  
+
+   issourcenat - Whether source NAT is enabled for the IP address
+
+-  
+
+   iselastic - True if the IP address is elastic.
+
+Disk Volume Usage Record Format
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For disk volumes, the following fields exist in a usage record.
+
+-  
+
+   account – name of the account
+
+-  
+
+   accountid – ID of the account
+
+-  
+
+   domainid – ID of the domain in which this account resides
+
+-  
+
+   zoneid – Zone where the usage occurred
+
+-  
+
+   description – A string describing what the usage record is tracking
+
+-  
+
+   usage – String representation of the usage, including the units of
+   usage (e.g. 'Hrs' for hours)
+
+-  
+
+   usagetype – A number representing the usage type (see Usage Types)
+
+-  
+
+   rawusage – A number representing the actual usage in hours
+
+-  
+
+   usageid – The volume ID
+
+-  
+
+   offeringid – The ID of the disk offering
+
+-  
+
+   type – Hypervisor
+
+-  
+
+   templateid – ROOT template ID
+
+-  
+
+   size – The amount of storage allocated
+
+-  
+
+   startdate, enddate – The range of time for which the usage is
+   aggregated; see Dates in the Usage Record
+
+Template, ISO, and Snapshot Usage Record Format
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+-  
+
+   account – name of the account
+
+-  
+
+   accountid – ID of the account
+
+-  
+
+   domainid – ID of the domain in which this account resides
+
+-  
+
+   zoneid – Zone where the usage occurred
+
+-  
+
+   description – A string describing what the usage record is tracking
+
+-  
+
+   usage – String representation of the usage, including the units of
+   usage (e.g. 'Hrs' for hours)
+
+-  
+
+   usagetype – A number representing the usage type (see Usage Types)
+
+-  
+
+   rawusage – A number representing the actual usage in hours
+
+-  
+
+   usageid – The ID of the the template, ISO, or snapshot
+
+-  
+
+   offeringid – The ID of the disk offering
+
+-  
+
+   templateid – – Included only for templates (usage type 7). Source
+   template ID.
+
+-  
+
+   size – Size of the template, ISO, or snapshot
+
+-  
+
+   startdate, enddate – The range of time for which the usage is
+   aggregated; see Dates in the Usage Record
+
+Load Balancer Policy or Port Forwarding Rule Usage Record Format
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+-  
+
+   account - name of the account
+
+-  
+
+   accountid - ID of the account
+
+-  
+
+   domainid - ID of the domain in which this account resides
+
+-  
+
+   zoneid - Zone where the usage occurred
+
+-  
+
+   description - A string describing what the usage record is tracking
+
+-  
+
+   usage - String representation of the usage, including the units of
+   usage (e.g. 'Hrs' for hours)
+
+-  
+
+   usagetype - A number representing the usage type (see Usage Types)
+
+-  
+
+   rawusage - A number representing the actual usage in hours
+
+-  
+
+   usageid - ID of the load balancer policy or port forwarding rule
+
+-  
+
+   usagetype - A number representing the usage type (see Usage Types)
+
+-  
+
+   startdate, enddate - The range of time for which the usage is
+   aggregated; see Dates in the Usage Record
+
+Network Offering Usage Record Format
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+-  
+
+   account – name of the account
+
+-  
+
+   accountid – ID of the account
+
+-  
+
+   domainid – ID of the domain in which this account resides
+
+-  
+
+   zoneid – Zone where the usage occurred
+
+-  
+
+   description – A string describing what the usage record is tracking
+
+-  
+
+   usage – String representation of the usage, including the units of
+   usage (e.g. 'Hrs' for hours)
+
+-  
+
+   usagetype – A number representing the usage type (see Usage Types)
+
+-  
+
+   rawusage – A number representing the actual usage in hours
+
+-  
+
+   usageid – ID of the network offering
+
+-  
+
+   usagetype – A number representing the usage type (see Usage Types)
+
+-  
+
+   offeringid – Network offering ID
+
+-  
+
+   virtualMachineId – The ID of the virtual machine
+
+-  
+
+   virtualMachineId – The ID of the virtual machine
+
+-  
+
+   startdate, enddate – The range of time for which the usage is
+   aggregated; see Dates in the Usage Record
+
+VPN User Usage Record Format
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+-  
+
+   account – name of the account
+
+-  
+
+   accountid – ID of the account
+
+-  
+
+   domainid – ID of the domain in which this account resides
+
+-  
+
+   zoneid – Zone where the usage occurred
+
+-  
+
+   description – A string describing what the usage record is tracking
+
+-  
+
+   usage – String representation of the usage, including the units of
+   usage (e.g. 'Hrs' for hours)
+
+-  
+
+   usagetype – A number representing the usage type (see Usage Types)
+
+-  
+
+   rawusage – A number representing the actual usage in hours
+
+-  
+
+   usageid – VPN user ID
+
+-  
+
+   usagetype – A number representing the usage type (see Usage Types)
+
+-  
+
+   startdate, enddate – The range of time for which the usage is
+   aggregated; see Dates in the Usage Record
+
+
+Usage Types
+-----------
+
+The following table shows all usage types.
+
++------------------+-----------------------------------+-----------------------+
+| Type ID          | Type Name                         | Description           |
++==================+===================================+=======================+
+| 1                | RUNNING\_VM                       | Tracks the total      |
+|                  |                                   | running time of a VM  |
+|                  |                                   | per usage record      |
+|                  |                                   | period. If the VM is  |
+|                  |                                   | upgraded during the   |
+|                  |                                   | usage period, you     |
+|                  |                                   | will get a separate   |
+|                  |                                   | Usage Record for the  |
+|                  |                                   | new upgraded VM.      |
++------------------+-----------------------------------+-----------------------+
+| 2                | ALLOCATED\_VM                     | Tracks the total time |
+|                  |                                   | the VM has been       |
+|                  |                                   | created to the time   |
+|                  |                                   | when it has been      |
+|                  |                                   | destroyed. This usage |
+|                  |                                   | type is also useful   |
+|                  |                                   | in determining usage  |
+|                  |                                   | for specific          |
+|                  |                                   | templates such as     |
+|                  |                                   | Windows-based         |
+|                  |                                   | templates.            |
++------------------+-----------------------------------+-----------------------+
+| 3                | IP\_ADDRESS                       | Tracks the public IP  |
+|                  |                                   | address owned by the  |
+|                  |                                   | account.              |
++------------------+-----------------------------------+-----------------------+
+| 4                | NETWORK\_BYTES\_SENT              | Tracks the total      |
+|                  |                                   | number of bytes sent  |
+|                  |                                   | by all the VMs for an |
+|                  |                                   | account. Cloud.com    |
+|                  |                                   | does not currently    |
+|                  |                                   | track network traffic |
+|                  |                                   | per VM.               |
++------------------+-----------------------------------+-----------------------+
+| 5                | NETWORK\_BYTES\_RECEIVED          | Tracks the total      |
+|                  |                                   | number of bytes       |
+|                  |                                   | received by all the   |
+|                  |                                   | VMs for an account.   |
+|                  |                                   | Cloud.com does not    |
+|                  |                                   | currently track       |
+|                  |                                   | network traffic per   |
+|                  |                                   | VM.                   |
++------------------+-----------------------------------+-----------------------+
+| 6                | VOLUME                            | Tracks the total time |
+|                  |                                   | a disk volume has     |
+|                  |                                   | been created to the   |
+|                  |                                   | time when it has been |
+|                  |                                   | destroyed.            |
++------------------+-----------------------------------+-----------------------+
+| 7                | TEMPLATE                          | Tracks the total time |
+|                  |                                   | a template (either    |
+|                  |                                   | created from a        |
+|                  |                                   | snapshot or uploaded  |
+|                  |                                   | to the cloud) has     |
+|                  |                                   | been created to the   |
+|                  |                                   | time it has been      |
+|                  |                                   | destroyed. The size   |
+|                  |                                   | of the template is    |
+|                  |                                   | also returned.        |
++------------------+-----------------------------------+-----------------------+
+| 8                | ISO                               | Tracks the total time |
+|                  |                                   | an ISO has been       |
+|                  |                                   | uploaded to the time  |
+|                  |                                   | it has been removed   |
+|                  |                                   | from the cloud. The   |
+|                  |                                   | size of the ISO is    |
+|                  |                                   | also returned.        |
++------------------+-----------------------------------+-----------------------+
+| 9                | SNAPSHOT                          | Tracks the total time |
+|                  |                                   | from when a snapshot  |
+|                  |                                   | has been created to   |
+|                  |                                   | the time it have been |
+|                  |                                   | destroyed.            |
++------------------+-----------------------------------+-----------------------+
+| 11               | LOAD\_BALANCER\_POLICY            | Tracks the total time |
+|                  |                                   | a load balancer       |
+|                  |                                   | policy has been       |
+|                  |                                   | created to the time   |
+|                  |                                   | it has been removed.  |
+|                  |                                   | Cloud.com does not    |
+|                  |                                   | track whether a VM    |
+|                  |                                   | has been assigned to  |
+|                  |                                   | a policy.             |
++------------------+-----------------------------------+-----------------------+
+| 12               | PORT\_FORWARDING\_RULE            | Tracks the time from  |
+|                  |                                   | when a port           |
+|                  |                                   | forwarding rule was   |
+|                  |                                   | created until the     |
+|                  |                                   | time it was removed.  |
++------------------+-----------------------------------+-----------------------+
+| 13               | NETWORK\_OFFERING                 | The time from when a  |
+|                  |                                   | network offering was  |
+|                  |                                   | assigned to a VM      |
+|                  |                                   | until it is removed.  |
++------------------+-----------------------------------+-----------------------+
+| 14               | VPN\_USERS                        | The time from when a  |
+|                  |                                   | VPN user is created   |
+|                  |                                   | until it is removed.  |
++------------------+-----------------------------------+-----------------------+
+
+
+Example response from listUsageRecords
+--------------------------------------
+
+All CloudStack API requests are submitted in the form of a HTTP GET/POST
+with an associated command and any parameters. A request is composed of
+the following whether in HTTP or HTTPS:
+
+::
+
+                <listusagerecordsresponse>
+                      <count>1816</count>
+                     <usagerecord>
+                        <account>user5</account>
+                        <accountid>10004</accountid>
+                        <domainid>1</domainid>
+                        <zoneid>1</zoneid>
+                            <description>i-3-4-WC running time (ServiceOffering: 1)
(Template: 3)</description>
+                        <usage>2.95288 Hrs</usage>
+                           <usagetype>1</usagetype>
+                        <rawusage>2.95288</rawusage>
+                           <virtualmachineid>4</virtualmachineid>
+                        <name>i-3-4-WC</name>
+                           <offeringid>1</offeringid>
+                        <templateid>3</templateid>
+                        <usageid>245554</usageid>
+                        <type>XenServer</type>
+                        <startdate>2009-09-15T00:00:00-0700</startdate>
+                        <enddate>2009-09-18T16:14:26-0700</enddate>
+                      </usagerecord>
+
+                   … (1,815 more usage records)
+                </listusagerecordsresponse>
+
+Dates in the Usage Record
+-------------------------
+
+Usage records include a start date and an end date. These dates define
+the period of time for which the raw usage number was calculated. If
+daily aggregation is used, the start date is midnight on the day in
+question and the end date is 23:59:59 on the day in question (with one
+exception; see below). A virtual machine could have been deployed at
+noon on that day, stopped at 6pm on that day, then started up again at
+11pm. When usage is calculated on that day, there will be 7 hours of
+running VM usage (usage type 1) and 12 hours of allocated VM usage
+(usage type 2). If the same virtual machine runs for the entire next
+day, there will 24 hours of both running VM usage (type 1) and allocated
+VM usage (type 2).
+
+Note: The start date is not the time a virtual machine was started, and
+the end date is not the time when a virtual machine was stopped. The
+start and end dates give the time range within which usage was
+calculated.
+
+For network usage, the start date and end date again define the range in
+which the number of bytes transferred was calculated. If a user
+downloads 10 MB and uploads 1 MB in one day, there will be two records,
+one showing the 10 megabytes received and one showing the 1 megabyte
+sent.
+
+There is one case where the start date and end date do not correspond to
+midnight and 11:59:59pm when daily aggregation is used. This occurs only
+for network usage records. When the usage server has more than one day's
+worth of unprocessed data, the old data will be included in the
+aggregation period. The start date in the usage record will show the
+date and time of the earliest event. For other types of usage, such as
+IP addresses and VMs, the old unprocessed data is not included in daily
+aggregation.


Mime
View raw message