Using the SOAP LEG Command-Line Utility (CLU)

This module describes the command-line utility commands when the software is installed on the Subscriber Manager.

Information About the p3soap Utility

The SOAP LEG contains its own Command-Line Utility (CLU) commands, called p3soap, for retrieving information and statistics about the LEG.

The p3soap utility displays the LEG configuration and statistics. The command format is p3soap <operation>[OPTIONS].

The following tables lists the p3soap operations.

Table 4-1 p3soap Operations
Operation	Description
`--show`	Displays all of SOAP LEG configuration and status
`--show-statistics`	Displays statistics for the SOAP LEG including: failed queries, queries sent, queries received
`--show-version`	Displays the SOAP LEG version number
`--set-username`	Sets the username and password to enable secure queries via the SOAP communication protocol
`--reset-username`	Resets the username to cancel the secure queries

Table 4-2 p3soap User Options
User Option	Abbreviation	Description
`--username=USER-NAME`	`-u`	Specifies the name of the user. Used with the --set-usernameand --reset-usernameoperations.
`--password=USER-PASSWORD`	`-P`	Specifies the password of the user. Used with the --set-usernameand --reset-usernameoperations.

Table 4-3 p3soap Miscellaneous Options
Option	Abbreviation	Description
`--remote=IP[:port]`	`-r`	(Optional) Used with the --set-usernameand --reset-usernameoperations to configure secure queries on the remote SM in High Availability setups. The Port option should be used if the PRPC Server port on the remove SM machine differs from the default value (14374).

Viewing the SOAP LEG Status

The following is an example of using the p3soapcommand-line utility with the showoperation:

>p3soap --showSOAP LEG: 
========= 
Active:   true 
Url:      http://1.1.1.1:8080/services/ProvisioningServiceSoap.asmx 
Username: N/A 
Logging: 
Log all queries:    true 
Log failed queries: true 
Command terminated successfully 
>

Viewing the SOAP LEG Statistics

The following is an example of using the p3soapcommand line utility with the show-statisticsoperation:

>p3soap --show-statisticsSOAP LEG statistics 
=================== 
Successful logins:          3 
Failed queries:             1 
Failed package association: 0 
Queries in process:         0 
Max-Concurrent queries:     0 
Command terminated successfully 
>

Viewing the SOAP LEG Version

The following is an example of using the p3soapcommand line utility with the show-versionoperation:

>p3soap --show-versionSOAP LEG 3.1.0 Build 176 
Command terminated successfully 
>

Setting the username and password for Secure Requests

The following is an example of using the p3soapcommand line utility with the set-usernameoperation:

>p3soap --set-username --username=cisco --password=ciscoCommand terminated successfully 
>

Resetting the username and password for Secure Requests

The following is an example of using the p3soapcommand line utility with the reset-usernameoperation:

>p3soap --reset-usernameCommand terminated successfully 
>

Table Of Contents