The umcli Tool

Accessing the umcli Tool

Using the umcli Tool Interactively

Using the umcli Tool in Singleton Mode

Command Descriptions

The umcli Tool

The umcli tool is an administrative and diagnostic tool. It provides commands for starting/stopping agents and the uOne system, changing log levels, and reloading various tables. The tool also has real-time monitors that can help operations personnel troubleshoot problems.

Accessing the umcli Tool

You can run the umcli tool in two ways:

Invoke the umcli tool and use the tool interactively to execute various commands.
Run umcli in singleton mode.

Using the umcli Tool Interactively

Step 1 Log in as spmaster.

Step 2 At the command line, type:

umcli

Step 3 At the umcli prompt, enter a umcli command. (See "Command Descriptions" in this appendix.)

For example, type: get system status.

See "Command Descriptions"in this appendix for information about umcli commands. See Table F-1 for descriptions of umcli global commands.

Table F-1: umcli Global Commands

Command Description

help <command>

Displays help for the specified Gets help on the umcli command.

exit

Exits the umcli tool

Command	Description
help <command>	Displays help for the specified Gets help on the umcli command.
exit	Exits the umcli tool

Using the umcli Tool in Singleton Mode

Step 1 Log in as spmaster.

Step 2 At the command line, type:

umcli -s <command>

For example, type: umcli -s get system status

(See "Command Descriptions" in this appendix.)

Note The watch command operates non-interactively when used in singelton mode.

Command Descriptions

The umcli tool provides commands to help you

Manage the ACB and agents (start, stop, quiesce, and reload tables).
Monitor the uOne system and subsystems in real time and via logs (watch, set, get).

The watch Command

Description: Monitors a uOne subsystem in real time

Syntax: watch <component> [<Screen>]

Table F-2: watch Command Options

Component Screen(s) Description

acb

globals

Displays ACB global counters in real time.

entries

Displays information about scheduled agents and sessions in use.

states

Displays information about states and state changes of scheduled agents.

comm

Displays information about the ACB, ICM, OCM, and LACS.

threads

Displays ACB OCM thread information.

cma

groups

Displays CMA group information.

scr

Displays CMA system call router information.

sessions

Displays CMA session information.

h323

entries

Displays H.323 resource layer information for each resource ID.

radvision

Displays H.323 RADVision layer information for each call ID.

states

Displays H.323 protocol and state information for each CCR channel.

sms

NA

Displays general information, notification state, and queued notification stats for SMS_Notify.

notify

NA

Displays information about MWI_Notify and MWI_OnOff.

faxprint

NA

Displays information about FaxPrint processes.

Component	Screen(s)	Description
acb	globals	Displays ACB global counters in real time.
	entries	Displays information about scheduled agents and sessions in use.
	states	Displays information about states and state changes of scheduled agents.
	comm	Displays information about the ACB, ICM, OCM, and LACS.
	threads	Displays ACB OCM thread information.
cma	groups	Displays CMA group information.
	scr	Displays CMA system call router information.
	sessions	Displays CMA session information.
h323	entries	Displays H.323 resource layer information for each resource ID.
	radvision	Displays H.323 RADVision layer information for each call ID.
	states	Displays H.323 protocol and state information for each CCR channel.
sms	NA	Displays general information, notification state, and queued notification stats for SMS_Notify.
notify	NA	Displays information about MWI_Notify and MWI_OnOff.
faxprint	NA	Displays information about FaxPrint processes.

Table F-3: watch Screen Global Commands

Watch Screen Commands Description

j

Moves the screen down one record.

k

Moves the screen up one record.

Ctrl-D

Moves the screen down one page.

Ctrl-U

Moves the screen up one page.

Q/q

Exits a watch screen and returns to the main umcli screen.

Table F-4: watch Command: acb comm Field Descriptions

Section Field Description

Outbound CM

Threads: Max

The maximum number of threads allowed

Threads:Idle

The current number of threads which are idle

Threads:In Use

The current number of threads which being used

Messages: In

The current number of messages processed.

Messages: Error

The current number of errors

Inbound CM

Messages: Net

The number of messages from the network

Messages: SSIO

The number of messages from SSIO (LACS)

Errors: Net

The number of errors from the network

Errors: NetSSIO

The number of errors from the network going to SSIO (LACS)

Errors:SSIO

The number of pings to an agent

Watch Screen Commands	Description
j	Moves the screen down one record.
k	Moves the screen up one record.
Ctrl-D	Moves the screen down one page.
Ctrl-U	Moves the screen up one page.
Q/q	Exits a watch screen and returns to the main umcli screen.

Section	Field	Description
Outbound CM	Threads: Max	The maximum number of threads allowed
	Threads:Idle	The current number of threads which are idle
	Threads:In Use	The current number of threads which being used
	Messages: In	The current number of messages processed.
	Messages: Error	The current number of errors
Inbound CM	Messages: Net	The number of messages from the network
	Messages: SSIO	The number of messages from SSIO (LACS)
	Errors: Net	The number of errors from the network
	Errors: NetSSIO	The number of errors from the network going to SSIO (LACS)
	Errors:SSIO	The number of pings to an agent

Table F-5: watch Command: acb globals Field Descriptions

Section Field Description

Instance info

Scheduled

The current number of scheduled agents.

Active

The current number of active agents.

Highwater (curr/max)

The current maximum number of concurrently active agents. / The configured absolute maximum number of concurrently active agents

HighWaterTime

The Date/time of the last change to Highwater.

Current Apps

UM

The current number of scheduled (and possibly active) uOne agents. (Should be 0 or greater).

CMA

The current number of CMA agents. (Should be 0 or 1).

LogRemover

The current number of LogRemover agents (Should be 0 or 1).

MWI_OnOff

The current number of MWI_OnOff agents (Should be 0 or 1).

MWI_Notify

The current number of MWI_Notify agents (Should be 0 or 1).

FaxPrint

The current number of FaxPrint agents (Should be 0 or greater).

SMS_Notify

The current number of SMS_Notify agents (Should be 0 or greater).

Other

The number of scheduled agents not listed above (Should be 0 or greater).

Agent Stats

Command

Any of four commands given to ACB (reload sched static, reload sched all, reload route acb, or set loglevel acb).

Execution Count

The number of times the given command has been executed.

Last Execution Time

The date and time of the last time the given command has been executed.

Agent

Any of the scheduled agents.

StartReq

The number of times the ACB has attempted to start an agent.

StartSuccess

The number of the ACB has successfully started an agent.

ExitsReq

The number of the ACB has attempted to kill an agent.

ExitSuccess

The number of the ACB has successfully killed an agent.

Errors

Misc

The number of MiscStart errors returned.

NotFound

The number of Program not found errors returned.

DSFail

The number of Domain Services failed errors returned.

MaxExceeded

The number of times a StartRequest message was rejected because it would have exceeded the MaxInstances (Max Highwater) configurable (as defined in $PARMLIB/parms/APP/Attrib.Global).

QuiesceRejects

The number of requests rejected due to the system being in a quiesced state.

Section	Field	Description
Instance info	Scheduled	The current number of scheduled agents.
	Active	The current number of active agents.
	Highwater (curr/max)	The current maximum number of concurrently active agents. / The configured absolute maximum number of concurrently active agents
	HighWaterTime	The Date/time of the last change to Highwater.
Current Apps	UM	The current number of scheduled (and possibly active) uOne agents. (Should be 0 or greater).
	CMA	The current number of CMA agents. (Should be 0 or 1).
	LogRemover	The current number of LogRemover agents (Should be 0 or 1).
	MWI_OnOff	The current number of MWI_OnOff agents (Should be 0 or 1).
	MWI_Notify	The current number of MWI_Notify agents (Should be 0 or 1).
	FaxPrint	The current number of FaxPrint agents (Should be 0 or greater).
	SMS_Notify	The current number of SMS_Notify agents (Should be 0 or greater).
	Other	The number of scheduled agents not listed above (Should be 0 or greater).
Agent Stats	Command	Any of four commands given to ACB (reload sched static, reload sched all, reload route acb, or set loglevel acb).
	Execution Count	The number of times the given command has been executed.
	Last Execution Time	The date and time of the last time the given command has been executed.
	Agent	Any of the scheduled agents.
	StartReq	The number of times the ACB has attempted to start an agent.
	StartSuccess	The number of the ACB has successfully started an agent.
	ExitsReq	The number of the ACB has attempted to kill an agent.
	ExitSuccess	The number of the ACB has successfully killed an agent.
Errors	Misc	The number of MiscStart errors returned.
	NotFound	The number of Program not found errors returned.
	DSFail	The number of Domain Services failed errors returned.
	MaxExceeded	The number of times a StartRequest message was rejected because it would have exceeded the MaxInstances (Max Highwater) configurable (as defined in $PARMLIB/parms/APP/Attrib.Global).
	QuiesceRejects	The number of requests rejected due to the system being in a quiesced state.

Table F-6: watch Command: acb entries Field Descriptions

Section Field Description

Scheduled Applications

Entry

The current Agent Control Table (ACT) table entry number.

PID

The Process ID (PID) of the currently scheduled (and possibly running) agent.

TYPE

The schedule type of the agent (External, Dynamic, Static, Static No Wait, Unknown).

STATE

The current state of the agent (Init, Idle, Transition, Shut, Run, Wait, NoStart, Unknown).

UPTIME

The current amount of time the agent has been scheduled since the last time it was loaded.

PRG/TOKEN

The process name / launching token of the agent.

ST/MX

The current number of start attempts. / The maximum number of start attempts before start requests (including auto restarts) are ignored (reload sched static and reload sched all resets the internal start attempts variable). A maximum of zero means unlimited.

Sessions In Use

OBJ

The object type of the resource bound to this agent. (1 - ACB, 2 - CMA)

SubSys

The subsystem ID of the resource bound to this agent. The subsystem ID is ten the PID of an agent.

TimeInUse

The current amount of time this resource has been bound to this agent.

Section	Field	Description
Scheduled Applications	Entry	The current Agent Control Table (ACT) table entry number.
	PID	The Process ID (PID) of the currently scheduled (and possibly running) agent.
	TYPE	The schedule type of the agent (External, Dynamic, Static, Static No Wait, Unknown).
	STATE	The current state of the agent (Init, Idle, Transition, Shut, Run, Wait, NoStart, Unknown).
	UPTIME	The current amount of time the agent has been scheduled since the last time it was loaded.
	PRG/TOKEN	The process name / launching token of the agent.
	ST/MX	The current number of start attempts. / The maximum number of start attempts before start requests (including auto restarts) are ignored (reload sched static and reload sched all resets the internal start attempts variable). A maximum of zero means unlimited.
Sessions In Use	OBJ	The object type of the resource bound to this agent. (1 - ACB, 2 - CMA)
	SubSys	The subsystem ID of the resource bound to this agent. The subsystem ID is ten the PID of an agent.
	TimeInUse	The current amount of time this resource has been bound to this agent.

Table F-7: watch Command: acb states Field Descriptions

Section Field Description

Entry

The current Agent Control Table (ACT) table entry number.

Name

The agent name.

Type

The schedule type of the agent.

State

The current state of the agent.

Bound

The current number of resources bound to the agent

Section	Field	Description
	Entry	The current Agent Control Table (ACT) table entry number.
	Name	The agent name.
	Type	The schedule type of the agent.
	State	The current state of the agent.
	Bound	The current number of resources bound to the agent

Table F-8: watch Command: acb threads Field Descriptions

Section Field Description

Thr

The thread number for the current thread instance.

Host

The name of the host the thread is connected to.

Obj

The name of the object the thread is connected to, APP (ACB) or TNT(CMA).

St

The current state of the thread agent [(A)ctive or (I)nactive].

Id

The EventOrCmdId of the current message. These codes are not published.

ComHandle

The session handle to the object for the current thread instance.

Tran#

The transaction number for the message.

Time

The time the message came in.

Section	Field	Description
	Thr	The thread number for the current thread instance.
	Host	The name of the host the thread is connected to.
	Obj	The name of the object the thread is connected to, APP (ACB) or TNT(CMA).
	St	The current state of the thread agent [(A)ctive or (I)nactive].
	Id	The EventOrCmdId of the current message. These codes are not published.
	ComHandle	The session handle to the object for the current thread instance.
	Tran#	The transaction number for the message.
	Time	The time the message came in.

Table F-9: watch Command: cma sessions Field Descriptions

Section Field Description

Current Sessions

The current number of active sessions.

Peak Sessions

The maximum number of concurrently active sessions.

Total Sessions

The total number of sessions started/active while CMA has been running.

(Session List)

Active Sessions

A list of the names of currently active sessions.

Section	Field	Description
	Current Sessions	The current number of active sessions.
	Peak Sessions	The maximum number of concurrently active sessions.
	Total Sessions	The total number of sessions started/active while CMA has been running.
(Session List)	Active Sessions	A list of the names of currently active sessions.

Table F-10: watch Command: cma groups Field Descriptions

Section Field Description

Current Groups

The current number of active groups.

Peak Groups

The maximum number of concurrently active groups.

Total Groups

The total number of groups formed/active while CMA has been running.

(Group List)

Group Id

The Group Id of the current group.

Parent Session

The session which owns this group.

Resources

The list of resources in the current group for the given session. Each resource is listed as a triple consisting of resource name, resource module name, and resource ID.

Section	Field	Description
	Current Groups	The current number of active groups.
	Peak Groups	The maximum number of concurrently active groups.
	Total Groups	The total number of groups formed/active while CMA has been running.
(Group List)	Group Id	The Group Id of the current group.
	Parent Session	The session which owns this group.
	Resources	The list of resources in the current group for the given session. Each resource is listed as a triple consisting of resource name, resource module name, and resource ID.

Table F-11: watch Command: cma scr Field Descriptions

Section Field Description

Current

Calls

The number of calls in process.

Inbound Calls

The number of inbound calls in process.

Outbound Calls

The number of outbound calls in process.

Total

Calls

The total number of calls completed and in process.

Inbound Calls

The total number of inbound calls completed and in process.

Outbound Calls

The total number of outbound calls completed and in process.

Answered Calls

The total number of answered calls.

Answered Inbound Calls

The total number of inbound answered calls.

Answered Outbound Calls

The total number of outbound answered calls.

Abandoned Calls

The total number of abandoned calls.¹

Abandoned Inbound Calls

The total number of inbound abandoned calls.

Abandoned Outbound Calls

The total number of outbound abandoned calls.

Rejected Calls

The total number of rejected calls.

Rejected Inbound Calls

The total number of inbound rejected calls

Rejected Outbound Calls

The total number of outbound rejected calls

Drops

The total number of drops for answered calls.²

Far End Drops

The total number of far-end drops for answered calls.³

Near End Drops

The total number of near-end drops for answered calls.⁴

Peaks

Calls

The highest number of concurrently active calls.

Inbound Calls

The highest number of concurrently active inbound calls.

Outbound Calls

The highest number of concurrently active outbound calls.

¹An abandoned call occurs when the call is terminated before the connection is made, for example, when a caller hangs up prior to uOne answering the call.
²A drop occurs when the call is terminated after a connection is made.
³A far-end drop occurs when the inbound caller to uOne hangs up with uOne active.
⁴A near-end drop is caused by uOne itself when the caller selects *9 or when uOne encounters a fatal error.

Section	Field	Description
Current	Calls	The number of calls in process.
	Inbound Calls	The number of inbound calls in process.
	Outbound Calls	The number of outbound calls in process.
Total	Calls	The total number of calls completed and in process.
	Inbound Calls	The total number of inbound calls completed and in process.
	Outbound Calls	The total number of outbound calls completed and in process.
	Answered Calls	The total number of answered calls.
	Answered Inbound Calls	The total number of inbound answered calls.
	Answered Outbound Calls	The total number of outbound answered calls.
	Abandoned Calls	The total number of abandoned calls.¹
	Abandoned Inbound Calls	The total number of inbound abandoned calls.
	Abandoned Outbound Calls	The total number of outbound abandoned calls.
	Rejected Calls	The total number of rejected calls.
	Rejected Inbound Calls	The total number of inbound rejected calls
	Rejected Outbound Calls	The total number of outbound rejected calls
	Drops	The total number of drops for answered calls.²
	Far End Drops	The total number of far-end drops for answered calls.³
	Near End Drops	The total number of near-end drops for answered calls.⁴
Peaks	Calls	The highest number of concurrently active calls.
	Inbound Calls	The highest number of concurrently active inbound calls.
	Outbound Calls	The highest number of concurrently active outbound calls.

Table F-12: watch Command: h323 entries Field Descriptions¹

Section Field Description

(Resource Entry)

Rec#

The current resource record number.

General

Handle

The handle for the H323 resource.

Allocated

Whether the resource type record is allocated.

Group

A pointer to the group in which the resource resides. NULL (0x00000000) indicates the resource is not part of a group.

ID

The H323 resource ID for the resource.

ANI

The originating caller id.

DNIS

The destination callee id.

RDNIS

The redirected destination callee id.

ConfID

The conference ID of the call.

Call State

State

CCR State (Idle, Active, Hold, Unknown).

Connection

CCR Connection State (Null, Alerting, Fail, Hold, Connected, Queued, Initiated, Unknown).

Outbound

ANI

The originating caller id for the outbound call.

Charge Number

The charge number for the outbound call.

Router IP

The IP address of the gateway handling the outbound call.

Call Type

The Outbound Call Type (GKRouted, DirectRouted, Unknown).

¹Note that the number of entries shown is three times the Max Ports parameter configured in H.323.ini.

Section	Field	Description
(Resource Entry)	Rec#	The current resource record number.
General	Handle	The handle for the H323 resource.
	Allocated	Whether the resource type record is allocated.
	Group	A pointer to the group in which the resource resides. NULL (0x00000000) indicates the resource is not part of a group.
	ID	The H323 resource ID for the resource.
	ANI	The originating caller id.
	DNIS	The destination callee id.
	RDNIS	The redirected destination callee id.
	ConfID	The conference ID of the call.
Call State	State	CCR State (Idle, Active, Hold, Unknown).
	Connection	CCR Connection State (Null, Alerting, Fail, Hold, Connected, Queued, Initiated, Unknown).
Outbound	ANI	The originating caller id for the outbound call.
	Charge Number	The charge number for the outbound call.
	Router IP	The IP address of the gateway handling the outbound call.
	Call Type	The Outbound Call Type (GKRouted, DirectRouted, Unknown).

Table F-13: watch Command: h323 radvision Field Descriptions¹

Section Field Description

(Resource Entry)

Rec#

The current call record number.

General

Handle

The current handle for the RADVision call.

ID

The current RADVision call ID.

State

The current H225 call signaling State (DialTone, Proceeding, RingBack, Connected, Disconnected, Idle, Offering, Transferring, Unknown).

StateMode

The current H225 call signaling State Mode (DisconnectedBusy, Disconnected Normal, DisconnectedReject, DisconnectedUnreachable, DisconnectedUnknown, DisconnectedLocal, ConnectedControl, ConnectedCallSetup, ConnectedCall, OfferingCreate, OfferingInvite, OfferingJoin, OfferingCapNeg, OfferingCallIndSuppServ, Unknown)

Direction (CallType)

The current call direction (Idle, Inbound, Outbound, Unknown).

CallReason

The current reason for the call (D-Direct, A-SendAllCalls, B-Busy, N-No Answer, *-Unknown).

ANI

The current originating caller id.

DNIS

The current destination callee id.

RDNIS

The current redirected destination callee id.

ChannelIn

ID

The current H245 Input Channel ID.

State

The current H245 Input Channel State (DialTone, RingBack, Connected, Disconnected, Idle, Offering, Unknown).

StateMode

The current H245 Input Channel State Mode (On, Off, DiscLocal, DiscRemote, Duplex, DiscReasonUnknown, DiscReasonReopen, DiscReasonResFail, Unknown)

ChannelOut

ID

The current H245 Output Channel ID.

State

The current H245 Output Channel State (DialTone, RingBack, Connected, Disconnected, Idle, Offering, Unknown).

StateMode

The current H245 Output Channel State Mode (On, Off, DiscLocal, DiscRemote, Duplex, DiscReasonUnknown, DiscReasonReopen, DiscReasonResFail, Unknown).

RTP Session

ID

The current RTP Session ID.

Dropped Packets

The current RTP Session's number of dropped inbound UDP packets.

Channels

The current RTP Session's number of channels (2 indicates a full duplex session).

Aud Play

Data

The pointer to the current Audio Play Data Buffer.

Size

The size of the current Audio Play Data Buffer.

Pos

The current position of where we are playing in the current Audio Play Data Buffer.

State

The current state of the usage of the current Audio Play Data Buffer (Idle, Active, Beep, Unknown).

Aud Rec

Data

The pointer to the current Audio Record Data Buffer.

Size

The size of the current Audio Record Data Buffer.

Pos

The current position of where we are playing in the current Audio Record Data Buffer.

State

The current state of the usage of the current Audio Record Data Buffer (Idle, Active, Beep, Unknown).

Outbound

Routing Type

The current Outbound Call Routing type (GKRouted, DirectRouted, Unknown).

CallState

The current Outbound Call State type (Idle, Dialing, Connected, NoAnwser, Busy, Stopping, Unknown).

Dial String

The current Outbound Call Dial String.

Outbound ANI

The current Outbound originating caller id.

Router ID

The current IP address of the gateway handling this outbound call.

¹Note that the number of entries shown is three times the Max Ports parameter configured in H.323.ini.

Section	Field	Description
(Resource Entry)	Rec#	The current call record number.
General	Handle	The current handle for the RADVision call.
	ID	The current RADVision call ID.
	State	The current H225 call signaling State (DialTone, Proceeding, RingBack, Connected, Disconnected, Idle, Offering, Transferring, Unknown).
	StateMode	The current H225 call signaling State Mode (DisconnectedBusy, Disconnected Normal, DisconnectedReject, DisconnectedUnreachable, DisconnectedUnknown, DisconnectedLocal, ConnectedControl, ConnectedCallSetup, ConnectedCall, OfferingCreate, OfferingInvite, OfferingJoin, OfferingCapNeg, OfferingCallIndSuppServ, Unknown)
	Direction (CallType)	The current call direction (Idle, Inbound, Outbound, Unknown).
	CallReason	The current reason for the call (D-Direct, A-SendAllCalls, B-Busy, N-No Answer, *-Unknown).
	ANI	The current originating caller id.
	DNIS	The current destination callee id.
	RDNIS	The current redirected destination callee id.
ChannelIn	ID	The current H245 Input Channel ID.
	State	The current H245 Input Channel State (DialTone, RingBack, Connected, Disconnected, Idle, Offering, Unknown).
	StateMode	The current H245 Input Channel State Mode (On, Off, DiscLocal, DiscRemote, Duplex, DiscReasonUnknown, DiscReasonReopen, DiscReasonResFail, Unknown)
ChannelOut	ID	The current H245 Output Channel ID.
	State	The current H245 Output Channel State (DialTone, RingBack, Connected, Disconnected, Idle, Offering, Unknown).
	StateMode	The current H245 Output Channel State Mode (On, Off, DiscLocal, DiscRemote, Duplex, DiscReasonUnknown, DiscReasonReopen, DiscReasonResFail, Unknown).
RTP Session	ID	The current RTP Session ID.
	Dropped Packets	The current RTP Session's number of dropped inbound UDP packets.
	Channels	The current RTP Session's number of channels (2 indicates a full duplex session).
Aud Play	Data	The pointer to the current Audio Play Data Buffer.
	Size	The size of the current Audio Play Data Buffer.
	Pos	The current position of where we are playing in the current Audio Play Data Buffer.
	State	The current state of the usage of the current Audio Play Data Buffer (Idle, Active, Beep, Unknown).
Aud Rec	Data	The pointer to the current Audio Record Data Buffer.
	Size	The size of the current Audio Record Data Buffer.
	Pos	The current position of where we are playing in the current Audio Record Data Buffer.
	State	The current state of the usage of the current Audio Record Data Buffer (Idle, Active, Beep, Unknown).
Outbound	Routing Type	The current Outbound Call Routing type (GKRouted, DirectRouted, Unknown).
	CallState	The current Outbound Call State type (Idle, Dialing, Connected, NoAnwser, Busy, Stopping, Unknown).
	Dial String	The current Outbound Call Dial String.
	Outbound ANI	The current Outbound originating caller id.
	Router ID	The current IP address of the gateway handling this outbound call.

Table F-14: watch Command: h323 states Field Descriptions¹

Section Field Description

Chan

The current H323/RADVision CCR entry.

225

The current H225 State (D-DialTone, P-Proceeding, R-RingBack, C-Connected, S-Disconnected, I-Idle, O-Offering, T-Transferring,?-Unknown).

245I

The current H245 Input Channel State (D-DialTone, R-RingBack, C-Connected, S-Disconnected, I-Idle, O-Offering,?-Unknown).

245O

The current H245 Output Channel State (D-DialTone, R-RingBack, C-Connected, S-Disconnected, I-Idle, O-Offering,?-Unknown).

CCR

The current CCR State (I-Idle, A-Active, H-Hold,?-Unknown).

AudPl

The current state of the usage of the current Audio Play Data Buffer (Idle, Active, Beep, Unknown).

AudRc

The current state of the usage of the current Audio Record Data Buffer (Idle, Active, Beep, Unknown).

Dir

The direction of the call (I - idle, N - Inbound, O - Outbound, ? - unknown)

OCS

The outbound call state (I - Idle, D - Dialing, C - Connected, N - No Answer, B - Busy S - Stopping, ? - Unknown).

Chan#

The current H323/RADVision CCR entry.

ANI

The originating caller id.

DNIS

The current destination callee id.

RDNIS

The redirected destination callee id.

CT

The current reason for the call (D-Direct, A-SendAllCalls, B-Busy, N-No Answer, *-Unknown).

¹Note that the number of entries shown is three times the Max Ports parameter configured in H.323.ini.

Section	Field	Description
	Chan	The current H323/RADVision CCR entry.
	225	The current H225 State (D-DialTone, P-Proceeding, R-RingBack, C-Connected, S-Disconnected, I-Idle, O-Offering, T-Transferring,?-Unknown).
	245I	The current H245 Input Channel State (D-DialTone, R-RingBack, C-Connected, S-Disconnected, I-Idle, O-Offering,?-Unknown).
	245O	The current H245 Output Channel State (D-DialTone, R-RingBack, C-Connected, S-Disconnected, I-Idle, O-Offering,?-Unknown).
	CCR	The current CCR State (I-Idle, A-Active, H-Hold,?-Unknown).
	AudPl	The current state of the usage of the current Audio Play Data Buffer (Idle, Active, Beep, Unknown).
	AudRc	The current state of the usage of the current Audio Record Data Buffer (Idle, Active, Beep, Unknown).
	Dir	The direction of the call (I - idle, N - Inbound, O - Outbound, ? - unknown)
	OCS	The outbound call state (I - Idle, D - Dialing, C - Connected, N - No Answer, B - Busy S - Stopping, ? - Unknown).
	Chan#	The current H323/RADVision CCR entry.
	ANI	The originating caller id.
	DNIS	The current destination callee id.
	RDNIS	The redirected destination callee id.
	CT	The current reason for the call (D-Direct, A-SendAllCalls, B-Busy, N-No Answer, *-Unknown).

Table F-15: watch Command: sms Field Descriptions

Section Field Description

General

Overall State

The overall state of the current SMS_Notify process (Starting Up, Sleeping, Notifying, Shutting Down).

LDAP State

The current state of the LDAP server configured for this SMS_Notify process (Unknown, Down, Up).

IMAP State

The current state of the IMAP server configured for this SMS_Notify process (Unknown, Down, Up).

Notification

Total Sent

The total number of notification attempts made by this SMS_Notify process.

Total Failures

The total number of notification failures encountered by this SMS_Notify process.

Sent Last 5 min

The number of notification attempts made by this SMS_Notify process in the last 5 minutes.

Sent Last 15 min

The number of notification attempts made by this SMS_Notify process in the last 15 minutes.

Queued Notifies

Total Queued

The total number of notification attempts which were queued for this SMS_Notify process.

Queued Last 5 min

The number of notification attempts which were queued for this SMS_Notify process in the last 5 minutes.

Queued Last 15 min

The number of notification attempts which were queued for this SMS_Notify process in the last 15 minutes.

Peak Queued

The maximum number of notification attempt which were concurrently queued for this SMS_Notify process and the date/time when the last peak occurred.

Section	Field	Description
General	Overall State	The overall state of the current SMS_Notify process (Starting Up, Sleeping, Notifying, Shutting Down).
	LDAP State	The current state of the LDAP server configured for this SMS_Notify process (Unknown, Down, Up).
	IMAP State	The current state of the IMAP server configured for this SMS_Notify process (Unknown, Down, Up).
Notification	Total Sent	The total number of notification attempts made by this SMS_Notify process.
	Total Failures	The total number of notification failures encountered by this SMS_Notify process.
	Sent Last 5 min	The number of notification attempts made by this SMS_Notify process in the last 5 minutes.
	Sent Last 15 min	The number of notification attempts made by this SMS_Notify process in the last 15 minutes.
Queued Notifies	Total Queued	The total number of notification attempts which were queued for this SMS_Notify process.
	Queued Last 5 min	The number of notification attempts which were queued for this SMS_Notify process in the last 5 minutes.
	Queued Last 15 min	The number of notification attempts which were queued for this SMS_Notify process in the last 15 minutes.
	Peak Queued	The maximum number of notification attempt which were concurrently queued for this SMS_Notify process and the date/time when the last peak occurred.

Table F-16: watch Command: notify Field Descriptions

Section Field Description

Notification Requests

General: Overall State

The current state of the MWI_Notify agent.

General: Connection State

The current connection state of the MWI_Notify agent.

General: Port

The current TCP port which MWI_Notify is using.

General: Time Connected

The current amount of time that MWI_Notify has been connected.

General: Incoming Messages

The total number of incoming messages (MWI_Notify).

Failures: Total Failures

The total number of failed notification messages (MWI_Notify).

Failures: Message Too Large

The total number of failures due to the notification message being too large.

Failures: Bad Message

The total number of failures due to the notification message being bad.

Failures: Records Ignored

The total number of records ignored.

Failures:Send Record

The total number of failures to send records.

Notification Sends

General: Current State

The current state of the MWI_OnOff agent.

Requests: Total

The total number of notification requests from MWI_Notify.

Requests: Set Message Waiting Indicator Light

The total number of SMDI requests. These could be to set a light or to set stutter dial tone.

Requests: Notify Via Pager

The total number of SNPP and SMTP paging requests.

Failures: Total

The sum of No Subscriber Matches + Too Many Subscriber Matches + Invalid Notify Number + Set Message Waiting Indicator Light + Notify Via Pager failures.

Failures: No Subscriber Matches

The total number of failures due to no LDAP entry matches on the requested e-mail address.

Failures: Too Many Subscriber Matches

The total number of failures due to too many LDAP entry matches on the requested e-mail address.

Failures: Invalid Notify Number

The total number of failures due to an invalid notify number.

Failures: Set Message Waiting Indicator Light:

The total number of failures due to an SMDI request failure.

Failures: Notify Via Pager:

The total number of failures due to an SNPP or SMTP paging request failure.

Section	Field	Description
Notification Requests	General: Overall State	The current state of the MWI_Notify agent.
	General: Connection State	The current connection state of the MWI_Notify agent.
	General: Port	The current TCP port which MWI_Notify is using.
	General: Time Connected	The current amount of time that MWI_Notify has been connected.
	General: Incoming Messages	The total number of incoming messages (MWI_Notify).
	Failures: Total Failures	The total number of failed notification messages (MWI_Notify).
	Failures: Message Too Large	The total number of failures due to the notification message being too large.
	Failures: Bad Message	The total number of failures due to the notification message being bad.
	Failures: Records Ignored	The total number of records ignored.
	Failures:Send Record	The total number of failures to send records.
Notification Sends	General: Current State	The current state of the MWI_OnOff agent.
	Requests: Total	The total number of notification requests from MWI_Notify.
	Requests: Set Message Waiting Indicator Light	The total number of SMDI requests. These could be to set a light or to set stutter dial tone.
	Requests: Notify Via Pager	The total number of SNPP and SMTP paging requests.
	Failures: Total	The sum of No Subscriber Matches + Too Many Subscriber Matches + Invalid Notify Number + Set Message Waiting Indicator Light + Notify Via Pager failures.
	Failures: No Subscriber Matches	The total number of failures due to no LDAP entry matches on the requested e-mail address.
	Failures: Too Many Subscriber Matches	The total number of failures due to too many LDAP entry matches on the requested e-mail address.
	Failures: Invalid Notify Number	The total number of failures due to an invalid notify number.
	Failures: Set Message Waiting Indicator Light:	The total number of failures due to an SMDI request failure.
	Failures: Notify Via Pager:	The total number of failures due to an SNPP or SMTP paging request failure.

Table F-17: watch Command: faxprint Field Descriptions

Section Field Description

(FaxPrint PID)

FaxPrint PID

The Process ID (PID) of the current FaxPrint agent being watched.

Stats

State

The current state of the current FaxPrint agent.

Fax Host

The IMAP host for the current FaxPrint agent.

Fax User

The admin user for the current FaxPrint agent.

Successes

The current total successful send count for the current FaxPrint agent.

Returns

The current send return failure notice to user count for the current FaxPrint agent.

Inbox Queue

Length

The current inbox queue length of outbound messages for the current FaxPrint agent.

Peak

The maximum inbox queue length of outbound messages for the current FaxPrint agent.

PeakTime

The date/time when the last inbox peak occurred for the current FaxPrint agent.

Retry Queue

Length

The current outbound retry queue length for the current FaxPrint agent.

Peak

The maximum outbound retry queue length for the current FaxPrint agent.

PeakTime

The date/time when the last retry peak occurred for the current FaxPrint agent.

Failures

Login

The current number of fax admin user login failures for the current FaxPrint agent.

MaxRetry

The current number of failures due to reaching the maximum number of fax send retries for the current FaxPrint agent.

Retry

The current number of moving fax to retry folder failures for the current FaxPrint agent.

FaxReturn

The current number of return undelivered fax notice failures for the current FaxPrint agent.

DestErr

The current number of destination error in receiving fax failures for the current FaxPrint agent.

BusyLine

The current number of line is busy failures for the current FaxPrint agent.

TimeOut

The current number of modem timeout failures for the current FaxPrint agent.

NoRoute

The current number of no route failures for the current FaxPrint agent.

Section	Field	Description
(FaxPrint PID)	FaxPrint PID	The Process ID (PID) of the current FaxPrint agent being watched.
Stats	State	The current state of the current FaxPrint agent.
	Fax Host	The IMAP host for the current FaxPrint agent.
	Fax User	The admin user for the current FaxPrint agent.
	Successes	The current total successful send count for the current FaxPrint agent.
	Returns	The current send return failure notice to user count for the current FaxPrint agent.
Inbox Queue	Length	The current inbox queue length of outbound messages for the current FaxPrint agent.
	Peak	The maximum inbox queue length of outbound messages for the current FaxPrint agent.
	PeakTime	The date/time when the last inbox peak occurred for the current FaxPrint agent.
Retry Queue	Length	The current outbound retry queue length for the current FaxPrint agent.
	Peak	The maximum outbound retry queue length for the current FaxPrint agent.
	PeakTime	The date/time when the last retry peak occurred for the current FaxPrint agent.
Failures	Login	The current number of fax admin user login failures for the current FaxPrint agent.
	MaxRetry	The current number of failures due to reaching the maximum number of fax send retries for the current FaxPrint agent.
	Retry	The current number of moving fax to retry folder failures for the current FaxPrint agent.
	FaxReturn	The current number of return undelivered fax notice failures for the current FaxPrint agent.
	DestErr	The current number of destination error in receiving fax failures for the current FaxPrint agent.
	BusyLine	The current number of line is busy failures for the current FaxPrint agent.
	TimeOut	The current number of modem timeout failures for the current FaxPrint agent.
	NoRoute	The current number of no route failures for the current FaxPrint agent.

The get Command

Description: Requests a supported value.

Syntax: get <variable>

Table F-18: get Command Options

Variable Description

watchtime

Displays the refresh time in milliseconds for the watch screens.

system status

Displays the current system status: up, down, or quiesce.

loglevels

Displays the current run-time logging levels for the ACB, CMA, and all loaded Static/Static_Nowait agents.

Variable	Description
watchtime	Displays the refresh time in milliseconds for the watch screens.
system status	Displays the current system status: up, down, or quiesce.
loglevels	Displays the current run-time logging levels for the ACB, CMA, and all loaded Static/Static_Nowait agents.

The set Command

Description: Sets a supported value.

Syntax: set <variable> <value>

Table F-19: set Command Options

Variable Value Description

watchtime

A number greater than 500.

Sets the refresh time for the watch screens in milliseconds. Any value less than 500 will be set to 500.

loglevel acb

error

warning

info

debug

off=Turns off logging for the specified severity level for the ACB.

local=Turns on logging for the specified severity level for the ACB on the local machine.

Sets the ACB error, warning, informational, and debug level logging.

loglevel cma

error

warning

info

debug

off=Turns off logging for the specified severity level for the CMA.

local=Turns on logging for the specified severity level for the CMA on the local machine.

Sets the CMA error, warning, informational, and debug level logging.

loglevel <PID>

error

warning

info

debug

off=Turns off logging for the specified severity level for the scheduled agent indicated by the PID.

local=Turns on logging for the specified severity level for the scheduled agent indicated by the PID.

Sets the error, warning, informational, and debug level logging for the scheduled agent indicated by the PID.

Variable		Value	Description
watchtime		A number greater than 500.	Sets the refresh time for the watch screens in milliseconds. Any value less than 500 will be set to 500.
loglevel acb	error warning info debug	off=Turns off logging for the specified severity level for the ACB. local=Turns on logging for the specified severity level for the ACB on the local machine.	Sets the ACB error, warning, informational, and debug level logging.
loglevel cma	error warning info debug	off=Turns off logging for the specified severity level for the CMA. local=Turns on logging for the specified severity level for the CMA on the local machine.	Sets the CMA error, warning, informational, and debug level logging.
loglevel <PID>	error warning info debug	off=Turns off logging for the specified severity level for the scheduled agent indicated by the PID. local=Turns on logging for the specified severity level for the scheduled agent indicated by the PID.	Sets the error, warning, informational, and debug level logging for the scheduled agent indicated by the PID.

The start Command

Description: Starts a uOne component.

Syntax: start <component>

Table F-20: start Command Options

Component Description

acb

Starts the Agent Communications Broker (SPOBJ).

This action starts the SPOBJ process and reloads the Schedule table, which triggers the starting of static application agents. It also starts the TRAPMAN and LOGSUB processes if they are not already running.

cma

Starts the Call/Media Control agent (TNTOBJECT). This action starts the TNTOBJECT process.

system

Starts the ACB, LOGSUB, TRAPMAN, and CMA.

Component	Description
acb	Starts the Agent Communications Broker (SPOBJ). This action starts the SPOBJ process and reloads the Schedule table, which triggers the starting of static application agents. It also starts the TRAPMAN and LOGSUB processes if they are not already running.
cma	Starts the Call/Media Control agent (TNTOBJECT). This action starts the TNTOBJECT process.
system	Starts the ACB, LOGSUB, TRAPMAN, and CMA.

The stop Command

Description: Stops a uOne component.

Syntax: stop <component>

Table F-21: stop Command Options

Component Description

acb

Stops all application agents, CMA, and ACB.

cma

Stops the Call/Media Control agent (TNTOBJECT).

system

Stops all application agents (including LogRemover), CMA, ACB, TRAPMAN, and LOGSUB.

Component	Description
acb	Stops all application agents, CMA, and ACB.
cma	Stops the Call/Media Control agent (TNTOBJECT).
system	Stops all application agents (including LogRemover), CMA, ACB, TRAPMAN, and LOGSUB.

The quiesce Command

Description: Quiesces either the ACB or the CMA server agent.

Syntax: quiesce <component>

Table F-22: quiesce Command Options

Component Description

acb

Allows current agent and ACB sessions to complete, but will not allow new sessions to begin.

cma

Allows current Call/Media Control agent (TNTOBJECT) sessions to complete, but will not allow new sessions to begin.

Note The umcli tool does not currently support quiescing the CMA agent.

The reload Command

Description: Reloads various tables.

Syntax: reload <table> <[parameters]>

Table F-23: reload Command Options

Table Parameters Description

cmaloglevels

NA

Causes the CMA agent to reload the DBG and TRACE sections of the $PARMLIB/TNT/parms/TNT.ini file.

dialmap

NA

Causes the CMA agent to reload the $PARMLIB/TNT/parms/Dialmap.ini file.

route

acb

Causes the ACB to reload the $PARMLIB/parms/APP/Route.<hostname> configuration file for the ACB.

cma

Causes the ACB to reload the $PARMLIB/parms/TNT/Route.<hostname> configuration file for the Call/Media Control agent.

sched

all

Forces the ACB to reload the Schedule.hostname table and starts any static agents in the table that are not running. It will not stop any agents currently running.

static <token>

Starts a specified static application that already exists in the Schedule.<hostname> table.

<token>=any token in the Schedule.<hostname> table that is designated as a static application, for example, FaxPrint, LogRemover, etc.

Table	Parameters	Description
cmaloglevels	NA	Causes the CMA agent to reload the DBG and TRACE sections of the $PARMLIB/TNT/parms/TNT.ini file.
dialmap	NA	Causes the CMA agent to reload the $PARMLIB/TNT/parms/Dialmap.ini file.
route	acb	Causes the ACB to reload the $PARMLIB/parms/APP/Route.<hostname> configuration file for the ACB.
	cma	Causes the ACB to reload the $PARMLIB/parms/TNT/Route.<hostname> configuration file for the Call/Media Control agent.
sched	all	Forces the ACB to reload the Schedule.hostname table and starts any static agents in the table that are not running. It will not stop any agents currently running.
	static <token>	Starts a specified static application that already exists in the Schedule.<hostname> table. <token>=any token in the Schedule.<hostname> table that is designated as a static application, for example, FaxPrint, LogRemover, etc.

Note If you add a new token to the Schedule.<hostname> table, you must use reload sched all or start acb to initially start the application. If you need to restart the application at a later time, you can use reload sched static <token> to restart a static application.

Table of Contents

The umcli Tool