The configuration example in this section defines basic operation of the bulk statistics feature. Use the following example configuration to set up the system to communicate with the statistic collection server:

configure 
   bulkstats mode 
      schema name format format_string 
      sample-interval time_interval 
      transfer-interval xmit_time_interval 
      limit mem_limit 
      exit 
    bulkstats collection 
    end 

This section describes optional commands that can be used within the Bulk Statistics Configuration mode. Specifically, you can configure bulk statistic "files" under which to group the bulk statistics. "Files" are used to group bulk statistic schema, delivery options, and receiver configuration. Because multiple "files" can be configured, this functionality provides greater flexibility because it allows you to configure different schemas to go to different receivers.

configure 
  bulkstats mode 
    file number 
      receiver ip_address { primary | secondary }  
       [ mechanism { { { ftp | sftp } login user_name  
       [ encrypted ] password pwd } | tftp } } ] } 
      receiver mode { redundant | secondary-on-failure } 
      remotefile format naming_convention [ both-receivers | primary-receiver | secondary-receiver ] 
      header format header_format 
      footer format footer_format 
      exit 
    schema_type schema format format_string 
    sample-interval time_interval 
    transfer-interval xmit_time_interval 
    limit mem_limit 
    exit 
  bulkstats collection 
  end 

Important

FTP is not supported. SFTP is the recommended transfer protocol.

In each configuration example described in Configuring Standard Settings and Configuring Optional Settings, the following is the primary command used to configure the type of schema and the statistics collected:

configure 
  bulkstats mode 
    schema_type schema format format_string 

Refer to the Bulk Statistics Configuration Mode Commands and Bulk Statistics File Configuration Mode Commands chapters in the Command Line Interface Reference for more information regarding supported schemas, available statistics, and proper command syntax.

You can configure a separate destination file for storing the bulk statistics sub-mode configuration. Run the show configuration bulkstats command to confirm the configuration.

The bulkstats configuration file stores the configuration that was previously stored in the system configuration file under the bulk statistics sub-mode.

The Global Configuration mode bulkstats config command creates the separate configuration file in the system configuration.

configure 

   [no] bulkstats config [ schema | supplement ] url 

   end 

The optional schema keyword allows you to replace only the schema using the file provided and preserve the server configuration. The optional supplement keyword allows you to supplement the running bulkstats configuration with the contents of the configuration file provided. These keywords only work on existing files.

url specifies the location of the bulkstats configuration file. If the destination file already exists, it is replaced with the new file (except when the schema or supplement keywords are used). The new file will only be created if you save the configuration after completing changes. The Exec mode show configuration bulkstats command displays the URL for the bulkstats configuration mode destination file if it has been configured.

Important

The bulkstats config schema url takes precedence over manual configuration. With respect to schema, adding, modifying, or deleting any configurations manually through CLI, the changes will not be applied.

You can copy the bulkstats configuration file from the url, edit it and copy it back to /flash. Changes can be applied by using the no form of the bulkstats config command followed by reconfiguring the bulkstats config command.

When the bulkstats config command is enabled, StarOS removes the existing bulk statistics sub-mode configuration from the system configuration file. You must save the system configuration to retain the configuration change.

If no bulkstats config is used to disable the new destination file after it has been enabled. StarOS does not remove the file. You must save the system configuration to retain the configuration change.

Important

After completing changes to the bulk statistics configuration, you must save the system configuration to save the changes. If the bulkstats config command is enabled, the bulkstats configuration file will be updated.

There are several Exec mode show bulkstats commands that display information about defined parameters.

• show bulkstats data – displays criteria contained in the statistics gathering scheme for up to four files. See Viewing Collected Bulk Statistics Data.

• show bulkstats schemas – displays the scheme used to gather statistics including collection and transmission statistics. See Verifying Your Configuration.

• show bulkstats variables – displays available bulkstat variables (%variable%) by schema type that can be incorporated into a schema format.

In addition, show configuration bulkstats brief displays the bulkstats configuration at a global scope, as well as all server configuration. It does not display the schema configuration.

After configuring support for bulk statistics on the system, you can check your settings prior to saving them.

Follow the instructions in this section to verify your bulk statistic settings. These instructions assume that you are at the root prompt for the Exec mode.

show bulkstats schemas 

The following is an example command output:

Bulk Statistics Server Configuration: 
    Server State:                            Enabled  
    File Limit:                              6000 KB  
    Sample Interval:                         15 minutes (0D 0H 15M) 
    Transfer Interval:                       480 minutes (0D 0H 15M) 
    Collection Mode:                         Cumulative  
    Receiver Mode:                           Secondary-on-failure  
    Local File Storage:                      None 
Bulk Statistics Server Statistics: 
    Records awaiting transmission:  114 
    Bytes awaiting transmission:    8092 
    Total records collected:        59926 
    Total bytes collected:          4190178  
    Total records transmitted:      59812 
    Total bytes transmitted:        4188512  
    Total records discarded:        0 
    Total bytes discarded:          0 
    Last collection time required:  2 second(s) 
    Last transfer time required:    0 second(s) 
    Last successful transfer:       Wednesday December 7 12:14:30 EDT 2011 
    Last successful tx recs:        190 
    Last successful tx bytes:       13507 
    Last attempted transfer:        Wednesday December 7 12:14:30 EDT 2011 
File 1 
    Remote File Format:     /users/ems/server/data/chicago/bulkstat%date%%time%.txt 
    File Header:            "CHI_test %time%" 
    File Footer:            "" 
Bulkstats Receivers: 
    Primary: 192.168.0.100 using FTP with username administrator 
    Records awaiting transmission:    0 
    Bytes awaiting transmission:      0 
    Total records collected:          0 
    Total bytes collected:            0  
    Total records transmitted:        0  
    Total bytes transmitted:          0  
    Total records discarded:          0  
    Total bytes discarded:            0  
    Last transfer time required:      0 second(s)  
    No successful data transfers 
    No attempted data transfe 
 
File 2 not configured 
 
File 3 not configured 
 
File 4 not configured 

Save the configuration as described in the Verifying and Saving Your Configuration chapter.

The SFTP supports public key based authentication for bulk statistics transfer in StarOS. To ensure adherence to better security practices, the StarOS based products must not use the password-based mechanism for transferring bulk statistics to external servers. This feature allows the use of SSH keys instead of passwords. The bulk statistics transfer mechanism involves the following steps:

1. Generate the private and public RSA key pair.

   For more information, see the Configuring SSH Options > SSH Client Login to External Servers > Generating SSH Client Key Pair section in the Getting Started chapter of the ASR 5500 System Administration Guide.

2. Push the the public key to an external bulk statistics server.

   For more information, see the Configuring SSH Options > SSH Client Login to External Servers > Pushing an SSH Client Public Key to an External Server section in the Getting Started chapter of the ASR 5500 System Administration Guide.

   Steps 1 and 2 are existing mechanisms and are required only once.

3. Transfer the bulk statistics files using the keys that are exchanged in steps 1 and 2.

   For more information, see the Configuring SFTP Public Key Authentication section.

Every schema has some variables which are typically referred to as "key variables". These key variables provide index markers to identify to which object the statistics apply. For example, in the card schema the card number (variable %card%) uniquely identifies a card. For an HA service, the keys would be "%vpnname%" plus "%servname%', as the combination uniquely identifies an HA service. So, in a given measurement interval, one row of statistics will be generated per unique key.

There are also a number of common variables shared across schema that identify time, date, place, etc. These common variables are identified in the table below.