Feedback
Table Of Contents
Command Line Interface Commands
Command Line Interface Commands
This chapter describes each of the PMC Command Line Interface (CLI) commands in detail.
For each command, this chapter provides the following information, as appropriate:
•
Description—Explains what the command does
•
•
•
•
Table 2-1 lists the PMC CLI commands. It also provides a brief description of each command, and a reference to the section that describes the command in detail.
Note
Activate Command
The Activate command toggles the Activate/Deactivate button on the specified PTT channel.
If the Activate/Deactivate button is active, issuing this command deactivates it. If the Activate/Deactivate button is not active, issuing this command activates it. There are no return codes for this command.
Syntax
The syntax of this command is:
PMC.EXE -Activate [-line #]
The -line # option, where # is a number 1 through 8, specifies the PTT channel to which this command applies. If you omit this option, the command will apply to channel 1.
Examples
Table 2-2 shows examples of the Activate command.
Related Command
•
ClearAllDebug Command
The ClearAllDebug command clears all debug options that are currently selected on the PMC Debug menu.
Syntax
The syntax of this command is:
PMC.EXE -ClearAllDebug
Related Commands
•
•
•
•
ClearDebug Command
The ClearDebug command clears the specified debug option on the PMC Debug menu.
Syntax
The syntax of this command is:
PMC.EXE -ClearDebug option
The option argument is the name of the debug option to clear.
Examples
Table 2-3 shows examples of the ClearDebug command.
Related Commands
•
•
•
•
DownVolume Command
The DownVolume decreases the volume for the specified PTT channel by a value of 10, to a minimum value of 0. This command has the same effect as clicking the PMC Decrease Volume button. There are no return codes for this command.
Syntax
The syntax of this command is:
PMC.EXE -DownVolume [-line #]
The -line # option, where # is a number 1 through 8, specifies the PTT channel to which this command applies. If you omit this option, the command will apply to channel 1.
Examples
Table 2-4 shows examples of the DownVolume command.
Related Commands
•
•
•
GetDebug Command
The GetDebug command returns a code that indicates whether the specified debug option is selected on the PMC Debug menu.
.Syntax
The syntax of this command is:
PMC.EXE -GetDebug option
The option argument is the name of the debug option for which to obtain information.
Return Codes
Table 2-5 shows the return codes for the GetDebug command.
Table 2-5 Return Codes for the GetDebug Command
0
The specified debug option is not selected
1
The specified debug option is selected
Examples
Table 2-6 shows examples of the GetDebug command.
Related Commands
•
•
•
•
GetLog Command
The GetLog command returns a code that indicates whether logging to the specified log file is on or off.
Syntax
The syntax of this command is:
PMC.EXE -GetLog file
The file argument is one of the following strings, which specifies the log file for which to obtain information:
•
•
•
•
Return Codes
Table 2-7 shows the return codes for the GetLog command.
Table 2-7 Return Codes for the GetLog Command
0
Logging to the specified log file is off
1
Logging to the specified log file is on
Examples
Table 2-8 shows examples of the GetLog command.
Related Commands
•
•
GetSkin Command
The GetSkin command returns a code that indicates the skin that is selected for the PMC. This command recognizes only the skins that are provided with the PMC.
Syntax
The syntax of this command is:
PMC.EXE -GetSkin
Return Codes
Table 2-9 shows the return codes for the GetSkin command.
GetVolume Command
The GetVolume command returns a code that represents the audio output volume that is set for the specified PTT channel.
Syntax
The syntax of this command is:
PMC.EXE -GetVolume [-line #]
The -line # option, where # is a number 1 through 8, specifies the PTT channel to which this command applies. If you omit this option, the command will apply to channel 1.
Return Codes
Table 2-10 shows the return codes for the GetVolume command.
Table 2-10 Return Codes for the GetVolume Command
0
Minimum volume level
1 through 99
Intermediate volume levels
100
Maximum volume level
Related Commands
•
•
•
IsActive Command
The IsActive command returns a code that designates whether the selected channel is active.
Syntax
PMC.EXE -IsActive [-line #]
The -line # option, where # is a number 1 through 8, specifies the PTT channel to which this command applies. If you omit this option, the command will apply to channel 1.
Return Codes
Table 2-11 shows the return codes for the IsActive command.
Table 2-11 Return Codes for the IsActive Command
0
Specified channel is not active
1
Specified channel is active
Related Command
•
IsConfigured Command
The IsConfigured command returns a code that designates whether the selected channel has been configured in Cisco IPICS.
Syntax
PMC.EXE -IsConfigured [-line #]
The -line # option, where # is a number 1 through 8, specifies the PTT channel to which this command applies. If you omit this option, the command will apply to channel 1.
Return Codes
Table 2-12 shows the return codes for the IsConfigured command.
Table 2-12 Return Codes for the IsConfigured Command
0
Specified channel is not configured
1
Specified channel is configured
IsEnabled Command
The IsEnabled command returns a code that designates whether the selected channel is enabled in Cisco IPICS.
Syntax
PMC.EXE -IsEnabled [-line #]
The -line # option, where # is a number 1 through 8, specifies the PTT channel to which this command applies. If you omit this option, the command will apply to channel 1.
Return Codes
Table 2-13 shows the return codes for the IsEnabled command.
Table 2-13 Return Codes for the IsEnabled Command
0
Specified channel is not enabled
1
Specified channel is enabled
IsLatch Command
The IsLatch command determines whether the PMC PTT button for the specified channel is latched. The return code indicates the state of the PTT button.
Syntax
The syntax of this command is:
PMC.EXE -IsLatch [-line #]
The -line # option, where # is a number 1 through 8, specifies the PTT channel to which this command applies. If you omit this option, the command will apply to channel 1.
Return Codes
Table 2-14 shows the return codes for the IsLatch command.
Table 2-14 Return Codes for the IsLatch Command
0
PTT button is not latched
1
PTT button is latched
Related Command
•
IsTraffic Command
The IsTraffic command determines whether there is any receive (RX) or transmit (TX) traffic on the specified PTT channel. The return code indicates the type of traffic present.
Syntax
The syntax of this command is:
PMC.EXE -IsTraffic [-line #]
The -line # option, where # is a number 1 through 8, specifies the PTT channel to which this command applies. If you omit this option, the command will apply to channel 1.
Return Codes
Table 2-15 shows the return codes for the IsTraffic command.
Table 2-15 Return Codes for the IsTraffic Command
0
No traffic detected
1
Receive traffic detected
2
Transmit traffic detected
3
Receive traffic and transmit traffic detected
IsTxMuted Command
The IsTxMuted command returns a code that designates whether the selected channel is muted by Cisco IPICS. When a channel is muted, a PMC user cannot transmit on that channel.
Syntax
PMC.EXE -IsTxMuted [-line #]
The -line # option, where # is a number 1 through 8, specifies the PTT channel to which this command applies. If you omit this option, the command will apply to channel 1.
Return Codes
Table 2-16 shows the return codes for the IsTxMuted command.
Table 2-16 Return Codes for the IsTxMuted Command
0
Specified channel is not muted
1
Specified channel is muted
Play Command
The Play command outputs a wave audio file to the specified PTT channel.
Specifically, this command latches the PMC PTT button, plays the designated wave file, and then unlatches the PTT button. There are no return codes for this command.
Syntax
The syntax of this command is:
PMC.EXE -Play file [-line #]
The file argument is the path and file name of the wave file to play.
The -line # option, where # is a number 1 through 8, specifies the PTT channel lie to which this command applies. If you omit this option, the command will apply to channel 1.
Examples
Table 2-17 shows examples of the Play command.
Ptt Command
The Ptt (push-to-talk) command latches or unlatches the PMC PTT button for the specified PTT channel.
If the PTT button is latched, issuing this command unlatches it. If the PTT button is unlatched, issuing this command latches it. There are no return codes for this command.
Syntax
The syntax of this command is:
PMC.EXE -Ptt [-line #]
The -line # option, where # is a number 1 through 8, specifies the PTT channel to which this command applies. If you omit this option, the command will apply to channel 1.
Examples
Table 2-18 shows examples of the Ptt command.
Related Command
•
SetAllDebug Command
The SetAllDebug command selects all debug options that are available on the PMC Debug menu.
Note
Syntax
The syntax of this command is:
PMC.EXE -SetAllDebug
Related Commands
•
•
•
•
SetDebug Command
The SetDebug command selects the specified debug option on the PMC Debug menu.
Note
Syntax
The syntax of this command is:
PMC.EXE -SetDebug option
The option argument is the name of the debug option to select.
Examples
Table 2-19 shows examples of the SetDebug command.
Related Commands
•
•
•
•
SetVolume Command
The SetVolume command specifies the audio output volume for the specified PTT channel. It also returns a code that represents the output volume.
Syntax
The syntax of this command is:
PMC.EXE -SetVolume level [-line #]
The level argument is a number, 0 through 100, which specifies the output volume. The minimum volume level is 0, and the maximum volume level is 100.
The -line # option, where # is a number 1 through 8, specifies the PTT channel to which this command applies. If you omit this option, the command will apply to channel 1.
Return Codes
Table 2-20 shows the return codes for the SetVolume command.
Table 2-20 Return Codes for the SetVolume Command
0
Minimum volume level
1 through 99
Intermediate volume levels
100
Maximum volume level
Examples
Table 2-21 shows examples of the SetVolume command.
Related Commands
•
•
•
StartLog Command
The StartLog command turns on logging to the specified log file.
Syntax
The syntax of this command is:
PMC.EXE -StartLog file
The file argument is one of the following strings, which specifies the log file for which to turn on logging:
•
•
•
•
Examples
Table 2-22 shows examples of the StartLog command.
Related Commands
•
•
StopLog Command
The StopLog command turns off logging to the specified log file.
Syntax
The syntax of this command is:
PMC.EXE -StopLog file
The file argument is one of the following strings, which specifies the log file for which to turn off logging:
•
•
•
•
Examples
Table 2-23 shows examples of the StopLog command.
Related Commands
•
•
UpVolume Command
The UpVolume command increases the volume for the specified PTT channel by a value of 10, to a maximum value of 100. This command has the same effect as clicking the PMC Increase Volume button. There are no return codes for this command.
Syntax
The syntax of this command is:
PMC.EXE -UpVolume [-line #]
The -line # option, where # is a number 1 through 8, specifies the PTT channel to which this command applies. If you omit this option, the command will apply to channel 1.
Examples
Table 2-24 shows examples of the UpVolume command.
Related Commands
•
•
•
