Metering Server Commands Overview › Metering Server Commands

Metering Server Commands

account info

Description

Retrieve Account Information.

Syntax

account info acct [--batch]

Arguments

acct: Name of customer account
--batch: Display output in UDL format - this is useful when the output of this command needs to be parsed by an external utility.

Examples

account info test: Display account information for account test

Typical Output

Name : test ID : 500 Company : Sample Company, Inc. Address : 555 Company Drive, City, CA 92555 Billing Contact : Jane Smith Technical Contact: Jim Smith Number of Grids : 4 Public Key : ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAIEAzf...svQSiSwJ687zKFIO8= test@bms Client Key 1 : Client Key 2 : Client Key 3 : Client Key 4 :

account set

Description

Set client access key(s) for account Syntax: account set acct [client_key1=key1] [client_key2=key2] [client_key3=key3] [client_key4=key4]

Arguments

acct: Name of customer account
keyN: SSH key used for client access.

Examples

account set test client_key1="ssh-rsa AAAAB3NzaC1yc2EAAAAB...": Set client access key for account test

Notes

The initial client access key needs to be provided to CA before the client may gain personal access.

account change

Description

Generate account change report

Syntax

account change acct [--csv] [(start=start end=end) | date=date]

Arguments

acct: Name of customer account
--csv: Display output as comma-separated list
start: Begin date of period. Must be in the form: YYYY-MM-DD.
end: End date of period. Must be in the form: YYYY-MM-DD.
date: Run report for this date only. Must be in the form: YYYY-MM-DD.

Examples

account change test start=2007-10-01 end=2007-10-31 Display report of changed # of grids and/or servers for account test

Notes

If the account had no grids or servers at the beginning of the period, the Start # XXX column will contain -

If the account had no grids or servers at the End of the period, the End # XXX column will contain -

A specification of the output of this command is listed here

Typical Output

Account Start # Grids End # Grids Start # Servers End # Servers ------------------------------------------------------------------------- test1 3 3 9 12 test2 - 1 - 8 test3 1 - 4 -

grid list

Description

Show list of grids for an account

Syntax

grid list acct [--batch | --csv] [(start=start end=end) | date=date] Arguments:

acct: Name of customer account
--batch: Display output in UDL format - this is useful when the output of this commands needs to be parsed by an external utility.
--csv: Display output in CSV format - this is useful when the output of the command needs to be imported into a spreadsheet.
start: Begin date of period. Must be in the form: YYYY-MM-DD.
end: End date of period. Must be in the form: YYYY-MM-DD.
date: Run report for this date only. Must be in the form: YYYY-MM-DD.

Examples

grid list test Display list of grids for account test

Notes

Only grids that have successfully reported metering data will be shown.
The displayed grid name is constructed of the grid name provided when the grid is installed plus a generated unique signature.
A specification of the output of this command is listed here

Typical Output

Name Version # Servers Tag ---------------------------------------------------------------------- grid1-S20061117034908201376000 1.2.9 3 Shared grid2-S20061031041047995157000 1.2.5 2 R&D grid3-S20060909071528219740000 <unknown> 5 Development grid4-S20060913235706760077000 <unknown> 32 Evaluation

grid change

Description

List grids where # of servers has changed

Syntax

grid change acct[:grid] [--csv] [--verbose] [(start=start end=end) | date=date]

Arguments

acct: Name of customer account
grid: (optional) Name of grid. If not specified, changes for all grids is displayed. The grid name must be the FULL grid name grid-signature.
--csv: Display output as comma-separated list
--verbose: Display full grid name (with signature).
start: Begin date of period. Must be in the form: YYYY-MM-DD.
end: End date of period. Must be in the form: YYYY-MM-DD.
date: Run report for this date only. Must be in the form: YYYY-MM-DD.

Examples

grid change test start=2007-10-01 end=2007-10-31 Display report of changed grids for account test

Notes

If the grid appeared during the period, the Start # Servers column will contain -
If the grid disappeared during the period, the End # Servers column will contain -
A specification of the output of this command is listed here

Typical Output

Account Grid Start # Servers End # Servers Tag ----------------------------------------------------------------- test grid1 4 8 Development grid2 - 4 Eval grid3 4 - Shared
- display of Tag is new.

grid uptime

Description

Display estimated grid uptime report

Syntax

grid uptime acct[:grid] [--csv] [--verbose] [(start=start end=end) | date=date]

Arguments

acct: Name of customer account
grid: (optional) Name of grid. If not specified, uptime for all grids is displayed. The grid name must be the FULL grid name grid-signature.
--csv: Display output as comma-separated list
--verbose: Display full grid name (with signature).
start: Begin date of period. Must be in the form: YYYY-MM-DD.
end: End date of period. Must be in the form: YYYY-MM-DD.
date: Run report for this date only. Must be in the form: YYYY-MM-DD.

Examples

grid uptime test start=2007-10-01 end=2007-10-31: Display estimated uptime for all grids for account test

Notes

If the grid appeared during the period, the uptime calculation begins from the first report.
If the grid disappeared during the period, the uptime calculation includes up until the last report.
If there are gaps in the grid reporting, the gaps are calculated as downtime.

Typical Output

Account Grid Version Uptime (%) Start Date End Date ------------------------------------------------------------------- test grid1 1.2.14 100.000 2007-10-01 2007-10-31 grid2 2.1.0 99.988 2007-10-15 2007-10-31 grid3 2.1.0 100.000 2007-10-01 2007-10-16

grid downtime

Description

Display grid downtime details

Syntax

grid downtime acct[:grid] [--verbose] [(start=start end=end) | date=date]

Arguments

acct: Name of customer account
grid: (optional) Name of grid. If not specified, uptime for all grids is displayed. The grid name must be the FULL grid name grid-signature.
--verbose: Display full grid name (with signature).
start: Begin date of period. Must be in the form: YYYY-MM-DD.
end: End date of period. Must be in the form: YYYY-MM-DD.
date: Run report for this date only. Must be in the form: YYYY-MM-DD.

Examples

grid downtime test start=2008-11-01 end=2008-11-10: Display downtime details for all grids for account test

Notes

A specification of the output of this command is listed here

Typical Output

Account, Grid, Downtime (Hrs), Previous Report, Current Report, Previous Version, Current Version, Description 
test, grid1, 12.00, R2008.11.03-17.48.02-PST, R2008.11.03-18.12.02-PST, 2.4.5 Beta hf2586 hf2602, 2.4.5 Beta hf2586 hf2602, Gap in reporting 
test, grid2, 12.00, R2008.11.10-14.12.18-PST, R2008.11.10-14.36.02-PST, 2.4.5 Beta hf2584 hf2602 hf2586 hf1910, 2.4.5 Beta hf2584 hf2602 hf2586 hf1910, Gap in reporting 
test, grid3, 12.00, R2008.11.01-10.12.04-PDT, R2008.11.01-10.36.02-PDT, 2.4.5 Beta e2585, 2.4.5 Beta e2585, Gap in reporting

meter dump

Description:

Display metering data.

This command supports the following modes of operation:

Application resource reporting
Server resource reporting
Server count reporting
Composite reporting

Syntax

meter dump acct[:grid]] [(start=start end=end) | date=date] [--csv | --detail] [--exclude_sys] [--verbose] - Report application resources

meter dump acct[:grid]] --srv_rsc [(start=start end=end) | date=date] [--csv | --detail] [--verbose] [filter=filter] - Report server resources

meter dump acct[:grid]] --srv_count [(start=start end=end) | date=date] [--csv | --detail] [filter=filter] - Report server counts

meter dump acct[:grid]] --composite [(start=start end=end) | date=date] [--csv] [--exclude_sys] - Generate composite report

Arguments

acct

Name of customer account

grid

(optional) Name of grid. If not specified, metering data for all grids is displayed. The grid name must be the FULL grid name grid-signature.

start

Begin date of the metering data to be displayed. Must be in the form: YYYY-MM-DD.

end

End date of the metering data to be displayed. Must be in the form: YYYY-MM-DD.

date

Run report for this date only. Must be in the form: YYYY-MM-DD.

--srv_rsc

Display server resource metering data. The displayed metering data is similar to that displayed for applications except that it is based on total available server resources.

--srv_count

Display server count metering data. The displayed metering data shows differences in the total number of servers for the account [grid].

--composiite

Display composite metering data. This option combines the server resource capacity and application resource usage reports. In addition, the following information is displayed: CA 3Tera AppLogic version, # of Servers, resource utilization (%) for cpu, memory, and bandwidth.

--csv

Display summary output as a comma-separated list of records.

--detail

Display detailed output as a comma-separated list of records where there is a separate record for each reported entity. This is useful when importing the data into a billing application.

--exclude_sys

Exclude CA 3Tera AppLogic system applications when reporting resources. If this option is not specified, all applications are included when reporting resources.

--verbose

Display full grid name (with signature). This option is only valid if --csv and --batch are not specified.

filter

Comma-separated list of name=value filter criteria. If no filter is specified, all servers are considered in the calculations. The filter may contain one or more of the following:

- hypervisor=val - filter based upon hypervisor running on the server (For example, Vmware). This value is only valid if --srv_count or --srv_rsc option is specified.

Examples

meter dump test: Display all application resource metering information for account test
meter dump test --srv_rsc: Display all server resource metering information for account test
meter dump test --srv_rsc filter=hypervisor=vmware: Display all server resource metering information for servers running vmware hypervisor and account test
meter dump test --srv_count: Display all server count metering information for account test
meter dump test --srv_count filter=hypervisor=vmware: Display all server count metering information for servers running vmware hypervisor and account test
meter dump test --composite: Display composite metering information for account test

Notes

A specification of the output of this command is listed here
When --detail is not specified, the output is the aggregate totals for the reporting period.
If the grid name is specified, metering data for that particular grid is displayed otherwise metering data for all grids under the account is displayed.
The start and end dates are inclusive.

Typical Output (summary)

   Account   Grid          CPUh        GBh         Xfer In     Xfer Out  Start Date   End Date 
   --------------------------------------------------------------------------------------------- 
   test      grid1       109.71      99.24     100,000,000   50,000,000  2006-10-27   2006-11-06 
             grid2         0.16       0.49     500,000,000   75,000,000  2006-11-07   2006-11-08 
             grid3         0.00       0.00   1,100,000,000  100,000,000  2006-09-09   2006-11-04 
             grid4     4,265.04     864.00   5,100,000,000  200,000,000  2006-09-13   2006-10-13

Typical Output (--detail)

   Account, Grid, Application, User1, User2, State, # Components, CPU, Memory,(MB), Bandwidth(Mbps),  Duration (Hrs), Start Date, Start Time, End Date, End Time, CPU (Hrs), Memory (GBhrs), Bandwidth(MbHrs), Xfer In, Xfer Out, Locked, Tag 
   test, grid4-S20060913235706760077000, cPanel_ltest, "", "", running, 4, 0.40, 512, 1, 10,000,000, 5,000,000, 5.0,  2006-10-06, 05:48:03, 2006-10-06, 10:48:02, 2.0, 2560, 5, 0, "vendor=myvendor" 
   test, grid4-S20060913235706760077000, cPanel_nc, "", "", running, 4, 10.00, 1776, 1000, 12,000,000, 2,000,000, 144, 2006-09-29, 12:00:02, 2006-10-04, 12:00:03, 1440.0, 255744, 144000, 0, "vendor=myvendor" 
   test, grid4-S20060913235706760077000, wiki-16b, "", "", running, , 0.04, 160, 4, 96, 20,000,000, 20,000,000, 2006-09-17, 02:30:11, 2006-09-21, 02:30:12, 3.84, 15360, 384, 1, "vendor=myvendor2"

meter license

Description

Display license metering data for appliances.

This command supports the following modes of operation:

Summary
Per-server Summary

Syntax

meter license --all | acct[:grid]] [(start=start end=end) | date=date] [ filter=filter] [--csv] [--verbose] - Report license summary data

meter license --all | acct[:grid]] --srv_license [(start=start end=end) | date=date] [ filter=filter] [--csv] [--verbose] - Report server license data

Arguments

--all

Report data for all accounts and all grids

acct

Name of customer account

grid

(optional) Name of grid. If not specified, metering data for all grids is displayed. The grid name must be the FULL grid name grid-signature.

start

Begin date of the metering data to be displayed. Must be in the form: YYYY-MM-DD.

end

End date of the metering data to be displayed. Must be in the form: YYYY-MM-DD.

date

Run report for this date only. Must be in the form: YYYY-MM-DD.

--srv_license

Display per server license data.

filter

Comma-separated list of name=value filter criteria. If no filter is specified, any appliance is considered in the calculations. The filter may contain one or more of the following:

- os_type=val - filter based upon OS type (For example, Windows).
- os_name=val - Filter based upon OS name (For example, CentOS, Windows 2003 Enterprise Server, etc.)
- os_version=val - Filter based upon OS version (e.g, 5.1)
- pv_info=val - Filter based upon PV driver information (For example, turbogate)
- tag=val - Filter based upon tag value. The value of the filter may be one of the following:
* name - property name within the tag string

* name=val - A specific property name with the corresponding value within the tag string.

--csv

Display summary output as a comma-separated list of records.

--verbose

Display full grid name (with signature). This option is only valid if --csv is not specified.

Examples

meter license test: Display all license summary metering information for account test
meter license test --srv_license: Display all per server license metering information for account test

Notes

A specification of the output of this command is listed here
If the grid name is specified, metering data for that particular grid is displayed otherwise metering data for all grids under the account is displayed.
The start and end dates are inclusive.

Typical Output (summary)

OS Info                                                # grids  # servers  # sockets  # VMs 
-------------------------------------------------------------------------------------------- 
Microsoft(r) Windows(tm) Enterprise 2003 Server:1.0.0        2          2          4      2 
Microsoft(r) Windows(tm) Standard 2003 Server:1.0.0          1          1          2      1 
Microsoft(r) Windows(tm) Web Edition 2003 Server:1.0.0       3          3          6      3 
 
PV Info                                                # grids  # servers  # sockets  # VMs 
-------------------------------------------------------------------------------------------- 
None                                                         2          2          4      2 
Turbogate                                                    1          1          2      1 
Novell                                                       3          3          6      3 
 
Hypervisor         # grids  # servers  # sockets  # VMs(#Sys)  
------------------------------------------------------------- 
vmware                   1          3          6       3(1) 
xen                      2          6         12      20(3)

Typical Output (Server License)

Account  Grid    Server  #Sockets   # VMs(sys)  Hypervisor 
----------------------------------------------------------  
Test     grid1   srv1           2        1(1)   xen 
                 srv2           2        1(0)   xen 
         grid2   srv1           2        1(2)   vmware

meter exception

Description

Display Exception metering data.

Syntax

meter exception --all | acct[:grid]] [(start=start end=end) | date=date] [--maint] [--csv] [--verbose] - Display exception metering data.

Arguments

--all: Report data for all accounts and all grids
acct: Name of customer account
grid: (optional) Name of grid. If not specified, metering data for all grids is displayed. The grid name must be the FULL grid name grid-signature.
start: Begin date of the metering data to be displayed. Must be in the form: YYYY-MM-DD.
end: End date of the metering data to be displayed. Must be in the form: YYYY-MM-DD.
date: Run report for this date only. Must be in the form: YYYY-MM-DD.
--maint: Display ha check or volume maintenance State
--csv: Display output as a comma-separated list of records.
--verbose: Display full grid name (with signature). This option is only valid if --csv is not specified.

Examples

meter exception test: Display all exception metering information for account test

Notes

A specification of the output of this command is listed here
If the grid name is specified, metering data for that particular grid is displayed otherwise metering data for all grids under the account is displayed.
The start and end dates are inclusive.

Typical Output (summary)

Account  Grid  # Suspicious Appliances  Application  Component  Class        OS guess  OS type 
---------------------------------------------------------------------------------------------- 
Dev     grid5                        1  myapp        main.srv   usr.appl1    Windows  Linux 
        grid6                        2  myapp1       main.c1    proto.appl2  Linux    Windows 
                                        myapp2       main.s1    usr.appl1    Windows  Linux 
Dev2    grid1                        1  test         main.a1    usr.myappl   Windows  Linux

Typical Output (Maintenance)

Account  Grid  HA State  HA Message  Volume Maint. Message 
---------------------------------------------------------- 
Dev      grid1  ok               no                    yes 
         grid6  unavailable      yes                   yes 
Test     grid1  unavailable      yes                   yes

meter appliance

Description

Display detail appliance metering data.

Syntax

meter appliance --all | acct[:grid]] [(start=start end=end) | date=date] [ --filter=filter] [--csv] [--verbose] - Report detail data

Arguments

--all

Report data for all accounts and all grids

acct

Name of customer account

grid

(optional) Name of grid. If not specified, metering data for all grids is displayed. The grid name must be the FULL grid name grid-signature.

start

Begin date of the metering data to be displayed. Must be in the form: YYYY-MM-DD.

end

End date of the metering data to be displayed. Must be in the form: YYYY-MM-DD.

date

Run report for this date only. Must be in the form: YYYY-MM-DD.

filter

Comma-separated list of name=value filter criteria. The filter may contain one or more of the following:

- os_type=val - filter based upon OS type (For example, Windows, Solaris, etc.)
- os_name=val - Filter based upon OS name (For example, CentOS, Windows 2003 Enterprise Server, etc.)
- os_version=val - Filter based upon OS version (e.g, 5.1)
- pv_info=val - Filter based upon PV driver information (For example, turbogate)
- vlan_id=val - Filter based upon the VLAN ID assigned to the appliance
- virt_mode=val - Filter based upon the appliance's virtualization mode
- tag=val - Filter based upon tag value. The value of the filter may be one of the following:
* name - property name within the tag string

* name=val - A specific property name with the corresponding value within the tag string.

--csv

Display summary output as a comma-separated list of records.

--verbose

Display full grid name (with signature). This option is only valid if --csv is not specified.

Examples

meter appliance test: Display all appliance information for account test

Notes

A specification of the output of this command is listed here
If the grid name is specified, metering data for that particular grid is displayed otherwise metering data for all grids under the account is displayed.
The start and end dates are inclusive.

Typical Output (summary)

Account Grid  App        Class         OS        CPU   Mem  Xfer In(GB)  Xfer Out(GB)  Time  VLAN   Virt. Mode  Tag 
------------------------------------------------------------------------------------------------------------------- 
Test    grid1 myapp      usr.appl1     Windows   1.0   512          1.0          2.0     .5   1      pv 
              myapp2     proto.appl1   Windows   2.0  1024          2.5          1.5   12.0   1      pv 
        grid2 demoapp    usr.myappl    Windows   1.0  1024         10.5          5.2   64.0   2      hvm

message post

Description

Post message to grid dashboard

Syntax

message post acct[:grid] | --all id=id [severity=severity] text=text

Arguments

acct: Name of customer account
grid: (optional) Name of grid. If not specified, the message is posted to all grids. The grid name must be the FULL grid name grid-signature.
id: Message ID. Must be in the form 200_grm_text.
severity: Message severity. May be alert or info. Default is info.
text: Message text. If set to '-', the text is read from STDIN.

Examples

message post test id=200_grm_test severity=info text="This is a test dashboard message": Post dashboard message to all grids of account test

message recall

Description

Recall posted dashboard message

Syntax

message recall acct[:grid] id=id

Arguments

acct: Name of customer account
grid: (optional) Name of grid. If not specified, the message is recalled from all grids. The grid name must be the FULL grid name grid-signature.
id: Message ID. Must be in the form 200_grm_text.

Examples

message recall test id=200_grm_test: Recall dashboard message 200_grm_test from all grids of account test

message status

Description

Display pending dashboard messages

Syntax

message recall acct:grid [--batch]

Arguments

acct: Name of customer account
grid: Name of grid. The grid name must be the FULL grid name grid-signature.
--batch: Display output in UDL format

Examples

message status test:grid1-S123465: Display pending dashboard messages for grid1-S123465

Notes

A specification of the output of this command is listed here

This section contains the following topics:

account info output

account change output

meter exception output

meter appliance output

message status output