This appendix describes the Command-Line Utilities (CLU) that are distributed with the Subscriber Manager application.
The Subscriber Manager provides a set of Command-Line Utilities (CLU) that enable you to view Subscriber Manager operations and statistics and to perform subscriber management. You can use the CLU to configure the Subscriber Manager only indirectly; that is, you use the CLU to load an edited configuration file onto the Subscriber Manager.
This appendix describes the CLU commands, their operations, and options. The shorter descriptions of the CLU commands presented in Chapter 5 "Configuration and Management" focus on the performance of routine management and configuration tasks.
You can execute CLU commands only if you are logged in to the machine by using the pcude account, which is always installed (see Chapter 4 "Installation and Upgrading"). The CLU runs as a process that is separate from the Subscriber Manager. The CLU communicates with the Subscriber Manager through a predefined communication port and interface. Therefore, the Subscriber Manager must keep open a communication port at all times, at least locally on the configured machine.
This section describes in the Command-Line Utilities commands.
•Parsing CLU Operations and Options
The following CLUs are not documented in this guide.
All CLU commands support the following operations for informative output:
|
|
---|---|
--help |
Prints the help for the specified CLU command, then exits. |
--version |
Prints the Subscriber Manager program version number, then exits. |
Place in quotation marks a command operation or option that contains any of the following characters:
•A space character
•A separation sign (comma ","; ampersand "&"; colon ":")
•An escape character (backslash "\")
•Parenthesis ("("or")")
•An exclamation mark ("!")
•The comparison operators ("<"or">")
A command operation or option that contains any of the following characters must have that character preceded by an escape character:
•An equal sign (=)
•A quotation mark ("or")
•An escape character (backslash "\")
•An exclamation mark ("!")
•The "$" character
The following table presents several examples of the preceding rules:
You can use one-letter abbreviations for some of the operations and options. For example, -d is an abbreviation for --domain. Note that only one hyphen (-), not two, precedes the letter for an abbreviation, and that if the operation or option takes a parameter, there is a space and not an equal sign before the parameter.
Example of using complete name |
--domain=subscribers |
Example of using abbreviated name |
-d subscribers |
The p3batch utility enables you to run many operations on a single connection with the Subscriber Manager. You can use any text editor to create a batch file that contains a series of CLU commands, one command per line (terminated by a new-line character). Use the p3batch utility to run this file and execute the commands. Empty lines are skipped.
All batch file command line operations use the same connection option. The p3batch utility ignores any connection options in the script file commands. While processing the operations in the batch file, the system displays a progress indicator. The p3batch command has the following format:
p3batch [FILE-OPTION] [ERROR-OPTION]
Table B-1 and Table B-2 list the p3batch options.
Examples
The following command runs the batch file, which halts if an error occurs.
p3batch --file=mainBatchFile.txt
The following command runs the batch file so that it does not halt if an error occurs.
p3batch --file=mainBatchFile.txt --skip-errors
In a cable environment, the CPE is the subscriber and inherits its policy and domain from the cable modem through which it connects to the network. Each cable modem is linked with one or more CPEs. For background information about special characteristics of the cable environment, see the "CPE as Subscriber in Cable Environment" section.
You can use the p3cable utility commands to import to the Subscriber Manager cable modem information from a CSV file. The command also enables you to export the cable modem information from the Subscriber Manager to a CSV file. You can also use this utility to clear the repository of all cable modems and to allow or deny the login of CPEs that belong to unfamiliar cable modems (that is, cable modems that do not exist in the Subscriber Manager database). However, the contents of the Cable Adapter Section of the configuration file (p3sm.cfg) determine whether such logins are allowed or denied. (See the "Cable Adapter Section" section.)
The p3cable command has the following format:
p3cable OPERATION [FILE-OPTIONS]
Table B-3 and Table B-4 list the p3cable operations and options.
Examples
The following command imports cable modem information from the specified CSV file:
p3cable --import-cm -f CMFile.csv
The following command exports cable modem information to the specified CSV file:
p3cable --export-cm --outfile=myCMFile.csv
The following command clears the repository of all cable modems:
p3cable --clear-all-cm
The following displays whether to allow or deny the login of CPEs that belong to unfamiliar cable modems (cable modems that do not exist in Subscriber Manager database):
p3cable --show-dynamic-mode
The p3clu utility prints a list of all supported CLU utilities and options.
The p3clu command has the following format:
p3clu OPERATION
Table B-5 lists the p3clu operations.
|
|
---|---|
--help |
Prints the currently supported CLU commands. |
Example
The following command displays a listing of all supported CLU utilities and operations:
p3clu --help
The p3cluster utility displays the redundancy state of a cluster of two Subscriber Manager nodes and its components. This utility also supports operations that alter the redundancy state of the Subscriber Manager. Perform these operations and administrative tasks through the Subscriber Manager Cluster Agent.
The p3cluster command has the following format:
p3cluster OPERATION
Table B-6 lists the p3cluster operations.
Example
The following command displays the redundancy status of the Subscriber Manager and its components:
p3cluster --show
The p3db utility manages and monitors the Subscriber Manager database database. The CLU exposes capabilities of some of the Subscriber Manager database CLUs that pertain to specific needs of the Subscriber Manager.
The p3db command has the following format:
p3db OPERATION [OPTIONS]
Table B-7 and Table B-8 list the p3db operations and options.
|
|
---|---|
--rep-status |
Displays status of the replication agent. |
--rep-start |
Starts the replication agent. Note |
--rep-stop |
Stops the replication agent. Note |
--rep-pause |
Pauses the replication agent. Used in cluster upgrades. |
--rep-continue |
Continues the replication agent. Used in cluster upgrades. |
--set-rep-scheme |
Assigns a replication scheme to the database. |
--drop-rep-scheme |
Drops the replication scheme from the database. |
--status |
Displays the database status. |
--destroy-rep-db |
Destroys the replicated data-store. |
--destroy-local-db |
Destroys the local data-store. |
--duplicate |
Copies the data-store from the remote machine to the local machine. Note |
--upgrade-rep-protocol |
Upgrades the replication protocol between the databases in the cluster. |
--keep-in-mem [SECS] |
Indicates to the database daemon how many seconds to keep the database in the memory, after the last connection to the database is down. Use this option with large databases to reduce the Subscriber Manager restart time. Note |
--num-of-subs |
Displays the current number of subscribers in the database. |
--sub-exists |
Verifies whether a particular subscriber exists in the database. |
|
|
---|---|
--local=LOCAL_HOSTNAME
|
Specifies the local machine. |
--remote=REMOTE_HOSTNAME
|
Specifies the remote machine. |
Example
The following command displays the status of the replication agent:
p3db --rep-status
The p3domains utility displays the subscriber domains. When a system has more than one SCE platform, you can configure the platforms into groups or domains. A subscriber domain is one or more SCE platforms that share a specified group of subscribers. You must add the SCE platform to the network and create the domain before you can add an SCE platform to a domain.
The p3domains command has the following format:
p3domains OPERATION [OPTIONS]
Table B-9 and Table B-10 list the p3domains operations and options.
|
|
---|---|
--show-all |
Displays all configured domains. |
--show |
Displays a domain and its associated network elements. |
Examples
The following command displays all configured domains:
p3domains --show-all
The following command displays the specified domain and its associated network elements:
p3domains --show --domain=myDomain
The p3ftp utility monitors the Subscriber Manager internal FTP server.
The p3ftp command has the following format:
p3ftp OPERATION
Table B-11 lists the p3ftp operations and options.
Example
The following command displays the port number that the FTP server listens to, the passive FTP port range that the server uses, the current number of open sessions, the maximum number of sessions supported, and the state (ONLINE/OFFLINE) of the FTP server.
p3ftp --show
The p3http utility monitors the HTTP adapter server.
Note The HTTP adapter server is a technician interface that normally should not be used.
The p3http command has the following format:
p3http OPERATION
Table B-12 lists the p3http operations:
|
|
---|---|
--show |
Displays the port number that the server listens to, the state of the server, and the current number of open sessions. |
Example
The following command displays the port number to which the server listens, the state of the server, and the current number of open sessions:
p3http --show
The p3inst utility installs or uninstalls an application (pqi file).
Note Before using p3inst to install an application pqi file, read the application installation instructions that came with the application you are installing.
The p3inst command has the following format:
p3inst OPERATION [FILE-OPTION] [ARGUMENT-OPTION]
Table B-13, Table B-14, and Table B-15 list the p3inst operations and options.
|
|
---|---|
--arg=ARG1[,ARG2...] |
Specifies one or more arguments for the install and upgrade procedures. |
Example
The following command installs the specified installation file:
p3inst --install --file=myInstallation.pqi
The following command uninstalls the specified installation file:
p3inst --uninstall -f oldInstallation.pqi
The following command upgrades an existing application using the specified application pqi file:
p3inst --upgrade --file=newInstallation.pqi
The following command upgrades an existing application using the specified application pqi file, and using arguments in the command line:
p3inst --upgrade -f newInstallation.pqi
The following command returns the specified application to the previous version:
p3inst --rollback
The following command displays the contents of the specified application pqi file:
p3inst --describe --file=myInstallation.pqi
Tne following command lists the details of the last installed application pqi file:
p3inst --show-last
The p3log utility configures and manages the Subscriber Manager user log. The user log contains all user-related events and errors. View the user log for the history of the system events and errors.
The p3log command has the following format:
p3log OPERATION [FILE-OPTION]
Table B-16 and Table B-17 list the p3log operations and options.
|
|
|
---|---|---|
--extract |
Retrieves the user log from the agent. |
Progress indicator |
--reset |
Clears the user log. |
— |
|
|
|
---|---|---|
--output=FILE |
-o FILE |
Specifies the location to which the Subscriber Manager user log file should be extracted. |
Examples
The following command extracts the Subscriber Manager user log to the specified file:
p3log --extract -o aug20.log
The following command clears the Subscriber Manager user log:
p3log --reset
The p3net utility shows the connection status of network elements and tries to reconnect disconnected elements.
The p3net command has the following format:
p3net OPERATION [NETWORK-ELEMENT-OPTION]
Table B-18 and Table B-19 list the p3net operations and options.
Examples
The following command connects a disconnected element to the network:
p3net --connect -n mainNE
The following command displays the names of all configured network elements:
p3net --show-all Network Element name list: ========================== sceRome sceLondon
sceRome is a cascade setup containing two SCEs. This is displayed as a single entry in the list.
The following command displays all configured network element details in a table:
p3net --show-all --detail ===================================================================== | Name | Host | Conn- | Sync- | Domain | | | Status| Status | ===================================================================== | sceRome | 1.2.3.4* | up | done | subscribers | sceRome | 1.2.3.5 | up | done | subscribers | sceLondon | 1.2.3.6 | up | done | domain1
sceRome is a cascade setup containing two SCEs. This is displayed as two entries with the same name where `*' represents the currently active SCE.
Note The Subscriber Manager does not synchronize the standby SCE; therefore, the Subscriber Management field on the standby SCE might appear as not-done if the SCE was never active.
The following command displays the connection status of the specified network element:
p3net --show --ne-name=mainNE Network Element Information: ============================ Name: mainNE Host: 1.1.1.1 Ip: 1.1.1.1 Port: 14374 Status: Connection ready Type: SCE2000 Domain: subscribers Synchronization Status: done Redundancy Status: Standalone Quarantine Status: ok
The following command displays the connection status of cascaded SCEs. Specify the SCE name that appears in the configuration file:
p3net --show -n test Network Element Information: ============================ Name: test Host: 1.1.1.1 Ip: 1.1.1.1 Port: 14374 Status: Connection ready Type: SCE2000 Domain: subscribers Synchronization Status: done Redundancy Status: Active Quarantine Status: ok Network Element Information: ============================ Name: test Host: 2.2.2.2 Ip: 2.2.2.2 Port: 14374 Status: Connection ready Type: SCE2000 Domain: subscribers Synchronization Status: not-done Redundancy Status: Standby Quarantine Status: ok
The p3rdr utility displays configuration information and statistics for the RDR server.
The p3rdr command has the following format:
p3rdr OPERATION
Table B-20 lists the p3rdr operations.
Examples
The following command displays the status of the RDR server and the current configuration:
p3rdr --show Active: true Port: 33001 Connections:
Max-limit: 10 connections
Current: 2 connections
Command terminated successfully
>
The following command displays the current RDR statistics:
p3rdr --show-statistics RDR Server Statistics:
======================
Handled RDRs: 12
Bad RDRs: 0
Current rate: 12.0 RDRs per second
Peak rate: 12.0 RDRs per second
Client statistics:
-----------------:
Connection from 10.1.8.81 statistics:
Handled RDRs: 7
Bad RDRs: 0
Current rate: 7.0
Is connected: true
Times connected: 1
Connection from 10.1.8.82 statistics:
Handled RDRs: 5
Bad RDRs: 0
Current rate: 5.0
Is connected: true
Times connected: 1
Command terminated successfully
>
The following command displays the current number of RDR server connections:
p3rdr --show-connections The following clients are connected:
10.1.8.81 - 1 connection
10.1.8.82 - 1 connection
Command terminated successfully
>
The p3rpc utility displays information about the proprietary Cisco Remote Procedure Call (RPC) server interface to the Subscriber Manager. It also authenticates users.
The p3rpc command has the following format:
p3rpc OPERATION [OPTIONS]
Table B-21, Table B-22, and Table B-23 list the p3rpc operations and options.
|
|
---|---|
--show |
Displays the port number to which the PRPC server listens, the maximum number of connections, the current number of active connections, and the host IP to which the server listens. |
--show-client-names |
Displays the names of the connected clients. Can be used for extracting the LEG_NAME key, see the "LEG-Domains Association Section" section. |
--show-statistics |
Displays the PRPC server statistics. The statistics include information about the number of current PRPC sessions and information about PRPC server actions such as invocations and errors. |
--reset-statistics |
Clears the PRPC server statistics. |
--set-user |
Adds or updates the username and password. |
--validate-password |
Validates the username and password. |
--delete-user |
Deletes a user configuration. |
--show-users |
Displays all configured users. |
Examples
The following command displays the port number to which the PRPC server listens, the maximum number of connections, the current number of active connections, the host IP to which the server listens, and the name of the configuration file used by the server:
p3rpc --show
The following command displays the statistics of the PRPC server:
p3rpc --show-statistics
The following command clears the statistics of the PRPC server:
p3rpc --reset-statistics
The following command shows all of the users configured at the PRPC server:
p3rpc --show-users
The p3sm utility performs general configuration and management of the Subscriber Manager.
The p3sm command has the following format:
p3sm OPERATION [OPTIONS]
Table B-24, Table B-25, Table B-26, and Table B-27 list the p3sm operations and options.
|
|
|
---|---|---|
--show |
Displays the current Subscriber Manager configuration and statistics. |
— |
--load-config |
Reloads the Subscriber Manager configuration file. If you do not use the -f option, the p3sm.cfg file is loaded. |
— |
--resync |
Resynchronizes subscribers of the specified SCE with the Subscriber Manager database. The SCE is specified using the option --ne-name=SCE_NAME. |
Progress indicator |
--resync-all |
Resynchronizes all subscribers of all SCEs with the Subscriber Manager database. |
Progress indicator |
--start [--wait] |
Starts the server. The option --wait causes the CLU to return only after the Subscriber Manager is up. |
Default: started |
--stop |
Stops the server. Note 1. 2. 3. |
— |
--restart [--wait] |
Stops the server operation and then restarts it. The option --wait causes the CLU to return only after the Subscriber Manager is up. |
— |
--sm-version |
Displays the currently installed Subscriber Manager version. |
— |
--sm-status [--detail] |
Displays the Subscriber Manager operational status, whether the Subscriber Manager is running or not, and whether it is Active or Standby. If errors have occurred, it also displays a summary of the errors. To receive a detailed description, use the option --detail. |
— |
--extract-support-file |
Retrieves the support file from the agent. This command extracts the Subscriber Manager support information to a defined file, which is defined using the option --output=FILE. Subscriber Manager support information should be extracted and sent to Cisco customer support with each support request. |
— |
--reset-sm-status |
Clears errors and warnings that were displayed. |
— |
--logging=[on/off] |
Enables/disables the logging of user logons to the UserLog. Note |
— |
--show-stats |
Displays statistics regarding login operations and inactive subscriber removal operations. The rate results are updated once every 10 seconds. |
— |
--reset-stats |
Resets the statistics information. |
— |
|
|
|
---|---|---|
--ne-name=NAME |
-n NAME |
Specifies logical NAME of the SCE platform to resynchronize. |
Examples
The following command starts the server:
p3sm --start
The following command stops the server:
p3sm --stop
When using fail-over, a simple shut-down of the Subscriber Manager does not work. The Veritas Cluster Server reveals that the Subscriber Manager is down and attempts to restart it. The correct procedure is as follows:
Step 1 Perform the manual fail-over. See Chapter 3 "Subscriber Manager Fail-Over".
Step 2 Use the Veritas Cluster Manager Application to stop the monitoring (probing) of the Subscriber Manager.
Step 3 Use the Subscriber Manager CLU (p3sm --stop) to stop the Subscriber Manager
The following command displays the Subscriber Manager configuration:
>p3sm --show Subscriber Management Module Information: ========================================= Persistency in SCE (static): false Auto-resync at SCE reconnect: true Save subscriber state on logout: false Pull mode is on: false LEG block mode is on: false Logon logging is on: false Statistics: Number of logins: 1872423 Number of logouts: 1824239 Number of auto-logouts: 0 Number of pull requests: 0 LEG-SM link failure: Clear all subscribers mappings: false Timeout: 60 Up time: 4 hours 16 minutes 44 seconds Inactive Subscribers Removal: Is Enabled: false Inactivity timeout: 1 hours Max removal rate: 10 subscribers per second Task interval: 10 minutes Last run time: Was never run Automatic Logout (lease-time support): Is Enabled: false Max logout rate: 50 IP addresses per second Task interval: disabled Grace period: 10 seconds Last run time: Was never run Command terminated successfully
The following command resynchronizes the subscribers of the specified SCE with the Subscriber Manager database:
p3sm --resync --ne-name=my_SCE_100
The following command stops the server operation and then restarts it:
p3sm --restart
The following command reloads the Subscriber Manager configuration file, p3sm.cfg:
p3sm --load-config
The following command displays the Subscriber Manager operational status (active or inactive):
>p3sm --sm-status SM is running. SM operational state is Active Command terminated successfully
The following command extracts the Subscriber Manager support information to the specified file:
p3sm --extract-support-file --output=support.zip
The following command displays statistics regarding login operations and inactive subscriber removal:
>p3sm --show-stats Subscriber Management Statistics Information: ============================================ Number of logins: 1872423 Login rate: 10.34 Number of logouts: 1824239 Logout rate: 10.67 Number of auto-logouts: 0 Auto-logout rate: 0 Number of pull requests: 0 Pull requests rate: 0 Inactive Subscriber Removal Information: ============================================ Number of inactive subscribers removed: 56732 Inactive subscribers removal rate: 9.98 Command terminated successfully
The p3subs utility manipulates individual subscriber information in the Subscriber Manager database. The subscriber properties that are supported by the SCA BB Console are packageId, upVlinkId, and downVlinkId. For a description of the subscriber properties, see Cisco Service Control Application for Broadband User Guide.
The p3subs command has the following format:
p3subs OPERATION [SUBSCRIBER-OPTIONS]
Table B-28 and Table B-29 list the p3subs operations and options.
Examples
The following command adds a subscriber with the specified IP address:
p3subs --add --subscriber=xyz --ip=96.142.12.7
The following command overwrites subscriber information (because the subscriber xyz already exists, this operation would fail, but the overwrite option allows the IP address to be overwritten):
p3subs --add --subscriber=xyz --ip=96.128.128.42 --overwrite
The following command sets a property value for the specified subscriber:
p3subs --set --subscriber=xyz --property=packageId=1
The following command adds new mappings for the specified subscriber; any existing ones are overwritten:
p3subs --set --subscriber=xyz --ip=96.142.12.8
The following command adds new mappings to the existing ones for the specified subscriber:
p3subs --set --subscriber=xyz --ip=96.142.12.0/24 --additive-mappings
The following command adds tunneled IP addresses of a VPN, existing mappings are overwritten:
p3subs --set --subscriber=xyz --ip=10.1.1.0/24@myVpn
The following command adds all tunneled IP addresses of a VPN, existing mappings are overwritten:
p3subs --set --subscriber=xyz --vpn=myVpn
The following command adds a community of a VPN, existing mappings are overwritten:
p3subs --set --subscriber=xyz --community=1:10@myVpn
The following command displays information for the specified subscriber:
p3subs --show --subscriber=xyz
The following command removes the specified subscriber:
p3subs --remove --subscriber=xyz
The following command displays all the mappings for the specified subscriber:
p3subs --show-all-mappings --subscriber=zyz
The following command removes the specified mappings for the specified subscriber:
p3subs --remove-mappings --subscriber=xyz --ip=96.142.12.7,96.128.128.42
The following command removes a range of consecutive mappings for the specified subscriber:
p3subs --remove-mappings --subscriber=xyz --ip=1.1.1.0/30
The following command removes all the mappings for the specified subscriber:
p3subs --remove-all-mappings --subscriber=xyz
The following command displays the value of the specified property for the specified subscriber:
p3subs --show-property --subscriber=xyz --property=reporting
The following command displays the values of all the properties for the specified subscriber:
p3subs --show-all-properties --subscriber=xyz
The following command displays all the property names and descriptions:
p3subs --show-all-property-names
The following command resets a specified property of a specified subscriber to its default value:
p3subs --reset-property --subscriber=xyz --property=rdr.transaction.generate
The following command clears the applicative state of the specified subscriber. This command clears only the backup copy at the Subscriber Manager. It does not clear the applicative state record in the SCE platform:
p3subs --clear-state --subscriber=xyz
The p3subsdb utility manages the subscriber database and performs operations on groups of subscribers.
The p3subsdb command has the following format:
p3subsdb OPERATION [OPTIONS] [FILE-OPTIONS]
Table B-30, Table B-31, and Table B-32 list the p3subsdb operations and options.
|
|
|
---|---|---|
--clear-all |
Removes all subscriber records from the Subscriber Manager database. |
Progress indicator |
--clear-domain |
Removes all subscriber records from the specified domain. |
Progress indicator |
--show-num |
Displays the number of subscribers in the database for the specified domain. |
— |
--show-all |
Lists all the subscriber names. |
— |
--show-domain |
Lists all the subscriber names in the specified domain. |
— |
--import |
Imports subscribers to the database from a specified CSV file. See the "Subscriber CSV File Format used by SCA BB Console for import/export" section. The filename of the file to be imported is specified using the format "--file=import-filename". The results go to a result file, import-results.txt, which is created in the same directory as the CSV file. |
Progress indicator |
--export |
Exports subscribers from the database to a specified CSV file. See "Subscriber CSV File Format used by SCA BB Console for import/export" section. The filename of the file to be exported is specified using the format "--output=export-filename". The results go to a result file, export-results.txt, which is created in the same directory as the CSV file. |
Progress indicator |
--clear-all-states |
Clears the state of all subscribers in the Subscriber Manager database. |
— |
--remove-property |
Removes a specified property from all subscribers in the system. Note |
— |
--remove-all-ip |
Removes all the IP addresses of all subscribers. |
— |
--remove |
Removes all the subscribers that are specified in the CSV file from the Subscriber Manager. |
— |
Lines in subscriber CSV files have the following fixed format:
subscriber-id,domain,mappings,package-id,upstream Virtual Link id,downstream Virtual Link id
If no domain is specified, the default domain (subscribers) is assigned.
The following is an example CSV file for use with the Subscriber Manager CLU:
JerryS,subscribers,80.179.152.159,0,0,0 ElainB,,194.90.12.2,3,12,1
For a complete description of the subscriber properties see Cisco Service Control Application for Broadband User Guide.
Examples
The following command imports subscribers from a specified CSV file:
p3subsdb --import --file=mySubscriberFile.csv
The following command exports subscribers to a specified CSV file:
p3subsdb --export -o mySubscriberFile.csv
The following command exports subscribers to a specified CSV file, using filtering options:
p3subsdb --export --prefix=a --output=mySubscriberFile.csv
The following command exports subscribers to a specified CSV file, using filtering options:
p3subsdb --export --prefix=a -o a.csv
The following command removes all subscriber records from the Subscriber Manager database:
p3subsdb --clear-all
The following command removes all subscriber records from the specified domain:
p3subsdb --clear-domain --domain=myDomain
The following command lists all the subscribers:
p3subsdb --show-all
The following command lists all subscribers in a specified domain:
p3subsdb --show-domain --domain=myDomain
The following command shows the number of subscribers in a specified domain:
p3subsdb --show-num --domain=myDomain
The following command lists all subscribers who have no domain specified:
p3subsdb --show-domain --domain=none
The following command clears the state of all subscribers in the Subscriber Manager database:
p3subsdb --clear-all-state
The following command removes a property from all subscriber records:
p3subsdb --remove-property --property=monitor
The p3vpn utility manages the VPN entities in the Subscriber Manager.
The p3vpn command has the following format:
p3vpn OPERATION [OPTIONS] [FILE-OPTIONS]
Table B-33, Table B-34, and Table B-35 list the p3vpn operations and options.
|
|
---|---|
--add |
Adds a VPN to the Subscriber Manager. The operation fails if the VPN exists. |
--set |
Updates a VPN in the Subscriber Manager. A new mapping overwrites all existing mappings, unless the --additive-mapping option is used. |
--remove |
Removes the specified VPN. |
--remove-mappings |
Removes the specified mappings of the specified VPN. |
--remove-all-mappings |
Removes all mappings of the specified VPN. |
--show |
Displays information for the specified VPN. |
--show-subs |
Displays all the subscribers that belong to the specified VPN. |
--show-all |
Displays all VPN names. |
--show-all-mappings |
Displays all the mappings for the specified VPN. |
--show-num |
Displays the total number of VPNs. |
--import |
Imports VPNs from a CSV file. See the "VPN CSV File Format for import/export" section. The filename of the file to be imported is specified using the format "--file=import-filename". The results go to a result file, import-results.txt, which is created in the same directory as the CSV file. |
--export |
Export VPNs to a CSV file. See the "VPN CSV File Format for import/export" section. The filename of the file to be exported is specified using the format "--output=export-filename". The results go to a result file, export-results.txt, which is created in the same directory as the CSV file. |
--remove |
Remove the VPNs specified by a CSV file. The filename of the file that contains the VPNs to be removed is specified using the format "--file=remove-filename". The results go to a result file, remove-results.txt, which is created in the same directory as the CSV file. |
--remove-all-vlan |
Removes all the VLAN-ids of all VPNs. |
--remove-all-mpls-vpn |
Removes all the MPLS/VPN mappings of all VPNs. |
When working with VLAN mapping types, you must configure the SCE by using the following CLI:
SCE2000#>configure
SCE2000(config)#>in li 0
SCE2000(config if)#>VLAN symmetric classify
Lines in VPN CSV files have the following fixed format:
vpn-id,domain,mappings
If no domain is specified, the default domain (subscribers) is assigned.
The following is an example CSV file for use with the Subscriber Manager CLU:
MPLS-VPN,subscribers,1:1000@1.1.1.1 VLAN-VPN,subscribers,10
Examples
The following command adds a VPN with the specified VLAN:
p3vpn --add -vpn=myVpn --vlan-id=10
The following command adds new mappings for the specified VPN; any existing ones are overwritten:
p3vpn --set --vpn=myVpn --vlan-id=11
The following command adds new mappings to the existing ones for the specified subscriber:
p3vpn --set --vpn=myVpn --vlan-id=12 --additive-mappings
The following command adds a VPN with the specified MPLS/VPN mappings:
p3vpn --add --vpn=myVpn --mpls-vpn=1:100@96.142.12.7
The following command displays information for the specified VPN:
p3vpn --show --vpn=myVpn
The following command removes the specified VPN:
p3vpn --remove --vpn=myVpn
The following command displays all the mappings for the specified VPN:
p3vpn --show-all-mappings --vpn=myVpn
The following command removes the specified mappings for the specified VPN:
p3vpn --remove-mappings --vpn=myVPN --vlan-id=10
The following command removes all the mappings for the specified subscriber:
p3vpn --remove-all-mappings --vpn=myVpn
The p3bgp utility controls the operation of the BGP LEG and displays its status. For information about this CLU, see the "Using the MPLS/VPN BGP LEG CLU" chapter in Cisco SCMS SM LEGs User Guide.
The p3dhcpsniff utility displays the SCE-Sniffer DHCP LEG configuration, status, and statistics. For information about this CLU, see the "Using the SCE-Sniffer DHCP LEG CLU" chapter in Cisco SCMS SM LEGs User Guide.
The p3leasequery utility displays the DHCP Lease Query LEG configuration, status, and statistics. For information about this CLU, see the "Subscriber Manager Integration - Configuration" chapter in Cisco SCMS SM LEGs User Guide.
The p3radius utility displays the statistics of the RADIUS Listener LEG. For information about this CLU, see the "Using the RADIUS Listener LEG CLU" chapter in Cisco SCMS SM LEGs User Guide.
The p3radiussniff utility displays the SCE-Sniffer RADIUS LEG configuration and statistics. For information about this CLU, see the "Using the SCE-Sniffer RADIUS LEG CLU" chapter in Cisco SCMS SM LEGs User Guide.
The p3qm utility displays the quota manager configuration, status, and statistics. For information about this CLU, see the "Using the Quota Manager CLU" chapter in Cisco Service Control Management Suite Quota Manager User Guide.
The p3soap utility displays the SOAP LEG configuration and statistics. For information about this CLU, see the "Using the SOAP LEG CLU" chapter in Cisco SCMS SM LEGs User Guide.
The p3vlink utility displays the virtual link statistics of the Virtual Link Manager. For information about this CLU, see Cisco Service Control for Managing Remote Cable MSO Links Solution Guide.
The p3ipdr utility displays the IPDR server and IPDR LEG information. For information about this CLU, see the "Using the IPDR LEG CLU" chapter in Cisco SCMS SM LEGs User Guide.