Cisco SCMS Quota Manager User Guide, Release 3.8.x

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Book Contents

Find Matches in This Book

Available Languages

Download Options

Book Title

Cisco SCMS Quota Manager User Guide, Release 3.8.x

Chapter Title

Using the Quota Manager Command-

PDF - Complete Book (1.39 MB) PDF - This Chapter (148.0 KB)
View with Adobe Reader on a variety of devices

Results

Updated:: December 7, 2013

Chapter: Using the Quota Manager Command-

Introduction
Quota Manager CLU Description

Using the Quota Manager Command-Line Utility

Revised: February 25, 2013, OL-26872-05

Introduction

This chapter describes the Quota Manager (QM) command-line utility (CLU).

Quota Manager CLU Description

The QM CLU (p3qm) displays the Cisco Service Control Quota Manager configuration, status, and statistics. The command format is p3qm <operation>. Table 4-1 lists the p3qm operations.

Table 4-1 p3qm Operations
Operation	Description
--show-config [--package packageId]	Displays all the Cisco Service Control Quota Manager profiles. To display only a certain profile, use the --package option.
--show-quota -s subscriber name [--detail]	Displays the quota status of a specific subscriber. To specify a subscriber name, use the -s option. To display each slice period detail for the subscriber consumption, add the --detail tag. For configuration with multiple Cisco SCEs enabled, displays the Cisco SCE details that reported the quota.
--show-statistics [-n/--ne-name=NAME]	Displays counters of Cisco Service Control Quota Manager messages handled. To display the statistics of a specific Cisco SCE, use the -n option.
--show-connections [-n/--ne-name=NAME]	Displays all the Cisco SCE connections to the Cisco Service Control Quota Manager along with their connection status. Use the -n option to display the connection status of a specific Cisco SCE.
--show-subs-in-breach [-q/--quota-profile=QUOTA-PROFILE-NAME]	Displays all the subscribers that are currently breached. If the --quota-profile option is used, this command displays the subscribers that are in breach and belong to a certain quota profile.
--show-subs-in-penalty [-q/--quota-profile=QUOTA-PROFILE-NAME]	Displays all the subscribers that are currently in penalty. If the --quota-profile option is used, this command displays the subscribers that are in penalty and belong to a certain quota profile.
--set-quota -s subscriber name -b/--bucket bucket ID=bucket value	Sets the quota for a specific bucket of a subscriber. After the quota is set, the Cisco Service Control Quota Manager initiates a remaining quota RDR¹ from the Cisco SCE. Therefore, if the subscriber was breached, the new quota is available immediately.
--add-quota -s subscriber name -b/--bucket bucket ID=bucket value	Adds quota to a specific bucket of a subscriber. After the quota is added, the Cisco Service Control Quota Manager initiates a remaining quota RDR from the Cisco SCE. Therefore, if the subscriber was breached, the new quota is available immediately.
--replenish-quota -s subscriber name	Replenishes the quota buckets for a specific subscriber without starting a new aggregation period. To specify the subscriber name, use the -s option. Use this CLU in cases when it is required to bypass the Quota Manager internal replenishment logic.
--get-quota -s subscriber name [--detail]	Triggers a remaining quota indication to be sent from the Cisco SCE² for a specific subscriber. To specify the subscriber name, use the -s option. To display each slice period detail for the subscriber consumption, add the --detail tag. After using this CLU, the output is the same as the show-quota CLU. However, after using this get-quota CLU, the quota manager is up-to-date with the Cisco SCE and so the displayed information is the latest available. Use this CLU if the quota dosage is large and the rate of the remaining quota indications is low.
--enable-logging -s subscriber name	Debugs or troubleshoots. It adds all quota events and quota provisions that are related to a specific subscriber to the user log. To specify the subscriber name, use the -s option. There is no output from this CLU.
--disable-logging -s subscriber name	Disables logging of quota events and quota provisions that are related to a specific subscriber to the user log. To specify the subscriber name, use the -s option. There is no output from this CLU.
--reset-statistics [-n/--ne-name=NAME]	Resets counters of Cisco Service Control Quota Manager messages handled. To reset the counters of a specific Cisco SCE, use the -n option.
--help	Displays a list of available operations and arguments, with a short explanation of their meanings.

¹RDR = Raw Data Record.

²SCE = Service Control Engine.

Viewing the Quota Manager Configuration

The following example shows the p3qm CLU using the show-config command:

> p3qm --show-config

Quota-profile1:

Bucket Sizes = 1000,1000

Dosage Sizes = 10,10

Aggregation Period = Daily

Day of Week = Sunday

Time of Day = 00:00

Aggregation Period Gap = 0

Modification Timestamp = Thu Aug 17 14:50:300 IDT 2006

Command terminated successfully

The following example shows the p3qm CLU using the show-config command output when multiple quota buckets with penalty profile is configured:

> p3qm --show-config

QP11:

Packages = 1

Bucket Sizes = 10086,20016

Dosage Sizes = 1000,2000

Number of slice = 6

Slice period = 10

Penalty Profile = QP22,QP33

Penalty Period = NONE

Post-Penalty Profile(s):

Aggregation Period = 60 Minutes

Time of Day = 00:00

Aggregation Period Gap = 0%

Modification Timestamp = Mon Mar 12 18:59:42 IST 2012

QP22:

Packages = 2

Bucket Sizes = 5084,20016

Dosage Sizes = 1000,2000

Number of slice = 4

Slice period = 10

Penalty Profile = QP44,QP55

Penalty Period = 30 minutes

Post-Penalty Profile(s):

Bucket 1, quota consumption < 508 = QP11

Bucket 2, quota consumption < 4003 = QP11

Bucket 1, quota consumption < 4575 = QP22

Bucket 2, quota consumption < 18014 = QP22

Aggregation Period = 40 Minutes

Time of Day = 00:00

Aggregation Period Gap = 0%

Modification Timestamp = Mon Mar 12 18:59:42 IST 2012

QP33:

Packages = 3

Bucket Sizes = 10083,10014

Dosage Sizes = 1000,2000

Number of slice = 3

Slice period = 10

Penalty Profile = QP66,QP77

Penalty Period = 30 minutes

Post-Penalty Profile(s):

Bucket 1, quota consumption < 1008 = QP11

Bucket 2, quota consumption < 2002 = QP11

Bucket 1, quota consumption < 9074 = QP33

Bucket 2, quota consumption < 9012 = QP33

Aggregation Period = 30 Minutes

Time of Day = 00:00

Aggregation Period Gap = 0%

Modification Timestamp = Mon Mar 12 18:59:42 IST 2012

QP44:

Packages = 4

Bucket Sizes = 5082,20016

Dosage Sizes = 1000,2000

Number of slice = 3

Slice period = 10

Penalty Profile = QP44,QP55

Penalty Period = 30 minutes

Post-Penalty Profile(s):

Bucket 1, quota consumption < 508 = QP11

Bucket 2, quota consumption < 4003 = QP11

Bucket 1, quota consumption < 4573 = QP22

Bucket 2, quota consumption < 18014 = QP22

Aggregation Period = 30 Minutes

Time of Day = 00:00

Aggregation Period Gap = 0%

Modification Timestamp = Mon Mar 12 18:59:42 IST 2012

QP55:

Packages = 5

Bucket Sizes = 10086,10014

Dosage Sizes = 1000,2000

Number of slice = 3

Slice period = 10

Penalty Profile = QP66,QP77

Penalty Period = 30 minutes

Post-Penalty Profile(s):

Bucket 1, quota consumption < 1008 = QP11

Bucket 2, quota consumption < 2002 = QP11

Bucket 1, quota consumption < 9077 = QP33

Bucket 2, quota consumption < 9012 = QP33

Aggregation Period = 30 Minutes

Time of Day = 00:00

Aggregation Period Gap = 0%

Modification Timestamp = Mon Mar 12 18:59:42 IST 2012

QP66:

Packages = 6

Bucket Sizes = 5082,20016

Dosage Sizes = 1000,2000

Number of slice = 6

Slice period = 10

Penalty Profile = QP44,QP55

Penalty Period = 20 minutes

Post-Penalty Profile(s):

Bucket 1, quota consumption < 508 = QP11

Bucket 2, quota consumption < 8006 = QP11

Bucket 1, quota consumption < 4573 = QP22

Bucket 2, quota consumption < 18014 = QP22

Aggregation Period = 60 Minutes

Time of Day = 00:00

Aggregation Period Gap = 0%

Modification Timestamp = Mon Mar 12 18:59:42 IST 2012

QP77:

Packages = 7

Bucket Sizes = 5082,20016

Dosage Sizes = 1000,2000

Number of slice = 6

Slice period = 10

Penalty Profile = none

Penalty Period = 60 minutes

Post-Penalty Profile(s):

Bucket 1, quota consumption < 508 = QP11

Bucket 2, quota consumption < 8006 = QP11

Bucket 1, quota consumption < 4573 = QP22

Bucket 2, quota consumption < 18014 = QP22

Aggregation Period = 60 Minutes Time of Day = 00:00

Aggregation Period Gap = 0%

Modification Timestamp = Mon Mar 12 18:59:42 IST 2012

Command terminated successfully

Viewing the Current Quota Status

The following example shows the p3qm CLU using the show-quota command:

> p3qm --show-quota -s subscriber name

Package ID = 1

Last SCE that consumed quota = 10.56.217.84

Aggregation Period:

Last Replenish Time = Tue May 05 13:22:01 IDT 2009

Aggregation Period End = Tue May 05 13:23:00 IDT 2009

Quota Buckets:

Bucket 1 - Quota size = 500, Remaining Quota = 500, Last quota reported by SCE = 50

Bucket 2 - Quota size = 500, Remaining Quota = 500, Last quota reported by SCE = 50

Penalty start = TIME_NOT_SET

Next penalty monitor = TIME_NOT_SET

Command terminated successfully

The following example shows the p3qm CLU using the show-quota command with multiple SCEs enabled:

> p3qm --show-quota -s sub1 --detail

Package ID = 11

Last SCE that consumed quota = 10.78.242.197

Aggregation Period:

Last Replenish Time = Thu Aug 19 13:21:19 IST 2010

Aggregation Period End = Thu Aug 19 13:24:00 IST 2010

Quota Buckets:

Bucket 1 - Quota size = 1000, Remaining Quota = -50, Last quota reported by SCE = -50

Slices info:

Slice 1: Start = Thu Aug 19 13:21:00 IST 2010, Consumed Quota = -50

SCE that reported Quota = 10.78.241.198, Remaining SCE quota = 300

SCE that reported Quota = 10.78.242.197, Remaining SCE quota = -50

Subscriber is breached on SCE: 10.78.242.197

Subscriber is breached on the following SCE's:

10.78.242.197   Thu Aug 19 15:33:00 IST 2010

Command terminated successfully

Viewing the Quota Manager Statistics

The following example shows the p3qm CLU using the show-statistics command (the number in parenthesis is the rate):

> p3qm --show-statistics

Quota Manager Statistics:

=========================

SCE2000 (10.56.209.197): connected

Quota State Restore Notifications:      34 (0.4)

Quota Status Notifications:             0 (0)

Quota Below Threshold Notifications:    10 (0)

Quota Depleted Notifications:           0 (0)

Quota Update Sent:                      128 (45.4)

Quota Update Success Acknowledge:       128 (45.4)

Quota Update Failure Acknowledge:       0 (0)

Command terminated successfully

Viewing the SCE Connections

The following example shows the p3qm CLU using the show-connections command:

> p3qm --show-connections

sce1 (10.56.217.81): connected

sce2 (10.56.217.82): not connected

Command terminated successfully

Viewing the Breached Subscribers

The following example shows the p3qm CLU using the show-breached-subs command:

> p3qm --show-subs-in-breach [-q/--quota-profile=QUOTA-PROFILE-NAME]

Subscriber1

Subscriber2

Subscriber3

Subscriber4

Subscriber5

System found 5 subscribers

Command terminated successfully

Viewing the Subscribers in Penalty

The following example shows the p3qm CLU using the show-subs-in-penalty command:

> p3qm --show-subs-in-penalty [-q/--quota-profile=QUOTA-PROFILE-NAME]

Subscriber1

Subscriber2

Subscriber3

Subscriber4

Subscriber5

System found 5 subscribers

Command terminated successfully

Setting Subscriber Quota

The following example shows the p3qm CLU using the set-quota command:

> p3qm --set-quota -s sub1 -b 1=1000,2=2000

Command terminated successfully

This command sets the sub1 quota bucket 1 to 1000 and quota bucket 2 to 2000.

Adding to Subscriber Quota

The following example shows the p3qm CLU using the add-quota command:

> p3qm --add-quota -s sub1 -b 1=1000,2=2000

Command terminated successfully

This command adds 1000 to the sub1 quota bucket 1 and 2000 to the sub1 quota bucket 2.

Replenishing Subscriber Quota

The following example shows the p3qm CLU using the replenish-quota command:

> p3qm --replenish-quota -s subscriber name

Quota was replenished:

Bucket 1: 1000

Bucket 2: 500

Command terminated successfully

Getting Subscriber Quota

The following example shows the p3qm CLU using the get-quota command:

> p3qm --get-quota -s subscriber name

Quota status was sent from SCE:

Package ID = 1

Last SCE that consumed quota = 10.56.217.81

Aggregation Period:

Last Replenish Time = Thu Aug 17 15:41:23 IDT 2006

Aggregation Period End = Fri Aug 18 00:00:00 IDT 2006

Quota Buckets:

Bucket 1 - Remaining Quota 495 (Last quota reported by SCE is 5)

Bucket 2 - Remaining Quota 1000 (Last quota reported by SCE is 10)

Command terminated successfully

The get-quota command is different from the show-quota command in that it requests the SCE to send a remaining quota indication, waits for the response, and displays the quota. The show-quota command displays the quota without getting the latest update from the SCE. Therefore, the get-quota command gives more accurate results.

Enabling Logging on a Subscriber

The following example shows the p3qm CLU using the enable-logging command:

> p3qm --enable-logging -s subscriber name

Command terminated successfully

Disabling Logging on a Subscriber

The following example shows the p3qm CLU using the disable-logging command:

> p3qm --disable-logging -s subscriber name

Command terminated successfully

Resetting Statistics

The following example shows the p3qm CLU using the reset-statistics command:

> p3qm --reset-statistics [-n/--ne-name=NAME]

Command terminated successfully

Obtaining Help

The following example shows the p3qm CLU using the help command:

> p3qm --help

Usage: p3qm <OPERATION> [OPTION]

QM operations:


--show-config	Displays the Quota Manager server configuration parameters. Can be used with --package to display a specific profile.
--show-quota	Displays the remaining quota of a subscriber.
--show-connections	Displays the current devices connected to the server.
--show-statistics	Displays statistics counters related to the Quota Manager. Can be used with -n to display statistics of a specific SCE.
--reset-statistics	Resets statistics counters related to the Quota Manager. Can be used with -n to reset statistics of a specific SCE.
--replenish-quota	Replenish all quota buckets for a subscriber without starting a new aggregation period.
--set-quota	Sets quota buckets of a subscriber to new values without starting a new aggregation period.
--add-quota	Adds quota to specific quota buckets of a subscriber without starting a new aggregation period.
--get-quota	Requests a quota-status indication to be sent from the SCE.
--enable-logging	Enable logging of all quota indications and provisions for a specific subscriber.
--disable-logging	Disable logging of all quota indications and provisions for a specific subscriber.
--show-subs-in-breach	Displays all subscribers that are currently breached. If --quota-profile option is used this operation displays the subscribers that are in breach and belong to a certain Quota Profile.
--show-subs-in-penalty	Displays all the subscribers that are currently in penalty. If --quota-profile option is used, this operation displays the subscribers that are in penalty and belong to a certain Quota Profile.

QM options:


-s/--subscriber=NAME	Perform the operation using this subscriber NAME
-n/--ne-name=NAME	Perform the operation using this SCE platform
-b/--bucket=KEY=VAL[,MORE]	Perform the operation using the bucket IDs and bucket values
-q/--quota-profile=NAME	Perform the operation using the quota profile NAME. This operation can be used in --show-breached-subs and in --show-subs-in-penalty operations.
--detail	Used with --show-quota and --get-quota whether to display a detailed view of subscriber quota
--package=NUMBER	Perform the operation using this package ID

Command terminated successfully

Was this Document Helpful?

Feedback

Contact Cisco

Open a Support Case
(Requires a Cisco Service Contract)