blob: 1a0385b999ed2d06b256d230cf26b589c9186fc5 [file] [log] [blame]
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="ipaddress-usage-record-format">
<title>IP Address Usage Record Format</title>
<para>For IP address usage the following fields exist in a usage record.</para>
<itemizedlist>
<listitem><para>account - name of the account</para></listitem>
<listitem><para>accountid - ID of the account</para></listitem>
<listitem><para>domainid - ID of the domain in which this account resides</para></listitem>
<listitem><para>zoneid - Zone where the usage occurred</para></listitem>
<listitem><para>description - A string describing what the usage record is tracking</para></listitem>
<listitem><para>usage - String representation of the usage, including the units of usage</para></listitem>
<listitem><para>usagetype - A number representing the usage type (see Usage Types)</para></listitem>
<listitem><para>rawusage - A number representing the actual usage in hours</para></listitem>
<listitem><para>usageid - IP address ID</para></listitem>
<listitem><para>startdate, enddate - The range of time for which the usage is aggregated; see Dates in the Usage Record</para></listitem>
<listitem><para>issourcenat - Whether source NAT is enabled for the IP address</para></listitem>
<listitem><para>iselastic - True if the IP address is elastic.</para></listitem>
</itemizedlist>
</section>