PATROL Agent configuration variables

Agent configuration variables are the means by which the characteristics of a PATROL Agent are defined. To configure a remote iSeries host for monitoring by using PATROL Configuration Manager, add the following set of agent configuration variables, and apply it on the PATROL Agent that runs PATROL for iSeries:

Directory path and variableDescriptionExample

/AKN_REMOTE/maxHeapSize

Sets maximum heap size value for the KM's java.exe process which collects data of the iSeries host. Default value: 1024

"/AKN_REMOTE/maxHeapSize" = { REPLACE = "512" },
/AKN_REMOTE/JAVA_HOME

Set this variable to the directory path of the JRE.

"/AKN_REMOTE/JAVA_HOME" = 
{ REPLACE = "C:\java\jre7" },

/AKN_REMOTE/HOST/<hostname>/userActive

Set this variable to enable or disable User monitoring. Valid values:

  • Enable - 1
  • Disable - 0

"/AKN_REMOTE/HOST/abc.xyz.com/userActive" = { REPLACE = "1" },

/AKN_REMOTE/HOST/<hostname>/userStores the name of the user.

"/AKN_REMOTE/HOST/abc.xyz.com/user" = { REPLACE = "patrol" },

/AKN_REMOTE/HOST/<hostname>/systemActive

Set this variable to enable or disable System monitoring. Valid values:

  • Enable - 1
  • Disable - 0

"/AKN_REMOTE/HOST/abc.xyz.com/systemActive" = 
{ REPLACE = "1" },

/AKN_REMOTE/HOST/<hostname>/subSysActive

Set this variable to enable or disable Subsystem monitoring. Valid values:

  • Enable - 1
  • Disable - 0

"/AKN_REMOTE/HOST/abc.xyz.com/subSysActive" = 
{ REPLACE = "1" },

/AKN_REMOTE/HOST/<hostname>/SUBSYS/
subSystemList

Set this variable to filter subsystems.

For example:

<subSystemName><ctrl+C><subSystemLib><ctrl+B><subSystem1><ctrl+C><subSystemLib1>

Ctrl+C: This is a separator character.

"/AKN_REMOTE/HOST/abc.xyz.com/SUBSYS/subSystemList" = 
{ REPLACE = "B.* },

/AKN_REMOTE/HOST/<hostname>/connectionActive

Set this variable to enable or disable network connection monitoring.

Valid values:

  • Enable - 1
  • Disable - 0
"/AKN_REMOTE/HOST/abc.xyz.com/connectionActive" = 
{ REPLACE = "1" },
/AKN_REMOTE/HOST/<hostname>
/CONNECTION/<CriteriaName>/criteria

Set this variable to filter connection criteria.

"/AKN_REMOTE/HOST/abc.xyz.com/CONNECTION/connection_name/criteria" = 
{ REPLACE = 10.0.0.010.255.255.25520003000*ALL|*TCP|*UDP|*IPI|*IPS" },

/AKN_REMOTE/HOST/<hostname>/secure

Set this variable to 1 for using secure connection to the iSeries host."/AKN_REMOTE/HOST/abc.xyz.com/secure" =
{ REPLACE = "1" },
/AKN_REMOTE/HOST/<hostname>/publishName (add in troubleshooting)Use this variable to set FQDN for the iSeries host.

"/AKN_REMOTE/HOST/abc.xyz.com/publishName" = 
{ REPLACE = "" },

/AKN_REMOTE/HOST/<hostname>/poolActive

Set this variable to enable or disable Storage Pool monitoring. Valid values:

  • Enable - 1
  • Disable - 0

"/AKN_REMOTE/HOST/abc.xyz.com/poolActive" = 
{ REPLACE = "1" },

/AKN_REMOTE/HOST/<hostname>/objectsActive

Set this variable to enable or disable Objects monitoring. Valid values:

  • Enable - 1
  • Disable - 0

"/AKN_REMOTE/HOST/abc.xyz.com/objectsActive" =
{ REPLACE = "1" },

/AKN_REMOTE/HOST/<hostname>/OBJECTS/
BMC/objPInfo

Set this variable to filter objects.

For example:

<ObjectLib>:<ObjectName>:<ObjectType>

Ctrl+C: This is a separator character.

"/AKN_REMOTE/HOST/abc.xyz.com/OBJECTS/BMC/objPInfo" = 
{ REPLACE = "*ALL:BMC*:*LIB" },

/AKN_REMOTE/HOST/<hostname>/OBJECTS/
BMC/objPCrtInf

Set this variable to filter aggregate metrics and create individual instances

For example:

<Monitor aggregate metrics?>:<Create individual instance?>

"/AKN_REMOTE/HOST/abc.xyz.com/OBJECTS/BMC/objPCrtInf" = 
{ REPLACE = "Y:Y" },

/AKN_REMOTE/HOST/<hostname>/msgQActive

Set this variable to enable or disable Message queue monitoring. Valid values:

  • Enable - 1
  • Disable - 0

"/AKN_REMOTE/HOST/abc.xyz.com/msgQActive" = 
{ REPLACE = "1" },

/AKN_REMOTE/HOST/<hostname>/MSGQUEUES/
<MSGQueueLib>:<MSGQueueName>/name

Indicates the MSGQueueLib name and the MSGQueueName

"/AKN_REMOTE/HOST/abc.xyz.com/MSGQUEUES/QSYS:QSYSOPR/name" = 
{ REPLACE = "QSYS:QSYSOPR" },

/AKN_REMOTE/HOST/<hostname>/MSGQUEUES/
<MSGQueueLib>:<MSGQueueName>
/CRITERIA/<CriteriaName>/criteria

Set this variable to filter message queue criteria.

For example:

mIdIn<ctrl+A>mIdEx<ctrl+A>mText<ctrl+A>mTextIn<ctrl+A>mFile<ctrl+A>mLib<ctrl+A>mFileIn<ctrl+A>
mJob<ctrl+A>mUser<ctrl+A>mJobIn<ctrl+A>mSev<ctrl+A>mTypeStr

  • Use 1 to include and 0 to exclude
  • mIdIn - Regular expression for message id to include
  • mSev - Number for severity of message. Valid values = 0 to 99
  • mTypeStr - A pipe separated list of message types
    COMP|COPY|DIAG|ESCAPE|INFO|INQ|NOTIFY|RPY|RQS

Ctrl+C: This is a separator character.

"/AKN_REMOTE/HOST/abc.xyz.com/MSGQUEUES/QSYS:QSYSOPR/CRITERIA/TEST-SEARCH/criteria" = 
{ REPLACE = "id.*ex.*string.*1FILE.*.*0JOB.*USER.*12COMP|COPY|ESCAPE|INFO|INQ|NOTIFY|RPY|RQS" },

/AKN_REMOTE/HOST/<hostname>/jobQActive

Set this variable to enable or disable job queue monitoring. Valid values:

  • Enable - 1
  • Disable - 0

"/AKN_REMOTE/HOST/abc.xyz.com/jobQActive" = 
{ REPLACE = "1" },

/AKN_REMOTE/HOST/<hostname>/JOBQUEUES/
jobQueueList

Set this variable to filter job queues.

For example:

<JobQueueName><ctrl+C><JobQueueLib><ctrl+B><JobQueueName1><ctrl+C><JobQueueLib1>

Ctrl+C: This is a separator character.

"/AKN_REMOTE/HOST/bmc400.isr.bmc.com/JOBQUEUES/jobQueueList" = 
{ REPLACE = "B.* }

/AKN_REMOTE/HOST/<hostname>/interfaceActive

Set this variable to enable or disable network interface monitoring. Valid values:

  • Enable - 1
  • Disable - 0

"/AKN_REMOTE/HOST/abc.xyz.com/interfaceActive" = 
{ REPLACE = "1" },

/AKN_REMOTE/HOST/<hostname>/hostnameStores the name of the iSeries host.

"/AKN_REMOTE/HOST/abc.xyz.com/hostname" = 
{ REPLACE = "abc.xyz.com" },

/AKN_REMOTE/HOST/<hostname>/batchActive

Set this variable to enable or disable Batch Jobs monitoring. Valid values:

  • Enable - 1
  • Disable - 0

"/AKN_REMOTE/HOST/abc.xyz.com/batchActive" = 
{ REPLACE = "1" },

/AKN_REMOTE/HOST/<hostname>/basicProfile

Set this variable to monitor the standard monitoring profiles (System, User, Pool, Batch).

  • Enable - 1
  • Advanced- 0

"/AKN_REMOTE/HOST/abc.xyz.com/basicProfile" = 
{ REPLACE = "0" },

/AKN_REMOTE/HOST/<hostname>/aspActive

Set this variable to enable or disable ASP monitoring. Valid values:

  • Enable - 1
  • Disable - 0

"/AKN_REMOTE/HOST/abc.xyz.com/aspActive" = 
{ REPLACE = "1" },

/AKN_REMOTE/HOST/<hostname>/actJobsActive

Set this variable to enable or disable Active Jobs monitoring. Valid values:

  • Enable - 1
  • Disable - 0

"/AKN_REMOTE/HOST/abc.xyz.com/actJobsActive" = 
{ REPLACE = "1" },

/AKN_REMOTE/HOST/<hostname>/ACTJOBS/
Inter/jobPInfo

Set this variable to filter active jobs.

For example:

<JobNumber>:<JobUser>:<JobName>:<*>:<*>:<jType>:<*>

"/AKN_REMOTE/HOST/abc.xyz.com/ACTJOBS/Inter/jobPInfo" = 
{ REPLACE = "303030:patrol*:*:*:*:*:*" },

/AKN_REMOTE/HOST/<hostname>/ACTJOBS/
Inter/jobPCrtInf

Set this variable to filter aggregate metrics and create individual instances

For example:

<Monitor aggregate metrics?>:<Create individual instance?>

"/AKN_REMOTE/HOST/abc.xyz.com/ACTJOBS/Inter/jobPCrtInf" = 
{ REPLACE = "Y:Y" },

/AKN_REMOTE/DEBUG

Set this variable to enable or disable debug. Valid values:

  • Enable - 1
  • Disable - 0
"/AKN_REMOTE/DEBUG" = { REPLACE = "0" },

/AKN_REMOTE/HOST/<hostname>/outQActive   

Set this variable to enable or disable Output Queue monitoring. Valid values:

  • Enable - 1
  • Disable - 0

"/AKN_REMOTE/HOST/abc.xyz.com/outQActive" = { REPLACE = "1" },

 

/AKN_REMOTE/HOST/<hostname>/qHistActive 

Set this variable to enable or disable History Log monitoring. Valid values:

  • Enable - 1
  • Disable - 0

"/AKN_REMOTE/HOST/abc.xyz.com/qHistActive" = { REPLACE = "1" },

 

/AKN_REMOTE/HOST/<hostname>/schjActive     

Set this variable to enable or disable Scheduled Jobs monitoring. Valid values:

  • Enable - 1
  • Disable - 0

"/AKN_REMOTE/HOST/abc.xyz.com/schjActive" = { REPLACE = "1" },

/AKN_REMOTE/HOST/<hostname>/
OUTQUEUES/outqCriteria

Set this variable to add output queues for monitoring. Valid values:

  • 1 - Monitor all output queues that contain spool files.
  • 2 - Monitor all HELD output queues that contain spool files.
  • 3 - Monitor all RELEASED output queues that contain spool files.
  • 4 - Monitor all output queues associated with a writer.
  • 5 - Monitor specified output queues 

"/AKN_REMOTE/HOST/abc.xyz.com/OUTQUEUES/outqCriteria" = { REPLACE = "1" },

/AKN_REMOTE/HOST/<hostname>/
OUTQUEUES/outQList

Provide the list of output queues to monitor.

The format of the list is

<outq1>


<outqLib1>[1]<outq2>


<outqLib2>

where,

<outq> - name of the output queue or a regular expression matching one more output queues

<outqLib> - name of the library of output queue or a regular expression matching one more libraries


- separator between output queue and library

[1] - separator between multiple output queue entries.

"/AKN_REMOTE/HOST/abc.xyz.com/OUTQUEUES/outQList" =

{ REPLACE = "QPRINT


QGPL" },
/AKN_REMOTE/HOST/<hostname>/
OUTQUEUES/outQExclList

Provide the list of output queues to exclude from monitoring.

The format of the list is

<outq1>

<outqLib1>[1]<outq2>


<outqLib2>

where,

<outq> - name of the output queue or a regular expression matching one more output queues

<outqLib> - name of the library of output queue or a regular expression matching one more libraries


- separator between output queue and library

[1] - separator between multiple output queue entries.

"/AKN_REMOTE/HOST/abc.xyz.com/OUTQUEUES/outQExclList" =

{ REPLACE = "QPRINT


QGPL" },
/AKN_REMOTE/HOST/<hostname>/SCHJOBS/schjCriteria

Set this variable to add scheduled jobs for monitoring.

Valid values:

1 - Monitor all scheduled jobs

2 - Monitor all scheduled jobs with status HLD

3 - Monitor all scheduled jobs with status SAV

4 - Monitor all scheduled jobs with status SCD

5 - Monitor specified scheduled jobs

"/AKN_REMOTE/HOST/abc.xyz.com/SCHJOBS/schjCriteria" =
{ REPLACE = "1" },
/AKN_REMOTE/HOST/<hostname>/SCHJOBS/schJobsList

Provide the list of scheduled jobs to monitor. The format of the list is

<scheduledJob1>[1]<scheduledJob2>[1]<scheduledJob3>

where,

<scheduledJob> - name of the scheduled job

[1] - separator between multiple scheduled job entries.

"/AKN_REMOTE/HOST/abc.xyz.com/SCHJOBS/schJobsList" =

{ REPLACE = "TEST[1]ALARM" },

/AKN_REMOTE/HOST/<hostname>/SCHJOBS/schExclJobsList

Provide the list of scheduled jobs to exclude from monitoring. The format of the list is <scheduledJob1>[1]<scheduledJob2>[1]<scheduledJob3>

where,

<scheduledJob> - name of the scheduled job

[1] - separator between multiple scheduled job entries.

"/AKN_REMOTE/HOST/abc.xyz.com/SCHJOBS/schExclJobsList" = { REPLACE = "TEST[1]ALARM" },

 

/AKN_REMOTE/HOST/<hostname>/QHST/abendActive

Set this variable to enable or disable monitoring of abnormally ended jobs. Valid values:

  • 1 - Enable
  • 0 - Disable

"/AKN_REMOTE/HOST/abc.xyz.com/QHST/abendActive" =

{ REPLACE = "1" },

/AKN_REMOTE/HOST/<hostname>/QHST/abendInclExcl

Set this variable to specify wheter to consider all jobs or exclude specific jobs while monitoring for abnormal endings. Valid values:

  • 1 - Include all jobs
  • 0 - Exclude jobs specified in abendExclJobsList

"/AKN_REMOTE/HOST/abc.xyz.com/QHST/abendInclExcl" = { REPLACE = "1" },

/AKN_REMOTE/HOST/<hostname>/QHST/abendThreshold

Set this variable to provide end code threshold. All jobs that end with an end code equal to or greater than this threshold are considered to have ended abnormally.

Default value is 20.

"/AKN_REMOTE/HOST/abc.xyz.com/QHST/abendThreshold" =

{ REPLACE = "20" },

/AKN_REMOTE/HOST/<hostname>/ QHST/sysValChanges

Set this variable to enable or disable monitoring of system value changes. Valid values:

  • 1 - Enable
  • 0 – Disable

"/AKN_REMOTE/HOST/abc.xyz.com/QHST/sysValChanges" =

{ REPLACE = "1" },

/AKN_REMOTE/HOST/<hostname>/QHST/abendExclJobsList

Provide the list of jobs not be considered while monitoring abnormal endings.

The format of the list is

<job1>


<user1><job2>
<user2>

where,

<job> - name of the job or a regular expression matching one or more jobs

<user> - name of the user or a regular expression matching one or more users


 - separator between job name and user name
 - separator between multiple job entries.

"/AKN_REMOTE/HOST/abc.xyz.com/SCHJOBS/abendExclJobsList" =

{ REPLACE = "TEST
ADMINTEST1
ADMIN1" },
/AKN_REMOTE/HOST/<hostname>/QHST/abendCritJobsList

Provide the list of jobs not be considered while monitoring abnormal endings.

The format of the list is

<job1>


<user1><job2>
<user2>

 

where,

<job> - name of the job or a regular expression matching one or more jobs

<user> - name of the user or a regular expression matching one or more users


 - separator between job name and user name
 - separator between multiple job entries.

"/AKN_REMOTE/HOST/abc.xyz.com/SCHJOBS/abendCritJobsList" =

{ REPLACE = "TEST
ADMINTEST1
ADMIN1" },

/AKN_REMOTE/HOST/<hostname>/SYSTEM/avgCpuUtilEnable

Use this variable for changing the calculation method of CPUUtilization.

  • 1 - Average CPUUtilization over polling interval like local monitoring.
  • 0 - Instantaneous CPUUtilization value as it is in 4.x version of the KM.


Was this page helpful? Yes No Submitting... Thank you

Comments