Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.


Abiquo 5.0

Skip to end of metadata
Go to start of metadata

The CSV billing integration outputs a CSV file with the usage values for billing.

  • For basic install and configuration instructions, see CSV Quickstart.

Configure CSV connector properties to define CSV connector behavior

This section contains a detailed description of the properties for configuring the CSV connector's behavior. For example:

  • CSV File Name and Location
  • CSV Header
  • Append or Overwrite file
  • Name of the Account Attribute holding the Billing System Account ID
  • Row per usage, or single row per Account

PropertyDefaultDescription

csv_file

 e.g. csv_file=./csv/Abiquo_Billing{DATE}.csv_
  • Location and name of the CSV file
  • Will attempt to create folders
  • Will replace {DATE} with the date that the Billing Integration was started, in 'YYYYMMDD' format

csv_file_header

 true

  • If true, write a list of column names at the top of a CSV file.

csv_file_append

 true
  • If true, append to the current file if it exists; If false, replace an existing file

provider_mapping_name

ENTERPRISE

e.g. provider_mapping_name=ZUORA_ACCOUNT_NUMBER

  • Name of the Billing attribute (defined in the billing_account_mapping table) that contains the Billing System customer ID

include_usage_costs

false

If true, include a column for each usage defined in the pricing template.

Values that are not defined in the pricing templates are not covered by billing when including usage costs:

  • 'external storage' usage does not include costings; these should be costed via storage tier usage.
  • hypervisor
  • custom usages

The billing integration does not include charges with independent charging periods:

  • minimum charge
  • standing charge

The billing integration cannot adjust these charging periods to billing periods without risk of calculation error.

row_per_usage

false

If true, produce one row in the CSV file for each usage per ID per account period. If false, produce a single row for all usages for an id-account period.

datacenter

false

If true, bill per datacenter and include datacenter details in the connector output. You must also enable this in the main billing integration configuration. Note: If this value is enabled but Physical Datacenter Billing by Abiquo Datacenter is not enabled in billing.properties, then datacenter details will be recorded as ‘n/a’.
For pricing per datacenter, set this option to true 
property

e.g. cpu=true
e.g. vlan=true
For a property, if true, include this column in the CSV file. If false, exclude the column.

See Configure usage connector properties

property_display_name

e.g. mem_display_name=RAM MB
e.g. vlan_display_name=1010101
For a property, override the standard column headers in the file or the Abiquo Type column values in the row per usage files.
Does not apply to custom usages, which already have custom names

See Configure usage connector properties

start_period

true

This mandatory column appears in all reports and it is the timestamp of the start of the accounting period

Other Columns


Set boolean values to false to exclude these columns from the CSV file

end_period

true

If true, include the column containing the timestamp of the end of the accounting period (exclusive)

abiquo_type

true

If true, include the column containing the 'type' of the Abiquo ID (ENTERPRISE or VDC)

abiquo_id

true

If true, include the column containing the Abiquo ID value

bill_system_id

true

If true, include the Billing System's Customer ID, as defined in the 'billing_account_mapping' table

Configure CSV connector properties to define billing usage data


To include these columns in the usage data output file, in the {connector}.properties file set these properties to "true". Then configure any associated properties, such as name and display name.

By default all quantities are per accounting period, which by default is 1 hour. So for example, a 1 CPU VM running for the full 24 hours of a DAY Accounting period will consume a quantity of 24 CPUs.

Usage data columnsDefaultDescription

cpu

true

If true, include amount of CPU for the account period

cpu_on

trueIf true, include amount of CPU for the account period when the VM was ON

cpu_off

trueIf true, include amount of CPU for the account period when the VM was OFF

mem

true

If true, include amount of Memory for the account period (MB)

mem_on

trueIf true, include amount of Memory for the account period when the VM was ON

mem_off

trueIf true, include amount of Memory for the account period when the VM was OFF

ip

true

If true, include amount of IPs used for the account period

vlan

true

If true, include amount of VLANs used for the account period

local_storage

true

If true, include amount of Local Storage used for the Account Period (GB)

external_storage

true

If true, include amount of External Storage used for the account period (GB)

ha

trueIf true include if the VM is hosted on an Abiquo rack with high availability enabled

reserved_server_cpu

trueIf true, include amount of CPU in reserved servers that have been explicitly reserved for an Enterprise

reserved_server_memory

trueIf true, include amount of RAM in reserved servers that have been explicitly reserved for an Enterprise

repository

trueIf true, include the amount of Repository usage (GB) by the enterprise for VM Templates and Instances (conversions are not accounted)

anti_affinity

trueIf true, include if the Virtual machine is deployed in an anti-affinity layer to ensure it is deployed separately from other VMs in the same layer

firewall

trueIf true, include the number of firewalls

loadbalancer

trueIf true, include the number of load balancers

tiered_storage

false
  • If true, process tiers that are defined in billing.properties file with the storage_tier_<n>_name property
  • Define the storage tiers that you want to include in the output file, in the order that the custom columns should appear

storage_tier_<n>

 Define the order of the storage tier in the output file with a number <n> starting from 1

storage_tier_<n>_name

 The same case-sensitive name of the 'storage_tier_<n>_name' in the billing.properties file

storage_tier_<n>_display_name

 Custom column heading

local_tier_storage

false
  • If true, process datastore tiers that are defined in billing.properties file with the local_tier_storage_<n>_name property
  • Define the datastore tiers that you want to include in the output file, in the order that the custom columns should appear

local_tier_storage_<n>

 Defines the order of the datastore tier in the output file with a number <n> starting from 1

local_tier_storage_<n>_name

 The same case-sensitive name as the value of the 'local_tier_storage_<n>_name' in the billing.properties file

storage_tier_<n>_display_name

 Custom column heading

cost_codes

false
  • If true, process cost codes that are defined in billing.properties file with the cost_code_<n>_name property
  • Define the Cost Codes that you want to include in the output file, in the order you wish those cost codes to appear

cost_code_<n>

 Defines the order of the cost code in the output file with a cost code number <n> starting from 1 for the first cost code

cost_code_<n>_name

 The same case-sensitive name as the 'cost_code_<n>_name' value in the billing.properties file.

cost_code_<n>_display_name

 The customized display names can be values such as strings or account numbers, for example:
  • cost_code_1_display_name = LINUX1
  • cost_code_2_display_name = WINDOWS10

hypervisors

false
  • If true, process hypervisor usage
  • Also define the hypervisor usages in the billing.properties file with the hypervisor_<n>_name properties
  • Define the hypervisors that you want to include in the output file, in the order that the custom columns of hypervisors should appear

hypervisor_<n>

 Defines the order of the hypervisor in the output file with a hypervisor number <n> starting from 1 for the first hypervisor

hypervisor_<n>_name

 

E.g. hypervisor_1_name=VMX_04
The same case-sensitive name, which is the same as the value of the 'hypervisor_<n>_name' property in the billing.properties file

hypervisor_<n>_display_name

  hypervisor_1_display_name=VMWareESX

custom_<n>


  • e.g. custom_1=ESXHypervisors
  • If custom=true, set these properties to custom usage names to process the custom usages
  • Also define the custom usage in the billing.properties file with the custom_usage_<n>_name properties
  • Note that the usage number <n> does not need to match the number in the main billing properties file


Example csv.properties

This is a sample file only. Please see the csv.properties file on your billing integration system to check property values.

 Click here to expand...
##############
#
# CSV Connector specific properties
#
##############
# define the name of the CSV file 
csv_file=./CSV_files/abiquo_billing_{DATE}.csv

# Should we write a header row to the CSV?
csv_file_header=true

# Append to an existing file (if it exists), or replace it?
csv_file_append=true

# name of the billing system property name to use as the CSV customer ID value
provider_mapping_name=ENTERPRISE

# Should we include usage costings in the CSV output?
include_usage_costs=false

# determines whether we have one row per usage, or put all usages on a single row...
row_per_usage=false

# what optional information is required to qualify the billing data? 
# Set datacenter to true for billing with pricing per datacenter
datacenter=true
end_period=true
abiquo_type=true
abiquo_id=true
bill_system_id=true

# These values determine whether particular usages will be included in the results
# Invalid Usages will be reported as 0 value...
cpu=true
mem=true
ip=true
vlan=true
local_storage=true
external_storage=true
ha=false
reserved_server_cpu=false
reserved_server_memory=false
repository=false
anti_affinity=false
firewall=true
loadbalancer=true

tiered_storage=false
#storage_tier_1=false
#storage_tier_2_name=Tier 2
#storage_tier_3=false
#storage_tier_4=false

# Only need to include the cost codes that are required in the CSV file
cost_codes=false
#cost_code_1=true
#cost_code_1_name=Monowall


# Only need to include the hypervisor usages that are required in the CSV file
# Optional - the entries below have been overridden to use 'friendly' names
hypervisors=false
hypervisor_1=false
hypervisor_1_name=VMX_04
hypervisor_1_display_name=VMWareESXi
hypervisor_2=false
hypervisor_2_name=KVM
hypervisor_3=false
hypervisor_3_name=ORACLE_VM
hypervisor_3_display_name=OracleVM
hypervisor_4=false
hypervisor_4_name=XENSERVER
hypervisor_4_display_name=XenServer
hypervisor_5=false
hypervisor_5_name=HYPERV_301
hypervisor_5_display_name=HyperV
hypervisor_6=false
hypervisor_6_name=AMAZON
hypervisor_6_display_name=AmazonAWS


# Include datacenter details in connector output for billing by datacenter subgroups and datacenter filtering
# Note: if this value is enabled without Physical Datacenter being enabled in billing.properties,
# then datacenter details will be recorded as 'n/a'
datacenter=true
 
# Only need to include the custom usages that are required in the CSV file
custom=false
custom_1=false
custom_1_name=RepositoryUsageGB