Built-in Agent Namespace Variables

Host Properties

r-

appType 

application name (computer class) 

rw 

bkDiv 

conversion factor for operating system memory block size to convert units of measure for memory usage data 

r-

hostname 

virtual host name 

r-

ipAddress 

host IP address 

r-

ipv6Address 

host IPv6 address 

r-

ipAddressList 

list of IP addresses for network interfaces on the host. Values will have newline characters separating each interface. Interfaces are listed the format: deviceId ipAddress broadcastAddress netMask 

r-

name 

host name 

rw 

osName 

name of operating system running on the host 

rw 

osVersion 

version of the operating system running on the host 

rw 

pgDiv 

conversion factor for operating system page size to convert units of measure for memory usage data 

r-

sysBootTime 

last boot time for the operating system as ASCII string (e.g., Tue Dec 7 03:31:06 2004) 

Agent Properties

r-

agentIsI18N 

TRUE if Agent was built with support for international character sets and messages, FALSE otherwise 

r-

agentLogPath 

full path name of the PATROL Agent's error log file 

r-

agentPid 

r-

agentStartTime 

time the Agent process started as ASCII string (e.g., Tue Dec 7 03:31:06 2004) 

r-

agentLogPath 

Full path name of the PATROL Agent's error log file 

rw 

BMCenterprise 

SNMP ObjectID for BMC SNMP 

r-

cosAgentBranch 

present if the Agent is configured to connect to an RTserver name of service used in COS to advertise data from Agent value will have default format: PATROL_AGENT_<HOSTNAME>_<PORT> 

rw 

historyLength 

number of days Agent will retain parameter history 

r-

patrolBuildVersion 

r-

patrolHome 

PATROL home directory 

r-

patrolVersion 

r-

rtServers 

r-

serverLogPath 

full path name of the PATROL Agent’s error log file 

r-

serverPid 

PID of the PATROL Agent’s process 

r-

tcpPort 

Object Namespace

r-

active 

TRUE if discovery for computer class is active, FALSE otherwise 

r-

instances 

list of SIDs for computer class (i.e., host name) 

r-

numInstances 

number of instances for computer class (will always be 1) 

r-

objectId 

object ID 

r-

sid 

host name 

r-

status 

overall status of this instance (“worst” of ruleState, worstParamState, and worstApplInstState) 

r-

ruleState 

status of the instance based on discovery information only 

r-

totalInstAlloc 

number of instances for which the Agent currently has allocated memory 

r-

totalInstances 

total number of application instances in the object namespace 

r-

worstApplInst 

name of “worst” application instance on this computer 

r-

worstApplInstState 

status of “worst” application instance on this computer 

r-

worstParam 

name of “worst” parameter belonging to the computer class. Note that this value is not the worst parameter on the host across all applications. To check the overall state of the host, worstApplInst is a more appropriate variable. 

r-

worstParamState 

status of “worst” parameter belonging to the computer class 

Execution Properties

r-

execParams 

TRUE if parameters for this computer are allowed to be executed, FALSE otherwise 

r-

execsPerMin 

average number of sub-processes started per minute 

r-

executingProcs 

number of currently executing sub-processes (parameters, commands, and so on) 

r-

globalParamsSuspended 

TRUE if global parameters have been suspended for this computer, FALSE otherwise 

r-

timeBtnExecs 

average time (in seconds) between spawning of sub-processes 

r-

totalPslProcsOnRunq 

number of PSL processes currently in the run queue 

Error Statistics

r-

allocErrors 

number of memory allocation errors 

r-

forkErrors 

number of process spawning errors 

r-

internalErrors 

number of miscellaneous internal errors 

r-

pipeErrors 

number of pipe creation errors 

r-

totalErrors 

r-

userErrors 

number of errors in user-specified commands 

Default Account

gecos 

general user information 

gid 

group ID of principle group 

home 

home directory path 

shell 

shellbeing used when default account runs commands 

uid 

user ID 

username 

user name 

Environment

environment 

comma-separated list of custom environment variables defined for this computer class 

r-

gmtOffset 

difference (in seconds) of the local system time from GMT 

r-

time 

current time as ASCII string (e.g., Thu May 07 02:44:01 1992) 

r-

. 

symbol table for application 

r-

.. 

symbol table for computer 

rw 

active 

TRUE if discovery for application is active, FALSE otherwise 

r-

description 

KM product description, as defined by pragmas for the console server 

r-

discoveryTime 

time period (in seconds) of custom discovery cycle. A value of 0 indicates no custom discovery cycle is set. 

r-

environment 

comma-separated list of custom environment variables defined for this application class 

r-

instances 

list of SIDs of instances of this application 

r-

lastDiscoveryTime 

time (in seconds from Epoch) at which discovery of this application was last done 

r-

name 

application name 

r-

numInstances 

number of instances of this application 

osUsername 

username from definition in configuration database 

package 

package name 

productcode 

three-character BMC product code for the KM 

r-

propagateState 

TRUE if the state of this application is automatically propagated to the computer 

release 

version of the KM product in the format V.R.MM 

revision 

two digit revision number for the KM 

status 

overall status of this application (worst of all instances) 

r-

username 

user name from definition of application class 

r-

. 

symbol table for instance 

r-

.. 

symbol table for application 

r-

appType 

application name 

rw 

environment 

environment variables 

r-

execParams 

TRUE if parameters for this instance are allowed to be executed, FALSE otherwise 

r-

globalParamsSuspended 

TRUE if global parameters have been suspended for this instance, FALSE otherwise 

rw 

home 

home directory for instance 

rw 

name 

icon name and/or label for instance 

r-

objectId 

object ID 

r-

osUsername 

username from definition in configuration database 

r-

parentInstance 

path to the nested instance’s parent instance 

r-

procCommand 

full commands of processes belonging to this instance 

r-

procCpuTime 

cumulative CPU consumption for processes belonging to this instance 

r-

procName 

names of processes belonging to this instance 

r-

procParentPid 

parent PIDs of processes belonging to this instance 

r-

procPercentCpu 

CPU utilization for processes belonging to this instance 

r-

procPid 

PIDs of processes belonging to this instance 

r-

procResidentSetSize 

sizes (resident) of processes belonging to this instance 

r-

procSize 

sizes (virtual) of processes belonging to this instance 

r-

procStatus 

states of processes belonging to this instance 

r-

procUser 

user names of processes belonging to this instance 

r-

ruleState 

status of the instance based on discovery information only 

r-

sid 

SID for instance 

r-

status 

overall status of this instance (“worst” of ruleState and worstParamState) 

r-

transition 

time (in seconds from Epoch) at which instance entered state transition, or zero if not in transition 

r-

username 

user name from definition of application class 

rw 

version 

instance version (monitored software) 

r-

worstParam 

name of “worst” parameter on this instance 

r-

worstParamState 

status of “worst” parameter on this instance 

r-

. 

symbol table for parameter 

r-

.. 

symbol table for instance and/or computer 

rw 

active 

parameter activity 

r-

alarmMax 

maximum value of current alarm's range, or zero if no alarm is active 

r-

alarmMin 

minimum value of current alarm's range, or zero if no alarm is active 

r-

alarmState 

state of current alarm, or “No alarm active” if no alarm is active 

r-

execTime 

time of next scheduled execution 

rw 

interval 

interval (in seconds) between executions 

r-

name 

parameter name 

r-

objectId 

object ID 

r-

outputType 

output type (none, graph, gauge, boolean, text, stoplight, or console) 

r-

parameterType 

parameter type (collector, consumer, or standard) 

rw 

status 

state of the parameter 

-r 

time 

time (in seconds from Epoch) at which this parameter was last executed 

-r 

title 

parameter title as it is displayed in the output 

-r 

units 

output units if the type is a graph or gauge 

rw 

value 

current value