# Bulk Statistics Configuration Mode Commands

The Bulk Statistics Configuration Mode is used to manage the options for the collection, formatting and delivery of system statistics to remote nodes.

Refer to the Common Syntax Options section in this chapter for information about formatting the output of bulk statistics.

IMPORTANT:

Unless otherwise indicated, all statistics are counters. For statistics with the Int32 data type, the roll-over to zero limit is 4,294,967,295. For statistics with the Int64 data type, the roll-over to zero limit is 18,446,744,073,709,551,615.

IMPORTANT:

The commands or keywords/variables that are available are dependent on platform type, product version, and installed license(s).

## Overview

### Schema Format String Syntax

The following defines common syntax block options. These options appear in similar commands and are detailed here for easy reference.

The schema format string is used to define the structure of generated bulk statistics data. The string may contain static text, dynamic content, and bulk statistic variables, or any combination.

Static text includes any ASCII characters that are of a fixed value. Static text may also include control characters by using Escape character sequences. Supported Escape character shortcuts are “\n” for new line and “\t” for tab.

Enclosing an alphanumeric string within double quotation marks (“) allows you to include spaces in the string.

Variables within the format string must be enclosed within “% and %”, for example, “%var%”. The actual variables supported are command-dependent and are described in the Statistics and Counters Reference.

### Schema Format String Length

The maximum length of schema formats specified via the CLI is restricted by a limit on the CLI command. The command, which has the following syntax, cannot be more than 1021 characters long.

<schema> schema <schema_name> format <schema_format>

Where:

- <schema_name> can be a maximum of 31 characters.
- <schema_format> can be a maximum of “1021 minus “number of characters in rest of the command, including spaces”” characters.

### Common Statistics

For a list of the statistics that are common to all schema, refer to the Statistics and Counters Overview chapter of the Statistics and Counters Reference.
aal2 schema

Configures the ATM adaptation layer 2 (AAL2) bulk statistics schema within an ATM virtual connection by the HNB-GW.
Platform:

ASR 5000
Product:

HNB-GW
Privilege:

Security Administrator, Administrator
Syntax

    aal2 schema schema_name format schema_formatno aal2 schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for ATM adaptation layer 2 (AAL2) bulk statistics collection. Multiple AAL2 schemas can be created to further categorize HNB-GW-level bulk statistics. All of the schemas are processed at each collection interval. To create multiple AAL2 schemas, re-issue the aal2 schema schema_name command using a different schema name.
Example:
The following command creates a schema named aal2stats1 that records the number of AAL2 uplink packets transmitted and AAL2 downlink packets received by Access Link Control Application Part (ALCAP) service on HNB-GW:

    aal2 schema aal2stats1
    format “%uplink-pkts-tx%” “%downlink-pkts-rx%”

alcap schema

Configures the Access Link Control Application Part (ALCAP) bulk statistics schema for an ALCAP service on an HNB-GW node.
Platform:

ASR 5000
Product:

HNB-GW
Privilege:

Security Administrator, Administrator
Syntax

    alcap schema schema_name format schema_formatno alcap schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for Access Link Control Application Part (ALCAP) service bulk statistics collection on HNB-GW node. Multiple ALCAP schemas can be created to further categorize at AAL2 channel-level bulk statistics. All of the schemas are processed at each collection interval. To create multiple ALCAP schemas, re-issue the alcap schema schema_name command using a different schema name.
Example:
The following command creates a schema named alcap1stats1 that records the number of AAL2 channels in connecting and connected state on ALCAP service:

    alcap schema alcaplstats1
    format “%num-aal2-channels-in-connecting%” “%num-aal2-channels-in-connected-state%”

apn schema

Configures the Access Point Name (APN) bulk statistics schema.
Platform:

ASR 5000
Product:

GGSN
Privilege:

Security Administrator, Administrator
Syntax

    apn schema schema_name format schema_formatno apn schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for APN bulk statistics collection. Multiple APN schemas can be created to further categorize APN-level bulk statistics. All of the schemas are processed at each collection interval. To create multiple APN schemas, re-issue the apn schema schema_name command using a different schema name.
Example:
The following command creates a schema named apn1stats1 that records the number of sessions currently facilitated by the APN:

    apn schema apn1stats1
    format “%sess-curr%”

asngw schema

Configures Access Service Gateway (ASN-GW) bulk statistics schema.
Platform:

ASR 5000
Product:

ASN GW
Privilege:

Security Administrator, Administrator
Syntax

    asngw schema schema_name format schema_formatno asngw schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for ASN-GW bulk statistics collection. Multiple ASN-GW service schemas can be created to further categorize ASN-GW service bulk statistics. All of the schemas are processed at each collection interval. To create multiple ASN-GW service schemas, re-issue the asngw schema schema_name command using a different schema name.
Example:
To create an ASN-GW schema named asngw_statistics that specifies a schema format of:

- VPN context name: vpnname
- VPN Context Identifier: vpnid
- ASN-GW Service name: servname
- ASN-GW Service identifier: servid
- Peer IP address: peeripaddr

Use the following command:

    asngw schema asngw_statistics
    format “VPN name: %vpnname%\nVPN
    ID: %vpnid%\nASN-GW Service Name: %servname%\nASN-GW
    Service Identifier: %servid%\nPeer IP
    Address: %peeripaddr%”

bcmcs schema

Configures Broadcast and Multicast Service (BCMCS) bulk statistics schema.
Platform:

ASR 5000
Product:

PDSN
Privilege:

Security Administrator, Administrator
Syntax

    bcmcs schema schema_name format schema_formatno bcmcs schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for BCMCS bulk statistics collection. Multiple BCMCS schemas can be created to further categorize BCMCS-level bulk statistics. All of the schemas are processed at each collection interval. To create multiple BCMCS schemas, re-issue the bcmcs schema schema_name command using a different schema name.
Example:
The following command creates a schema named bcmcs1stats1 that records the number of sessions currently facilitated by BCMCS:

    bcmcs schema bcmcs1stats1
    format “%sess-curr%”

card schema

Configures card bulk statistics schema. These are statistics for circuit cards installed in the ASR 5x00 chassis.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    card schema schema_name format schema_formatno card schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for card bulk statistics collection. Multiple card schemas can be created to categorize card-level bulk statistics. All of the schemas are processed at each collection interval. To create multiple card schemas, re-issue the card schema schema_name command using a different schema name.

IMPORTANT:

Not supported on all platforms
Example:
The following command creates a schema named card1stats1 that records the number of processes for all installed cards:

    card schema card1stats1
    format “%slot%-%numproc%”

To create a card-level schema named cardresourcestats that specifies a schema format of:

- Chassis slot number: slot
- Available Memory: memtotal Memory Used (%): memused
- Available CPU (%): cpuidle

Use the following command:

    card schema cardresourcestats
    format “Chassis slot number: %slot%\nAvailable
    Memory: %memtotal%\tMemory Used (%): %memused%\nAvailable
    CPU (%): %cpuidle%”

context schema

Configures context bulk statistics schema.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    context schema schema_name format schema_formatno context schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For the complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for Context bulk statistics collection. Multiple context schemas can be created to categorize context statistics. All of the schemas are processed at each collection interval. To create multiple context schemas, re-issue the context schema schema_name command using a different schema name.
Example:
To create a Firewall context schema named sfw_context_stats1 that specifies a schema format of:

- Total packets received by firewall: sfw-total-rxpackets
- Total packets sent by firewall: sfw-total-txpackets
- Total ICMP packets discarded by firewall: fw-icmp-discardpackets

Use the following command:

    context schema sfw_context_stats1
    format “Packets received Rx: %sfw-total-rxpackets%\nPackets
    Sent Tx:: %sfw-total-txpackets%\nICMP
    Packets discarded: %fw-icmp-discardpackets%”

cscf schema

Configures Call Session Control Function (CSCF) bulk statistics schema.
Platform:

ASR 5000
Product:

SCM
Privilege:

Security Administrator, Administrator
Syntax

    cscf schema schema_name format schema_formatno cscf schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for CSCF bulk statistics collection. Multiple CSCF-service schemas can be created to categorize CSCF-service bulk statistics. All of the schemas are processed at each collection interval. To create multiple CSCF-service schemas, re-issue the cscf schema schema_name command using a different schema name.
Example:
To create a CSCF schema named cscf_statistics that specifies a schema format of:

- Call attempts received: callattrx
- Call attempts transmitted: callatttx
- Call successes received: callsuccrx
- Call successes transmitted: callsucctx
- Call failures received: callfailrx
- Call failures transmitted: callfailtx

Use the following command:

    cscf schema cscf_statistics
    format “Call Attempts Rx: %callattrx%\nCall
    Attempts Tx: %callatttx%\nCall Successes
    Rx: %callsuccrx%\nCall Successes Tx: %callsucctx%\nCall
    Failures Rx: %callfailrx%\nCall Failures
    Tx: %callfailtx%”

cs-network-ranap schema

Configures the Radio Access Network Application Part (RANAP) bulk statistics schema in a Circuit Switched (CS) network associated with an HNB-GW node.
Platform:

ASR 5000
Product:

HNB-GW
Privilege:

Security Administrator, Administrator
Syntax

    cs-network-ranap schema schema_name format schema_formatno  cs-network-ranap
    schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for RANAP procedure related bulk statistics collection in a CS network associated with HNB-GW in a Femto UMTS network. Multiple CS Networks RANAP schemas can be created to further categorize at CS network or HNB-GW-level bulk statistics. All of the schemas are processed at each collection interval. To create multiple CS Networks RANAP schemas, re-issue the cs-network-ranap schema schema_name command using a different schema name.
Example:
The following command creates a schema named cs_ranap1stats1 that records the total number of Iu Release Request messages transmitted and total number of Iu Release Command message received by the HNB-GW node:

    cs-network-ranap schema
    cs_ranaplstats1 format “%iu-rel-req-tx%” “%iu-rel-cmd-rx%”

cs-network-rtp schema

Configures the Real-Time Transport Protocol (RTP) bulk statistics schema in a Circuit Switched (CS) network associated with an HNB-GW node.
Platform:

ASR 5000
Product:

HNB-GW
Privilege:

Security Administrator, Administrator
Syntax

    cs-network-rtp schema schema_name format schema_formatno cs-network-rtp schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for RTP procedure related bulk statistics collection in a CS network associated with HNB-GW in a Femto UMTS network. Multiple CS Networks RTP schemas can be created to further categorize at CS network or HNB-GW-level bulk statistics. All of the schemas are processed at each collection interval. To create multiple CS Networks RTP schemas, re-issue the cs-network-rtp schema schema_name command using a different schema name.
Example:
The following command creates a schema named cs_rtp1stats1 that records the total number of RTP Downlink Packets received and RTP Uplink Packets transmitted by HNB-GW node in an associated CS network:

    cs-network-rtp schema
    cs_rtplstats1 format “%rtp-uplink-pkts-tx%” “%rtp-downlink-pkts-rx%”

dcca schema

Configures Diameter Credit Control Application (DCCA) bulk statistics schema. This command is available only in StarOS 9.0 and later releases.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    dcca schema schema_name format schema_formatno dcca schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for DCCA bulk statistics collection.
default

Restores the system default for the option specified.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    default { limit | receiver
    mode | remotefile format | sample-interval | transfer-interval }

limit

Restores the memory utilization limit system default: 1000 kilobytes.
receiver mode

Restores the behavior for sending files to the receivers to the default value.

Default: secondary-on-failure
remotefile format

Restores the format of remote bulkstats file names to the default value.

Default: “%date%-%time%”
sample-interval

Restores the system default for the local polling interval for statistic sampling.

Default: 15 minutes
transfer-interval

Restores the system default for the time between transfer of data files to receivers.

Default: 480 minutes
Usage:

Restore the default values when troubleshooting the system. Setting values to the system defaults places them in well known states as starting points for monitoring for problems.
Example:

    default limit

    default transfer-interval

diameter-acct schema

Configures Diameter Accounting bulk statistics schema. This command is available only in StarOS 11.0 and later releases.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    diameter-acct schema schema_name format schema_formatno diameter-acct schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for Diameter Accounting bulk statistics collection.
diameter-auth schema

Configures Diameter Authentication bulk statistics schema. This command is available only in StarOS 11.0 and later releases.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    diameter-auth schema schema_name format schema_formatno diameter-auth schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for Diameter Authentication bulk statistics collection.
dlci-util schema

Configures the collection of statistics for the DLCI-Util (DLCI utilization) schema.
Platform:

ASR 5000
Product:

SGSN
Privilege:

Security Administrator, Administrator
Syntax

    dlci-util schema schema_name format schema_formatno dlci-util schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the format of the collected DLCI utilization statistics by identifying the statistics variables and ordering the variables for presentation within the bulk statistics messages.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for the DLCI-Util schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for DLCI-Util bulk statistics collection in the generated stats report files.. Usually a schema consists of multiple variables to collect all the statistics for a particular situation. Using double quote marks and text within this command, the reported statistics can be easily identified.

Multiple schemas can be created to categorize DLCI-Util bulk statistics. All of the schemas are processed at each collection interval. To create multiple DLCI-Util schemas, re-issue the dlci-util schema schema_name command using a different schema name each time.
Example:
Include the bulk statistic variable names to create a schema named dlciutilstats_sgsn1 that specifies collection of statistics (a schema format) for:

- card
- port
- path
- DS1/E1
- DLCI
- DLCI utilization snapshot for received packets
- DLCI utilization for received packets in the last 5 minutes
- DLCI utilization for received packets in the last 15 minutes

Use the following command:

    gprs schema gprsstats_sgsn1
    format “Card: %card%\nPort: %port%\nDLCI
    in path: %dlci_util_path%\nDS1/E1: %dlci_util_ds1e1%\nDLCI
    ID: %dlci_util_dlci_no%\nCurrent
    Rx: %dlci_util_dlci_curr_rx%\nRx
    in 5 minutes: %dlci_util_dlci_5min_rx%\nRx
    in 15 minutes: %dlci_util_dlci_15min_rx%\n”

dpca schema

Configures Diameter Policy Control Application (DPCA) bulk statistics schema. This command is available only in StarOS 9.0 and later releases.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    dpca schema schema_name format schema_formatno dpca schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for DPCA bulk statistics collection.
ecs schema

Configures Enhanced Charging Service (ECS) bulk statistics schema.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    ecs schema schema_name format schema_formatno ecs schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for ECS bulk statistics collection. Multiple ECS schemas can be created to categorize ECS bulk statistics. All of the schemas are processed at each collection interval. To create multiple ECS schemas, re-issue the ecs schema schema_name command using a different schema name.
egtpc schema

Configures the enhanced GTP-C statistics schema for naming conventions of data files.
Platform:

ASR 5000
Product:

MME, P-GW, S-GW
Privilege:

Administrator
Syntax

    egtpc schema schema_name format schema_formatno egtpc schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for enhanced GTP-C bulk statistics collection. Multiple eGTP-C service schemas can be created to categorize eGTP-C service bulk statistics. All of the schemas are processed at each collection interval. To create multiple eGTP-C service schemas, re-issue the egtpc schema schema_name command using a different schema name.
Example:
For an eGTP-C-level schema named egtpcservicestats that specifies a schema format of:

- Tunnel - Create Session Request Sent: tun-sent-cresess
- Tunnel - Create Session Request Received: tun-recv-cresess

Use the following command:

    egtpc schema egtpcservicestats
    format “Number of GTP Tunnel Requests Sent: %tun-sent-cresess%\nNumber
    of GTP Tunnel Requests Received: %tun-recv-cresess%\n”

end

Exits the current configuration mode and returns to the Exec mode.
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    end

Usage:

Use this command to return to the Exec mode.
exit

Exits the current mode and returns to the parent configuration mode.
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    exit

Usage:

Use this command to return to the parent configuration mode.
fa schema

Configures Foreign Agent (FA) bulk statistics schema.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    fa schema schema_name format schema_formatno fa schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for FA bulk statistics collection. Multiple FA service schemas can be created to categorize FA service bulk statistics. All of the schemas are processed at each collection interval. To create multiple FA service schemas, re-issue the fa schema schema_name command using a different schema name.
Example:
To create a FA-level schema named faservicestats that separates the date, time, and vpnname by tabs, enter the following command:

    fa schema faservicestats
    format %date%\t%time%\t%vpnname%

The schema format appears as follows:

    date   time   vpnname

file

Enters the Bulk Statistics File Configuration Mode which supports the configuration of “files” used for grouping bulk statistic configuration information.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    [ no ] file number

no

Removes a previously configured bulk statistic file.
number

Specifies a number for the bulkstatistics file as an integer from 1 through 4. This number is how the file is recognized by the system.
Usage:

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 in that it allows you to configure different schemas to go to different receivers. A Maximum of four files can be assigned for bulk statistics collection.

Executing this command allows you to enter the Bulk Statistics File Configuration Mode. This mode supports all of the commands from the Bulk Statistics Configuration mode except limit, local-directory, sample-interval, and transfer-interval. (these commands are configured globally for all “files”.)

IMPORTANT:

Use of bulk statistics “files” is optional. If you do not wish to configure bulk statistic “files”, you can perform a standard configuration using the commands in the Bulk Statistic Configuration Mode. Note, however, that the system logically assigns “file 1” to the standard configuration. Therefore, if you wish to configure bulk statistics “files” at a later time, “file 1” will already be used.

CAUTION:

If the Web Element Manager application is used to collect and process (XML parsing, graphing, etc.) bulk statistics data, “file 1” is used by the Web Element Manager’s default bulk statistics collection information and schemas. To avoid errors in processing by the Web Element Manager, do not configure "file 1" via the CLI. However, it is possible to configure files 1 through 4 using the system’s CLI, regardless of whether or not the Web Element Manager is configured as a receiver. In this case, the bulk statistics data is written to the server but not processed by the Web Element Manager application.
Example:
The following command creates a bulk statistics file numbered 2 and enters the Bulk Statistics File Configuration Mode:

    file 2

fng schema

Configures Femto Network Gateway (FNG) bulk statistics schema.
Platform:

ASR 5000
Product:

FNG
Privilege:

Security Administrator, Administrator
Syntax

    fng schema schema_name format schema_formatno fng schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
footer

Configures the footer string placed at the end of the generated bulk statistics data files.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    footer format schema_formatno footer format

no

Clears the footer format string which results in the default file footer being used in generated data files.
format schema_format

Specifies the footer format string for use in generated data files.

schema_format must be an alphanumeric string from 1 through 2047 characters. The format string syntax is described in the Schema Format String Syntax section. Default: ““ (an empty footer)

The following variables are supported:
Table 1. footer Command Format String Variables

Variable | Description | Data Type
--- | --- | ---
date | The date that the collection file was created in YYYYMMDD format where YYYY represents the year, MM represents the month and DD represents the day. | String
host | The system hostname that created the file | String
ipaddr | The default management (local context) IP address in ###.###.###.### format. An empty string is inserted if no address is available. | String
sysuptime | The uptime (in seconds) of the system that created the file. | 32-bit signed
time | The time that the collection file was created in HHMMSS format where HH represents the hours, MM represents the minutes, and SS represents the seconds. | String

Usage:

Define a unique footer in data files which allows for easy identification of which system generated the data file or any other useful information. The use of the variables is suggested so as to allow for a uniform footer across all systems. The hostname variable should be used to identify the source of the data in the footer and all remaining items can be formatted consistently across all chassis.
Example:
The following commands define different footer formats:

    footer format northStreet

    footer format “Created
    on: %date%-%time% by %host%”

    no footer format

gather-on-standby

Controls whether or not statistics are gathered when a system is in the standby state.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    [ no | default ] gather-on-standby

no

Does not gather bulk statistics when the system is in the standby state.
default

Resets this command to its default action of gathering bulk statistics when the system is in the standby state.
Usage:

Use this command to configure a system to either gather or not gather statistics when the system is in the standby state. This is useful for systems configured for Interchassis Session Recovery (ICSR). See the System Administration Guide for more details on this feature.

If a chassis transitions to standby state and it has accumulated but not yet transferred bulk statistics data, the previously accumulated data is transferred at the first opportunity. However, no additional statistics gathering takes place.
Example:
The following command disables gathering statistics when the system is in the standby state:

    no gather-on-standby

The following command enables the gathering of statistics when the system is in the standby state:

    gather-on-standby

gprs schema

Configures the collection of statistics for the GPRS schema.
Platform:

ASR 5000
Product:

SGSN
Privilege:

Security Administrator, Administrator
Syntax

    gprs schema schema_name format schema_formatno gprs schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 to 31 characters.
format schema_format

Specifies the format of the collected GPRS statistics by identifying the statistics variables and ordering the variables for presentation within the bulk statistics messages.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for the GPRS schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for GPRS bulk statistics collection in the generated stats report files.. Usually a schema consists of multiple variables to collect all the statistics for a particular situation. Using double quote marks and text within this command, the reported statistics can be easily identified.

Multiple GPRS schemas can be created to categorize GPRS bulk statistics. All of the schemas are processed at each collection interval. To create multiple GPRS schemas, re-issue the gprs schema schema_name command using a different schema name each time.
Example:
Include the bulk statistic variable names to create a GPRS schema named gprsstats_sgsn1 that specifies collection of statistics (a schema format) for:

- context name
- GPRS service name
- number of LLC packets dropped

Use the following command:

    gprs schema gprsstats_sgsn1
    format “Context Name: %vpnname%\nGPRS
    Service Name: %servname%\nTotal LLC Packets
    Dropped: %bssgp-total-usr-req-drop%\n”

gtpc schema

Configures GPRS Tunneling Protocol-Control (GTPC) message statistics schema.
Platform:

ASR 5000
Product:

GGSN, P-GW, S-GW
Privilege:

Security Administrator, Administrator
Syntax

    gtpc schema schema_name format schema_formatno gtpc schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for GTPC bulk statistics collection. Multiple GTPC schemas can be created to categorize GTPC bulk statistics. All of the schemas are processed at each collection interval. To create multiple GTPC schemas, re-issue the gtpc schema schema_name command using a different schema name.
Example:
To create a GTPC-level schema named gtpc_stats that specifies a schema format of:

- Context Name: vpnname
- GGSN Service Name: servname
- Total PDP Contexts Processed: setup-total

Use the following command:

    gtpc schema gtpc_stats
    format “Context Name: %vpnname%\nGGSN
    Service Name: %servname%\nTotal PDP Contexts
    Processed: %setup-total%\n”

gtpp schema

Configures GPRS Tunneling Protocol-Prime (GTPP) statistics schema.
Platform:

ASR 5000
Product:

GGSN, SGSN, P-GW, S-GW,
Privilege:

Security Administrator, Administrator
Syntax

    gtpp schema schema_name format schema_formatno gtpp schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for GTPP bulk statistics collection. Multiple GTPP schemas can be created to categorize GTPP bulk statistics. All of the schemas are processed at each collection interval. To create multiple GTPP schemas, re-issue the gtpp schema schema_name command using a different schema name.
Example:
To create a GTPP schema named gtpp_statistics that specifies a schema format of:

- Time: time
- Total Redirection Requests Received: redir-rcvd

Use the following command:

    gtpp schema gtpp_statistics
    format “Time: %time%\tTotal
    Redirection Requests Received: %redir-rcvd%\n”

gtpu schema

Configures GTP-U bulk statistics schema.
Platform:

ASR 5000
Product:

GGSN, HNB-GW, P-GW, S-GW
Privilege:

Security Administrator, Administrator
Syntax

    gtpu schema schema_name format schema_formatno gtpu schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the format of the collected GTP-U statistics by identifying the statistics variables and ordering the variables for presentation within the bulk statistics messages.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for GTP-U bulk statistics collection in the generated stats report files. Usually a schema consists of multiple variables to collect all the statistics for a particular situation. Using double quote marks and text within this command, the reported statistics can be easily identified.

Multiple GTP-U schemas can be created to categorize GTP-U bulk statistics. All of the schemas are processed at each collection interval. To create multiple GTP-U schemas, re-issue the gtpu schema schema_name command using a different schema name each time.
ha schema

Configures Home Agent (HA) bulk statistics schema.
Platform:

ASR 5000
Product:

HA
Privilege:

Security Administrator, Administrator
Syntax

    ha schema schema_name format schema_formatno ha schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for HA bulk statistics collection. Multiple HA service schemas can be created to categorize HA service bulk statistics. All of the schemas are processed at each collection interval. To create multiple HA service schemas, re-issue the ha schema schema_name command using a different schema name.
Example:
For an HA schema named haservicestats that specifies a schema format of:

- Number of HA authentication failures: reply-haauthfail
- Number of Mobile Node authentication failures: reply-mnauthfail

Use the following command:

    ha schema haservicestats
    format “Number of HA authentication failures: %reply-haauthfail%\nNumber
    of Mobile Node authentication failures: %reply-mnauthfail%\n”

header

Configures the header string placed at the beginning of the generated bulk statistics data files.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    header format schema_formatno header format

no

Clears the header format string which results in the default file header being used in generated data files.
format schema_format

Specifies the header format string for use in generated data files.

schema_format must be an alphanumeric string of 1 through 2047 characters. The format string syntax is described in the Schema Format String Syntax section. Default: ““ (an empty header)

The following variables are supported:
Table 2. header Command Format String Variables

Variable | Description | Data Type
--- | --- | ---
date | The UTC date that the collection file was created in YYYYMMDD format where YYYY represents the year, MM represents the month and DD represents the day. | String
date3 | The UTC date that the collection file was created in YYMMDD format where YY represents the year, MM represents the month and DD represents the day. | String
host | The system hostname that created the file | String
ipaddr | The default management (local context) IP address in ###.###.###.### format. An empty string is inserted if no address is available. | String
sysuptime | The uptime (in seconds) of the system that created the file. | 32-bit signed
time | The time that the collection file was created in HHMMSS format where HH represents the hours, MM represents the minutes, and SS represents the seconds. | String

Usage:

Define a unique header in data files which allows for easy identification as to which system generated the data file or any other useful information.

Using the variables described above allows for a uniform header across all systems. The hostname variable should be used to identify the source of the data in the header and all remaining items can be formatted consistently across all chassis.
Example:
The following commands define different header formats:

    header format northStreet

    header format “Created
    on: %date%-%time% by %host%”

    no header format

hnbgw-hnbap schema

Configures bulk statistics schema for HNB-Application Part (HNB-AP) message statistics collection in HNB-GW session instance.
Platform:

ASR 5000
Product:

HNB-GW
Privilege:

Security Administrator, Administrator
Syntax

    hnbgw-hnbap schema schema_name schema_formatno hnbgw-hnbap schema schema_name

no

Removes the configured HNB-GW-HNB-AP schema.
schema_name

Specifies a name for the HNB-GW-HNB-AP schema.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

This command defines schemas used for HNB-AP statistics collection. Multiple HNB-AP schemas can be created to further categorize bulk statistics. All of the schemas are processed at each collection interval. To create multiple schemas, re-issue the hnbgw-hnbap schema schema_name command using a different schema name.
Example:
The following command creates a schema named hnbap1stats1 that records the number of registered UEs and registered HNBs along with Context name, Context Id, and HNB-GW service name:

    hnbgw-hnbap schema
    hnbap1stats1 format “%vpnname%-%vpnid%-%servname%-%registered-hnb%-%registered-ue%”

To create a schema named hnbapuestats that specifies a schema format of:

- Number of UEs with CS and PS Core Network Connections: ue-with-ps-cs-conn
- Number of UEs in Idle Condition: idle-ue

Use the following command:

    hnbgw-hnbap schema
    hnbapuestats format “Number of UEs with CS and PS Core
    Network Connections: %ue-with-ps-cs-conn%\nNumber
    of UEs in Idle Condition: %idle-ue%”

hnbgw-ranap schema

Configures bulk statistics schema for Radio Access Network-Application Part (RANAP) message statistics collection in HNB-GW session instance.
Platform:

ASR 5000
Product:

HNB-GW
Privilege:

Security Administrator, Administrator
Syntax

    hnbgw-ranap schema schema_name format schema_formatno hnbgw-ranap schema schema_name

no

Removes the configured HNB-GW-RANAP schema.
schema_name

Specifies a name for the HNB-GW-RANAP schema.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

This command defines schemas used for RANAP messaging statistics collection. Multiple RANAP schemas can be created to further categorize bulk statistics. All of the schemas are processed at each collection interval. To create multiple schemas, re-issue the hnbgw-ranap schema schema_name command using a different schema name.
Example:
The following command creates a schema named ranap1stats1 that records the number of CS-Direct-Transfer messages sent and received on RANAP along with Context name, Context Id, and HNB-GW service name:

    hnbgw-ranap schema ranap1stats1
    format “%vpnname%-%vpnid%-%servname%-%cs-dir-transfer-rx%-%cs-dir-transfer-tx%”

To create a schema named ranappagingstats that specifies a schema format of:

- Number of paging requests sent on RANAP from CS Core Network Connections: cs-paging-req-tx
- Number of paging requests sent on RANAP from PS Core Network Connections: ps-paging-req-tx

Use the following command:

    hnbgw-ranap schema
    ranappagingstats format “Number of paging requests sent
    on RANAP from CS Core Network Connections: %cs-paging-req-tx%\nNumber
    of paging requests sent on RANAP from PS Core Network Connections: %ps-paging-req-tx%”

hnbgw-rtp schema

Configures bulk statistics schema for Real-Time Protocol (RTP) message statistics collection in HNB-GW session instance.
Platform:

ASR 5000
Product:

HNB-GW
Privilege:

Security Administrator, Administrator
Syntax

    hnbgw-rtp schema schema_name format schema_formatno hnbgw-rtp schema schema_name

no

Removes the configured HNB-GW-RTP schema.
schema_name

Specifies a name for the HNB-GW-RTP schema.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

This command defines schemas used for RTP messaging statistics collection. Multiple RTP schemas can be created to further categorize bulk statistics. All of the schemas are processed at each collection interval. To create multiple schemas, re-issue the hnbgw-rtp schema schema_name command using a different schema name.
Example:
The following command creates a schema named rtp1stats1 that records the number of RTP uplink packets dropped and number of RTCP application report messages received on RTP link along with Context name, Context Id, and HNB-GW service name:

    hnbgw-rtp schema rtp1stats1
    format “%vpnname%-%vpnid%-%servname%-%rtp-uplink-pkts-dropped%-%rtcp-app-report-rx%”

hnbgw-rua schema

Configures bulk statistics schema for RANAP User Adaptation (RUA) protocol message statistics collection in HNB-GW session instance.
Platform:

ASR 5000
Product:

HNB-GW
Privilege:

Security Administrator, Administrator
Syntax

    hnbgw-rua schema schema_name format schema_formatno hnbgw-rua schema schema_name

no

Removes the configured HNB-GW-RUA schema.
schema_name

Specifies a name for the HNB-GW-RUA schema.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

This command defines schemas used for RUA protocol messaging statistics collection. Multiple RUA schemas can be created to further categorize bulk statistics. All of the schemas are processed at each collection interval. To create multiple schemas, re-issue the hnbgw-rua schema schema_name command using a different schema name.
Example:
The following command creates a schema named rua1stats1 that records the number of CS-Connect messages received and sent on RUA link along with Context name, Context Id, and HNB-GW service name:

    hnbgw-rua schema rua1stats1
    format “%vpnname%-%vpnid%-%servname%-%cs-connect-rx%-%cs-connect-tx%”

hnbgw-sctp schema

Configures bulk statistics schema for Stream Control Transmission Protocol (SCTP) message statistics collection in HNB-GW session instance.
Platform:

ASR 5000
Product:

HNB-GW
Privilege:

Security Administrator, Administrator
Syntax

    hnbgw-sctp schema schema_name format schema_formatno hnbgw-sctp schema schema_name

no

Removes the configured SCTP schema.
schema_name

Specifies a name for the SCTP schema.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

This command defines schemas used for SCTP protocol messaging statistics collection. Multiple SCTP schemas can be created to further categorize bulk statistics. All of the schemas are processed at each collection interval. To create multiple schemas, re-issue the hnbgw-sctp schema schema_name command using a different schema name.
Example:
The following command creates a schema named sctp1stats1 that records the number of bytes received from lower layer and number of bytes sent to lower layer over SCTP connection along with Context name, Context Id, and HNB-GW service name:

    hnbgw-sctp schema
    sctp1stats1 format “%vpnname%-%vpnid%-%servname%-%total-bytes-sent-to-lower-layer%-%total-bytes-rcvd-from-lower-layer%%”

hsgw schema

Configures HRPD Serving Gateway (HSGW) bulk statistics schema.
Platform:

ASR 5000
Product:

HSGW
Privilege:

Security Administrator, Administrator
Syntax

    hsgw schema schema_name format schema_formatno hsgw schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the format of the collected HSGW statistics by identifying the statistics variables and ordering the variables for presentation within the bulk statistics messages.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for HSGW bulk statistics collection in the generated stats report files. Usually a schema consists of multiple variables to collect all the statistics for a particular situation. Using double quote marks and text within this command, the reported statistics can be easily identified.

Multiple HSGW schemas can be created to categorize HSGW bulk statistics. All of the schemas are processed at each collection interval. To create multiple HSGW schemas, re-issue the hsgw schema schema_name command using a different schema name each time.
imsa schema

Configures IP Multimedia System Authorization (IMSA) bulk statistics schema.
Platform:

ASR 5000
Product:

GGSN, HA, HSGW, IPSG, PDSN, P-GW, S-GW
Privilege:

Security Administrator, Administrator
Syntax

    imsa schema schema_name format schema_formatno imsa schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for IMSA bulk statistics collection in the generated stats report files. Usually a schema consists of multiple variables to collect all the statistics for a particular situation. Using double quote marks and text within this command, the reported statistics can be easily identified.

Multiple IMSA schemas can be created to categorize IMSA bulk statistics. All of the schemas are processed at each collection interval. To create multiple IMSA schemas, re-issue the imsa schema schema_name command using a different schema name each time.
ippool schema

Configures IP pool bulk statistics schema.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    ippool schema schema_name format schema_formatno ippool schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for IP pool bulk statistics collection. Multiple IP pool schemas can be created to further categorize IP pool bulk statistics. All of the schemas are processed at each collection interval. To create multiple IP pool schemas, re-issue the ippool schema schema_name command using a different schema name.
Example:
To create an IP pool schema named ippoolstats that specifies a schema format of:

- Number of IP addresses on hold: hold
- Number of free IP addresses: free

Use the following command:

    ippool schema ippoolstats
    format “Number of IP addresses on hold: %hold%\nNumber
    of free IP addresses: %free%\n”

ipsg schema

Configures IP Services Gateway (IPSG) bulk statistics schema.
Platform:

ASR 5000
Product:

IPSG
Privilege:

Security Administrator, Administrator
Syntax

    ipsg schema schema_name format schema_formatno ipsg schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define the schemas used for IPSG bulk statistics collection. Multiple IPSG schemas can be created to categorize IPSG bulk statistics. All of the schemas are processed at each collection interval. To create multiple schemas, re-issue the ipsg schema schema_name command using a different schema name.
Example:
To create an IPSG schema named ipsgstats that specifies a schema format of:

- Context name: vpnname
- Service name: servname
- Total responses sent: total-rsp-sent

Use the following command:

    ipsg schema ippoolstats
    format “Context name: %vpnname%\nService
    name: %servname%\nTotal responses sent: %total-rsp-sent%\n”

lac schema

Configures LAC (L2TP Access Concentrator) bulk statistics schema.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    lac schema schema_name format schema_formatno lac schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for LAC bulk statistics collection. Multiple LAC schemas can be created to categorize LAC bulk statistics. All of the schemas are processed at each collection interval. To create multiple schemas, re-issue the lac schema schema_name command using a different schema name.
Example:
The following command creates a schema named lac1stats1 that records the number of active subscriber sessions and the number of sessions that failed or were disconnected due to the maximum tunnel limit being reached:

    lac schema lac1stats1
    format “%sess-curactive%-%sess-maxtunnel%”

To create a schema named lacresourcestats that specifies a schema format of:

- Number of Successful Session Connections: sess-successful
- Number of Session Attempts That Failed: sess-failed
- Number of Sessions Currently Active: sess-curative

Use the following command:

    lac schema lacresourcestats
    format “Number of Successful Session Connections: %sess-successful%\nNumber
    of Session Attempts That Failed: %sess-failed%\nNumber
    of Sessions Currently Active: %sess-curative%”

limit

Configures the maximum amount of system memory bulk statistics may utilize.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    limit kilobytes

kilobytes

Specifies the maximum amount of memory (in kilobytes) that may be used for bulk statistics as an integer from 1 through 32000. Default: 100
Usage:

Adjust bulk statics memory usage when considering the sampling interval adjustments.

CAUTION:

Bulk statistics are stored in Random Access Memory (RAM) on the SPC/SMC/MIO. In the event of power loss or system failure, the statistics will be lost. If the maximum storage limit has been reached before the system's configured transfer-interval is reached, the oldest information stored in the collection will be overwritten.
Example:

    limit 2048

lma schema

Configures the Local Mobility Anchor (LMA) statistics schema for the naming conventions of data files.
Platform:

ASR 5000
Product:

P-GW
Privilege:

Administrator
Syntax

    lma schema schema_name format schema_formatno lma schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for LMA bulk statistics collection. Multiple LMA service schemas can be created to categorize LMA service bulk statistics. All of the schemas are processed at each collection interval. To create multiple LMA service schemas, re-issue the lma schema schema_name command using a different schema name.
Example:
For an LMA-level schema named lmaservicestats that specifies a schema format of:

- Binding Update Received: bindupd
- Binding Update Received - Denied: bindupd-denied

Use the following command:

    lma schema lmaservicestats
    format “Number of Binding Updates Received: %bindupd%\nNumber
    of Binding Updates Received and Denied: %bindupd-denied%\n”

lns schema

Configures LNS (L2TP Network Server) bulk statistics schema.
Platform:

ASR 5000
Product:

LNS
Privilege:

Security Administrator, Administrator
Syntax

    lns schema schema_name format schema_formatno lns schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the format of the collected LNS statistics by identifying the statistics variables and ordering the variables for presentation within the bulk statistics messages.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for LNS bulk statistics collection in the generated stats report files. Usually a schema consists of multiple variables to collect all the statistics for a particular situation. Using double quote marks and text within this command, the reported statistics can be easily identified.

Multiple LNS schemas can be created to categorize LNS bulk statistics. All of the schemas are processed at each collection interval. To create multiple LNS schemas, re-issue the lns schema schema_name command using a different schema name each time.
local-directory

Sets the local directory for storing bulkstats collection files.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    local-directory pathnameno local-directory

no

Delete the setting for local-directory.
pathname

Specifies the local path of the directory in which to store bulkstats collection files.

pathname must be an alphanumeric string of 1 through 127 characters. Pathnames are case sensitive.
Usage:

Use this command to designate a directory on a local file system in which collection files with bulkstats information are stored. The directory specified must already exist. Use the Exec Mode command mkdir to create a directory.
Example:
To specify that bulkstats collection files are stored in the local directory /flash/bulkstats, enter the following command:

    local-directory /flash/bulkstats

mag schema

Configures the Mobile Access Gateway (MAG) statistics schema for naming conventions of data files.
Platform:

ASR 5000
Product:

HSGW, S-GW
Privilege:

Administrator
Syntax

    mag schema schema_name format schema_formatno mag schema schema_name

no

Removes the specified schema from MAG bulk statistics generation.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for MAG bulk statistics collection. Multiple MAG service schemas can be created to categorize MAG service bulk statistics. All of the schemas are processed at each collection interval. To create multiple MAG service schemas, re-issue the mag schema schema_name command using a different schema name.
Example:
For a MAG-level schema named magservicestats that specifies a schema format of:

- Binding Update Sent: bindupd
- Binding Acknowledgement Received: bindack

Use the following command:

    mag schema magservicestats
    format “Number of Binding Updates Sent: %bindupd%\nNumber
    of Binding Acknowledgements Received: %bindack%\n”

mipv6ha schema

Configures MIPv6 HA (home Agent) bulk statistics schema.
Platform:

ASR 5000
Product:

HA
Privilege:

Security Administrator, Administrator
Syntax

    mipv6ha schema schema_name format schema_formatno mipv6ha schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for MIPv6 HA bulk statistics collection. Multiple MIPv6 HA bulk statistics schemas can be created to categorize MIPv6 HA bulk statistics. All of the schemas are processed at each collection interval. To create multiple MIPv6 HA service schemas, re-issue the mipv6ha schema schema_name command using a different schema name.
Example:
The following command creates a schema named mipv6haservicestats that records the number of authorization attempt failures due to access rejects from AAA:

    mipv6ha schema mipv6haservicestats
    format “%aaa-actauthfail%”

mme schema

Configures MME (Mobility Management Entity) bulk statistics schema.
Platform:

ASR 5000
Product:

MME
Privilege:

Security Administrator, Administrator
Syntax

    mme schema schema_name format schema_formatno mme schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for MME bulk statistics collection. Multiple MME bulk statistics schemas can be created to categorize MME bulk statistics. All of the schemas are processed at each collection interval. To create multiple MME service schemas, re-issue the mme schema schema_name command using a different schema name.
Example:
The following command creates a schema named mmeservice_s1ap_cfg_transfers that records the total number of S1AP - transmit data - configuration transfers:

    mme schema mmeservice_s1ap_cfg_transfersformat “s1ap-trnsdata-cfg-tfr

mvs schema

Configures MVS (Mobile Videoscape) bulk statistics schema.
Platform:

ASR 5000
Product:

MVG
Privilege:

Security Administrator, Administrator
Syntax

    mvs schema schema_name format schema_formatno mvs schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
nat-realm schema

Creates and configures Network Address Translation (NAT) realm statistics schema.
Platform:

ASR 5000
Product:

NAT
Privilege:

Security Administrator, Administrator
Syntax

    nat-realm schema schema_name format schema_formatno nat-realm schema schema_name

schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for NAT Realm bulk statistics collection. Multiple NAT realm schemas can be created to further categorize NAT realm level bulk statistics. All of the schemas are processed at each collection interval. To create multiple NAT Realm schemas, re-issue the nat-realm schema schema_name command using a different schema name.
Example:
The following command creates a NAT realm schema with the VPN name, realm name, and flows information:

    nat-realm schema realm1
    format “%vpnname% %realmname% %nat-rlm-flows%”

pdif schema

Configures Packet Data Interworking Function (PDIF) bulk statistics schema.
Platform:

ASR 5000
Product:

PDIF
Privilege:

Security Administrator, Administrator
Syntax

    pdif schema schema_name format schema_formatno pdif schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for PDIF bulk statistics collection. Multiple PDIF schemas can be created to categorize PDIF bulk statistics. All of the schemas are processed at each collection interval. To create multiple schemas, re-issue the pdif schema schema_name command using a different schema name.
Example:
The following command creates a schema named pdifschema1 for the category current active ipv4 sessions:

    pdif schema pdifschema1
    format %sess-curactip4%

pgw schema

Configures Packet Data Network Gateway (P-GW) bulk statistics schema.
Platform:

ASR 5000
Product:

P-GW
Privilege:

Security Administrator, Administrator
Syntax

    pgw schema schema_name format schema_formatno pgw schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for P-GW bulk statistics collection in the generated stats report files. Usually a schema consists of multiple variables to collect all the statistics for a particular situation. Using double quote marks and text within this command, the reported statistics can be easily identified.

Multiple P-GW schemas can be created to categorize P-GW bulk statistics. All of the schemas are processed at each collection interval. To create multiple P-GW schemas, re-issue the pgw schema schema_name command using a different schema name each time.
port schema

Configures port bulk statistics schema.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    port schema schema_name format schema_formatno port schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for port bulk statistics collection. Multiple port schemas can be created to categorize port-level bulk statistics. All of the schemas are processed at each collection interval. To create multiple port schemas, re-issue the port schema schema_name command using a different schema name.

IMPORTANT:

The card variable in the Port schema is not supported on all platforms
Example:
To create a port-level schema named portstats1 that separates the card/port, bcast_inpackets, and bcast-outpackets variables by hyphens (“-”), enter the following command:

    port schema portstats1
    format “%card%/%port% - %bcast_inpackets% - %bcast_outpackets%”

ppp schema

Configures Point-to-Point Protocol (PPP) bulk statistics schema.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    ppp schema schema_name format schema_formatno ppp schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for point-to-point protocol bulk statistics collection. Multiple PPP-service schemas can be created to categorize PPP-service bulk statistics. All of the schemas are processed at each collection interval. To create multiple PPP-service schemas, re-issue the ppp schema schema_name command using a different schema name.
Example:
To create a ppp-level schema named pppstats that specifies a schema format of:

- CHAP: (Challenge Handshake Authentication Protocol)
- Auth. Attempts: auth-attempt-chapAuth. Successes: auth-success-chap
- PAP: (Password Authentication Protocol)
- Auth. Attempts: auth-attempt-papAuth. Successes: auth-success-pap

Use the following command:

    ppp schema pppstats
    format “CHAP:\nAuth. Attempts: %auth-attempt-chap%\tAuth.
    Successes: %auth-success-chap%\nPAP:\nAuth.
    Attempts: %auth-attempt-pap%\tAuth. Successes: %auth-success-pap%\n”

ps-network-ranap schema

Configures the Radio Access Network Application Part (RANAP) bulk statistics schema in Packet Switched (PS) network associated with an HNB-GW node.
Platform:

ASR 5000
Product:

HNB-GW
Privilege:

Security Administrator, Administrator
Syntax

    ps-network-ranap schema schema_name format schema_formatno ps-network-ranap
    schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for RANAP procedure related bulk statistics collection in a PS network associated with HNB-GW in a Femto UMTS network. Multiple PS Networks RANAP schemas can be created to further categorize at PS network or HNB-GW-level bulk statistics. All of the schemas are processed at each collection interval. To create multiple PS Networks RANAP schemas, re-issue the ps-network-ranap schema schema_name command using a different schema name.
Example:
The following command creates a schema named ps_ranap1stats1 that records the total number of Iu Release Request messages transmitted and total number of Iu Release Command message received by HNB-GW node:

    ps-network-ranap schema
    ps_ranaplstats1 format “%iu-rel-req-tx%” “%iu-rel-cmd-rx%”

radius schema

Configures RADIUS bulk statistics schema.
Platform:

ASR 5000
Product:

PDSN, GGSN
Privilege:

Security Administrator, Administrator
Syntax

    radius schema schema_name format schema_formatno radius schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters that is case sensitive.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for RADIUS bulk statistics collection. Multiple RADIUS schemas can be created to categorize RADIUS bulk statistics. All of the schemas are processed at each collection interval. To create multiple RADIUS schemas, re-issue the radius schema schema_name command using a different schema name.
Example:
To create a RADIUS schema named radius_statistics that specifies a schema format of:

- Server: ipaddr
- Authentication Requests Sent: auth-req-sent
- Accounting Requests Sent: acc-req-sent

Use the following command:

    radius schema radius_statistics
    format “Server: %ipaddr%\nAuthentication
    Requests Sent: %auth-req-sent%\nAccounting
    Requests Sent: %acc-req-sent%”

receiver

Configures a host system to receive bulkstats information through Trivial File Transfer Protocol (TFTP), File Transfer Protocol (FTP) or SSH File Transfer Protocol (SFTP).
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    receiver { mode { redundant | secondary-on-failure } | ip_address { primary | secondary } [ mechanism { { { ftp | sftp } login user_name [ encrypted ] password pwd } | tftp } } ] }no receiver ip_address

no

Removes the receiver specified from the list of receivers where data files are sent.
mode { redundant | secondary-on-failure }

Determines how bulkstats are delivered to the primary and secondary receivers.

Default: secondary-on-failure

redundant: Files are transferred to both the primary and secondary receivers. If either transfer is not currently possible, the file is transferred when possible. The system continues to hold in memory as much data as possible until the data has been successfully transferred to both receivers. Data is only discarded if the in-memory data reaches the configured limit. Refer to the limit command.

secondary-on-failure: Files are transferred to the secondary receiver if the primary receiver fails. In-memory data is erased once the data is transferred to either the primary or secondary receiver. This is the default behavior.
ip_address

Specifies the IP address of the receiver of interest using IPv4 dotted-decimal notation.
primary | secondary

Primary and secondary are used to indicate the order in which receivers are connected. The secondary is used when the primary is unreachable.

primary: indicates the receiver is the primary receiver of data.

secondary: indicates the receiver is the secondary receiver of data.
mechanism { { { ftp | sftp } login user_name [ encrypted ] password pwd } | tftp } }

Specifies the method by which data is transferred to the receiver.

ftp login user_name [ encrypted ] password pwd: the FTP protocol shall be used for data file transfer. user_name specifies the user to provide for remote system secure logins and must be an alphanumeric string of 1 through 31 characters. The password to use for remote system authentication is specified as pwd and must be from 1 to 31 characters or 1 to 64 characters if the encrypted keyword is also specified.

sftp login user_name [ encrypted ] password pwd: the SFTP protocol shall be used for data file transfer. user_name specifies the user to provide for remote system secure logins and must be an alphanumeric string of 1 through 31 characters. The password to use for remote system authentication is specified as pwd and must be from 1 to 31 characters or 1 to 64 characters if the encrypted keyword is also specified.

tftp: the TFTP protocol is to be used to transfer files.

The encrypted keyword is intended only for use by the system while saving configuration scripts. The system displays the encrypted keyword in the configuration file as a flag that the variable following the password keyword is the encrypted version of the plain text password. Only the encrypted password is saved as part of the configuration file.
Usage:

Use TFTP methods to reduce transfer times if excessive system resources are being used across the network for transfer of data.

FTP transfer method allows for login which then provides system logging within the enabled FTP logs.

The initial connection is attempted to the primary receiver. If the primary receiver is unreachable for any reason, the secondary receiver is used. If the secondary receiver is also unreachable, the system retries after a delay period where it again attempts to connect to the primary receiver followed by the secondary receiver as necessary.

IMPORTANT:

For redundant receivers, configuration changes to the receivers are applied to all existing and all subsequent data sets pending transfer. If no receiver is configured, bulk statistics will be collected and stored on the system until the maximum amount of memory is used; they will not be transferred to the receiver(s). When the storage limit has been reached the oldest information is overwritten. When a receiver is configured for the primary and secondary target, this command will use both receivers as default if no receiver is specified.
Example:

    receiver 10.2.3.4
    primary mechanism tftp

    receiver 10.2.3.5 secondary

    no receiver 10.2.3.4

remotefile

Configures the naming convention with support for multiple file format to multiple receivers when storing the data files on the remote receiver(s).
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    remotefile format schema_format [ both-receivers | primary-receiver | secondary-receiver ]no remotefile format

no

Resets the remote file naming convention to the system default.
format schema_format

Specifies the naming convention format to use.

schema_format must be an alphanumeric string of 1 through 127 characters. The format string syntax is described in the Schema Format String Syntax section. Default: “%date%-%time%”

IMPORTANT:

The remote file naming format should only use static text and bulk statistic variables to avoid any possible file creation issues on the receivers.

The following variables are supported:
Table 3. remote file Command Naming Format Variables

Variable | Description | Data Type
--- | --- | ---
date | The UTC date that the collection file was created in YYYYMMDD format where YYYY represents the year, MM represents the month and DD represents the day. | String
date3 | The UTC date that the collection file was created in YYMMDD format where YY represents the year, MM represents the month and DD represents the day. | String
host | The system hostname that created the file | String
sysuptime | The uptime (in seconds) of the system that created the file. | 32-bit signed
time | The time that the collection file was created in HHMMSS format where HH represents the hours, MM represents the minutes, and SS represents the seconds. | String

both-receivers | primary-receiver | secondary-receiver

Sets the remote file creation target to both receivers, primary receiver or secondary receiver. Default: Both receivers.
Usage:

Set the remote file naming format to ensure consistent data file naming across a network or adjusting a single system’s format for easy identification.

This command specifies whether the format should be used in conjunction with both receivers, only the primary receiver, or only the secondary receiver.

IMPORTANT:

For redundant receivers, the filenames for the output data files are applied when the information is first gathered. If the name format is modified, the change takes effect for the next data set. The current data set name remains unchanged. even if has not yet been transferred.
Example:

    remotefile format simpleFormat

    remotefile format “%host%-%date%-%time%”

    remotefile format “%host%-%date%-%time%” both-receivers

    remotefile format “%host%-%date%” primary-receiver

    no remotefile format

rp schema

Configures R-P bulk statistics schema.
Platform:

ASR 5000
Product:

PDSN
Privilege:

Security Administrator, Administrator
Syntax

    rp schema schema_name format schema_formatno rp schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for R-P bulk statistics collection. Multiple PDSN service schemas can be created to categorize PDSN service bulk statistics. All of the schemas are processed at each collection interval. To create multiple PDSN service schemas, re-issue the rp schema schema_name command using a different schema name.
Example:
To create an PDSN-level schema named pdsnservicestats that specifies a schema format of:

- Date: date
- Time: time
- Number of Authentication Denials: deny-auth

Use the following command:

    rp schema rpservicestats
    format “Date: %date%\nTime: %time%\nNumber
    of Authentication Denials: %deny-auth%\n”

sample-interval

Configures the time interval between collecting local statistics.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    sample-interval minutes

minutes

Specifies the frequency (in minutes) of polling for local statistics as an integer from 1 through 1440.
Usage:

Adjust the sampling interval to tune the system response as shorter periods can cause undue system overhead whereas longer periods have less of a statistical importance when analyzing data.

The system is shipped from the factory with the sampling interval set to 15 minutes.
Example:

    sample-interval 120

sccp schema

Configures the collection of statistics for the SCCP schema.
Platform:

ASR 5000
Product:

SGSN, HNB-GW
Privilege:

Security Administrator, Administrator
Syntax

    sccp schema schema_name format schema_formatno sccp schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for the SCCP schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for SCCP bulk statistics collection in the generated stats report files.. Usually a schema consists of multiple variables to collect all the statistics for a particular situation. Using double quote marks and text within this command, the reported statistics can be easily identified.

Multiple SCCP schemas can be created to categorize SCCP bulk statistics. All of the schemas are processed at each collection interval. To create multiple SCCP schemas, re-issue the sccp schema schema_name command using a different schema name each time.
Example:
Include the bulk statistic variable names to create an SCCP schema named sccpstats11 that specifies collection of statistics (a schema format) for:

- Subsystem available messages sent from the SCCP
- Subsystem available messages received by the SCCP

Use the following command:

    sccp schema sccpstats11
    format “Subsys avail SCCP Tx: %ssa-txed%\nSubsys
    avail SCCP Rx: %ssa-rcvd%\n”

schema

Configures the system-level bulk statistics schema.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    schema schema_name format schema_formatno schema schema_name

no

Removes the specified schema.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for system-level bulk statistics collection. Multiple schemas can be created to categorize system-level bulk statistics. All of the schemas are processed at each collection interval. To create multiple system schemas, re-issue the schema schema_name command using a different schema name.
Example:
The following command creates a schema named systemstats1 that records the number of current Simple IP and the number of current Mobile IP sessions:

    schema systemstats1
    format “%sess-cursipconn% - %sess-curmipconn%”

To create a system-level schema named bulksysstats that specifies a schema format of:

- Number of currently active sessions: sess-curactcall
- Number of currently dormant sessions: sess-curdormcall

Use the following command:

    schema bulksysstats
    format “Number of currently active sessions: %sess-curactcall%\nNumber
    of currently dormant sessions: %sess-curdormcall%\n”

sgs schema

Configures the collection of statistics for the SGs schema.
Platform:

ASR 5000
Product:

MME
Privilege:

Security Administrator, Administrator
Syntax

    sgs schema schema_name format schema_formatno sgs schema schema_name

no

Removes the specified SGs schema from statistics collection.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for SGs bulk statistics collection in the generated stats report files. Usually a schema consists of multiple variables to collect all the statistics for a particular situation. Using double quote marks and text within this command, the reported statistics can be easily identified.

Multiple SGs schemas can be created to categorize SGs bulk statistics. All of the schemas are processed at each collection interval. To create multiple SGs schemas, re-issue the sgs schema schema_name command using a different schema name each time.
Example:

Include the bulk statistic variable names to create an SGs schema named stats_SGs_release that specifies a collection of statistics (a schema format) for the total number of release messages transmitted, retransmitted, and received:
Use the following command:

    sgs schema stats_SGs_release
    format “Total transmitted: %rel-req-tx%\nTotal
    retransmitted: %rel-req-retx%\nTotal
    received: %rel-req-rx%\n”

sgsn schema

Configures the collection of statistics for the SGSN schema.
Platform:

ASR 5000
Product:

SGSN
Privilege:

Security Administrator, Administrator
Syntax

    sgsn schema schema_name format schema_formatno sgsn schema schema_name

no

Removes the specified SGSN schema from statistics collection.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for SGSN bulk statistics collection in the generated stats report files. Usually a schema consists of multiple variables to collect all the statistics for a particular situation. Using double quote marks and text within this command, the reported statistics can be easily identified.

Multiple SGSN schemas can be created to categorize SGSN bulk statistics. All of the schemas are processed at each collection interval. To create multiple SGSN schemas, re-issue the sgsn schema schema_name command using a different schema name each time.
Example:

Include the bulk statistic variable names to create an SGSN schema named stats_3Gsgsn1 that specifies collection of statistics (a schema format) for the total number of 3G Attaches per LAC/RAC per MCC& MNC:
Use the following command:

    sgsn schema stats_3Gsgsn1
    format “MCC: %mcc%\nMNC: %mnc%\nLAC: %lac%\nRAC: %rac%\nTotal
    3G Subs Attached: %3G-attached%\n”

sgtp schema

Configures the collection of the SGSN’s GTP-C and GTP-U activity statistics.
Platform:

ASR 5000
Product:

SGSN
Privilege:

Security Administrator, Administrator
Syntax

    sgtp schema schema_name format schema_formatno sgtp schema schema_name

no

Removes the specified SGTP schema from statistics collection.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for SGTP bulk statistics collection in the generated stats report files.. Usually a schema consists of multiple variables to collect all the statistics for a particular situation. Using double quote marks and text within this command, the reported statistics can be easily identified.

Multiple SGTP schemas can be created to categorize SGTP bulk statistics. All of the schemas are processed at each collection interval. To create multiple SGTP schemas, re-issue the sgtp schema schema_name command using a different schema name each time.
Example:

Include the bulk statistic variable names to create an SGTP schema named sgtpstats_sgsn1 that specifies collection of statistics (a schema format) will be by IuPS service interface and by RNC for the total number of GTP-C Create PDP Context Request messages received.
Use the following command:

    sgtp schema sgtpstats_sgsn1
    format “IuPS Service ID: %iups-service%\nRNC: %rnc-address%\nTotal
    CPCR Rx: %sgtpc-total-cpc-req%\n”

sgw schema

Configures the collection of the S-GW activity statistics.
Platform:

ASR 5000
Product:

S-GW
Privilege:

Administrator
Syntax

    sgw schema schema_name format schema_formatno sgw schema schema_name

no

Removes the specified S-GW schema from statistics collection.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for S-GW bulk statistics collection in the generated stats report files.. Usually a schema consists of multiple variables to collect all the statistics for a particular situation. Using double quote marks and text within this command, the reported statistics can be easily identified.

Multiple S-GW schemas can be created to categorize S-GW bulk statistics. All of the schemas are processed at each collection interval. To create multiple S-GW schemas, re-issue the sgw schema schema_name command using a different schema name each time.
Example:

Include the bulk statistic variable names to create an S-GW schema named sgwstats_sgw1 that specifies collection of statistics (a schema format) will be by S-GW service interface for the total number of currently idle and active UEs.
Use the following command:

    sgw schema sgwstats_sgw1
    format “SGW Service ID: %servname%\nTotal
    Current Idle Ues: %sessstat-totcur-ueidle%\nTotal
    Current Active Ues: %sessstat-totcur-ueactive%\n”

show variables

Displays the bulk statistics variable information based on schema names.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    show variables [ schema_name ] [ obsolete ]

show variables schema_name

Displays all valid bulkstat schema statistics, or only the statistics for the specified schema.
schema_name specifies the name of the schemas available on the system. Following is the list of available schemas in this release.

- aal2
- alcap
- apn
- asngw
- asnpc
- bcmcs
- card
- closedrp
- common
- context
- cs-network-ranap
- cs-network-rtp
- cscf
- cscfintf
- dcca
- diameter-acct
- diameter-auth
- dlci-util
- dpca
- ecs
- egtpc
- epdg
- fa
- fng
- gprs
- gtpc
- gtpp
- gtpu
- ha
- hnbgw-hnbap
- hnbgw-ranap
- hnbgw-rtp
- hnbgw-rua
- hnbgw-sctp
- hsgw
- imsa
- ippool
- ipsg
- lac
- lma
- lns
- mag
- map
- mipv6ha
- mme
- mvs
- nat-realm
- pdg
- pdif
- pgw
- phsgw
- phspc
- port
- ppp
- ps-network-ranap
- radius
- rp
- sccp
- sgs
- sgsn
- sgtp
- sgw
- ss7link
- ss7rd
- system
- vpn

obsolete

Displays obsolete (but still available) schema variables. An asterisk (*) is displayed next to schema variables that have been obsoleted.
Usage:

Use this command to list supported bulk statistic variables. Variables can be listed for a specified schema. If no schema is specified, all supported variables are listed on a per-schema basis.
Example:
The following command displays the bulkstat variables only for the card schema:

    show variables card

ss7link schema

Configures the collection of the SS7 link activity statistics.
Platform:

ASR 5000
Product:

SGSN
Privilege:

Security Administrator, Administrator
Syntax

    ss7link schema schema_name format schema_formatno ss7link schema schema_name

no

Removes the specified SS7 Link schema from statistics collection.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for SS7 link and linkset bulk statistics collection per SS7 routing domain in a generated stats report file. Usually a schema consists of multiple variables to collect all the statistics for a particular situation. Using double quote marks and text within this command, the reported statistics can be easily identified.

Multiple collection schemas can be created to categorize SS7 link bulk statistics. All of the schemas are processed at each collection interval. To create multiple SS7 link schemas, re-issue the ss7link schema schema_name command using a different schema name each time.
Example:
The following command creates a schema named ss7lnk1stats1 that records the changeover orders sent and received per linkset and link and per SS7 routing domain:

    ss7link schema ss7lnk1stats1
    format “%ss7rd-number%-%ss7-linkset-id%-%ss7-link-id%-%ss7rd-asp_instance%-%ss7-link-mtp3-changeover-order-tx%-%ss7-link-mtp3-changeover-order-rx%”

ss7rd schema

Configures the collection of bulk statistics for SS7 routing domain services, which include the activity statistics for SCTP, MTP, and M3UA data.
Platform:

ASR 5000
Product:

SGSN, HNB-GW
Privilege:

Security Administrator, Administrator
Syntax

    ss7rd schema schema_name format schema_formatno ss7rd schema schema_name

no

Removes the specified SS7 routing domain schema from statistics collection.
schema_name

Specifies the schema’s name.

schema_name must be an alphanumeric string of 1 through 31 characters.
format schema_format

Specifies the schema’s format.

schema_format must be an alphanumeric string of 1 through “1021 minus “number of characters in rest of the command, including spaces”” characters. For more information, see the Schema Format String Length section.

For information on the schema format’s syntax, see the Schema Format String Syntax section.

IMPORTANT:

For a complete list of the statistics that are supported for this schema, refer to the Statistics and Counters Reference.
Usage:

Use this command to define schemas for collection of SS7 routing domain statistics to be included in the generated stats report file. Usually a schema consists of multiple variables to collect all the statistics for a particular situation. Using double quote marks and text within this command, the reported statistics can be easily identified.

Multiple collection schemas can be created to categorize SS7 routing domain bulk statistics. All of the schemas are processed at each collection interval. To create multiple SS7 routing domain schemas, re-issue the ss7rd schema schema_name command using a different schema name each time.
Example:
The following command creates a schema named ss7rd1stats1 that identifies the SS7 routing domain and records the Application Server Process instance in the SS7 routing domain, along with the total number of sent and received SHUTDOWN messages per SS7 routing domain:

    ss7rd schema ss7rd1stats1
    format “%ss7rd-number%-%ss7rd-asp_instance%-%ss7rd-sctp-shutdown-tx%-%ss7rd-sctp-shutdown-rx%”

transfer-interval

Configures the frequency of transfer of collected statistics to the receiver.
Platform:

ASR 5000
Product:

All
Privilege:

Security Administrator, Administrator
Syntax

    transfer-interval minutes

minutes

Specifies the number of minutes between the transfer of collected statistics to the receivers as an integer from 1 through 999999.
Usage:

Modify the transfer interval based upon the number of sessions per second. As the number of session requests a second increases it may become necessary to increase the transfer interval to reduce the processing overhead frequency for statistics delivery. This is tempered by the impact reduced resolution of statical data has on usefulness of data when the interval gets larger than the least busy hours and most busy hours of the day.

The system is shipped from the factory with the transfer interval set to 480 minutes.
Example:

    transfer-interval 1440