IBM i AS/400

Introduction

The IBM i is a widely used platform for core-banking and wealth and retail systems. It is the current version of the operating system previously called i5/OS, and originally named OS/400 when it was introduced with the AS/400 computer system.

Geneos has the capability to monitor the IBM i remotely using the JTOpen library, which is the open-source version of the IBM Toolbox for Java, and is a library of Java classes that allows access to IBM i resources. The JTOpen library is included with the Linux version of the Netprobe.

The following plug-ins for the IBM i are available:

IBM i System — shows metrics on CPU, Hardware, and Disk
IBM i JDBC — generates views based on SQL queries to the Db2 for i database.
IBM i Pool — shows metrics on storage pools for a system
IBM i Subsystem — shows metrics on subsystems within a system
IBM i Job — shows metrics on jobs running on the system
IBM i Queue — shows metrics on message queues for a system
IBM i Message — shows metrics on messages within a queue
IBM i Log Reader — generates streams from IBM i logs for consumption by other plugins, such as FKM and State Tracker plugins.

Note: Beginning Geneos 5.5.x, the IBM i JDBC plugin is available to query Db2 for i and publish its results to a dataview.

Prerequisites

The following are the requirements for running the Geneos IBM i plugins:

Linux machine running a Netprobe.
Java runtime environment or JavaDevelopment Kits installed in the Linux machine. For information on compatible Java versions, see Application and plug-in specific information in Geneos Compatibility Matrix.
The plugin must be able to connect to a Java application. For guidance, see Configure the Java environment.
A TCP/IP connection to an IBM i server. The IBM i server must have the following:
- Server must be IBM i, i5/OS, or OS/400 V4R3 or higher.
- Server must have the Option 12 host servers installed and running. JTOpen uses the host servers as TCP/IP endpoints to communicate with the server from a client.
- Server must be able to accept connections on ports 8470, 8473, 8475, 8476, and 449. These are the defaults used by the server. If you use non-default ports, make sure those are open to accept connections.

For more information on supported IBM i versions, see Operating system support in 5.x Compatibility Matrix.

The following are the views for the IBM i plugin:

Name	Description
CPU	A view showing CPUs being used by the IBM i system/partition.
Disk	A view showing the disk status of the IBM i system.
Hardware	A view showing the major operating system and hardware resource settings for the IBM i.
JDBC	Views showing data from Db2 for i based on configured SQL queries. Each SQL query will have an associated dataview.
Job	A view showing IBM i server jobs.
Log Reader	Shows the status of streams generated by the IBM i Log Reader plugin.
Message	Shows the messages for a configured message queue.
Pool	A view showing the storage pools for the IBM i system.
Queue	A view showing message queues (MSGQ) for the IBM i system. Message queues are used for system and program messages for the operator.
Subsystem	IBM i subsystems are an operating environment, defined by a subsystem description, where the system coordinates processing and resources.

Sampler configuration

This section lists down configuration items common for all views, as each view is run by a separate IBM i sampler.

Caution: When you update the configuration of certain Java-based plug-ins, including this one, the Netprobe running it has to restart. Be aware of other potentially unrelated plug-ins that can be affected when you configure this particular plug-in.

connection > systemName

Defines the IBM i system being monitored by the sampler. This can be either an IP address or the actual system name.

Mandatory: Yes

connection > username

This is the IBM i user name to utilise for monitoring.

Note: The Subsystem View requires user type SECOFR to return data for all subsystems.

connection > password

This is the password for the IBM i user.

connection > connectionTimeout

This is a configuration timeout for the views, in seconds. Default is 30 seconds.

System view

The System View combines CPU, Hardware and Disk.

CPU View

This view shows CPUs being used by an IBM i system/partition.

ibmi_image0

Headline legend

Name	Description
system	The IBM i system name.

Table legend

Name	Description
currentProcessingCapacity	The amount (in number of physical processors) of current processing capacity of the partition. For a partition sharing physical processors, this attribute represents the shares of the physical processors in the pool it is executing.
percentCurrentInteractivePerformance	The percentage of interactive performance assigned to the logical partition.
percentDBCapability	The percentage of processor database capability that was used during the elapsed time. The value `-1 (Not reported by this system)` indicates that the system does not report the amount of CPU used for processing.
percentProcessingUnitUsed	The average of the elapsed time during which the processing units were in use. For an uncapped partition, this is the percentage of the configured uncapped shared processing capacity for the partition that was used during the elapsed time. This percentage could be greater than 100% for an uncapped partition.
percentSharedProcessorPoolUsed	The percentage of the total shared processor pool capacity used by all partitions using the pool during the elapsed time. The value `-1 (Partition does not share processors)` indicates that the partition does not share processors.
percentUncappedCPUCapacityUsed	The percentage of uncapped shared processing capacity for the partition that was used during the elapsed time. The value `-1 (Partition limited to configured capacity)` indicates that the partition cannot use more than its configured processing capacity.
processors	Number of processors that are currently active in this partition.
processorSharingAttribute	Indicates if the partition is sharing processors. 0 - does not share processors 1 - shares processors (capped - limited to using configured capacity) 2 - shares processors (uncapped - can use more than its configured capacity).

Disk view

The IBM i Disk View monitors disk usage. In the IBM i, a disk is represented by an auxiliary storage pool (ASP). An ASP is a software definition of a group of disk units on the IBM i system. This means that an ASP does not necessarily correspond to the physical arrangement of disks.

IBM i disk view

Name	Description
system	The IBM i system name.

Table legend

Name	Description
unit	Disk unit number. This is a unique identifier for each non-mirrored unit or mirrored pair among the configured disk units. Both mirrored units of a mirrored pair have the same disk unit number. The value of the disk unit number is assigned by the system when the disk unit is assigned to the ASP.
name	The resource name - the unique system-assigned name of the disk unit.
type	The type of disk unit.
freeSpace	Disk storage available. The number of MB of space not currently assigned.
percentUsed	Percentage of disk used.
totalSpace	Disk capacity. The total size of the disk unit in MB.
percentBusy	Percentage of disk busy. This is calculated based on `(sampleCount - notBusyCount) / notBusyCount`, where: `-sampleCount` is the number of times the disk queue was checked to determine whether or not the queue was empty `-notBusyCount` is the number of times the disk queue was empty during the same time period that the sample count was taken This is the same as the `%busy` column in the IBM i Work with Disk Status (`WRKDSKSTS`).

Hardware view

The IBM i Hardware View provides major operating system and hardware resource settings of an IBM i host.

ibmi_image2

Table legend

Name	Description
OS	Details of the operating system of the host. For example, IBM i 6.1.0 where Version = 6, Release = 1, Modification = 0.
countryId	Country identifier. Example: US.
system	The IBM i system name.
languageId	Language identifier. Example: ENU.
mainStorageSize	This is the total RAM in the system, in MB, which is represented by main storage size in the IBM i. Note: On a partitioned system, the main storage size can change while the system is active.
processorFeature	Processor feature code of the system. This is used to identify the processor used on the system.
systemModel	The model number of the system. Example: MHB, which is a Power 780.
systemSerialNo	This is the seven-digit number that uniquely identifies the System i.
timezone	Current time zone of the machine. This displays either the long version of the time zone, such as `Eastern Standard Time`, or the customID format, such as `GMT±HH:MM`.
totalActiveJobs	This is the number of jobs active in the system (jobs that have been started, but have not yet ended), including both user and system jobs.
totalJobs	This is the total number of user and system jobs that are currently in the system. This includes: All jobs on job queues waiting to be processed All jobs currently active (being processed) All jobs that have completed running but still have pending job logs or output on output queues to be produced
upTime	Elapsed time in days since the last IPL (Initial Program Load) / system reboot.

JDBC view

Note: Beginning Geneos 5.5.x, the IBM i JDBC plugin is available to query Db2 for i and publish its results to a dataview.

Views under JDBC show data from Db2 for i based on configured SQL queries. Each SQL query will have an associated dataview.

IBM i JDBC view

Headline legend

When streaming is enabled, headlines for stream information appear in the query dataview:

Name	Description
streamName	Name of the stream. Note: Headlines have a length limit; therefore, the displayed value can be truncated. You can retrieve the complete name from the headline, for example, by right-clicking and selecting Copy from <!>streamName > Value.
currentBufferSize	Number of messages that the sampler holds in the stream. The sampler holds these messages until they are consumed by another sampler.
maxBufferSize	Maximum number of messages that the sampler can hold before it starts to drop earlier messages. This value is set by the query Row limit option.
totalMessagesReceived	Total number of messages that the sampler has received in the stream. A row in the query result counts as a message.
totalMessagesLost	Total number of messages that the sampler has dropped because the buffer was full.

Note: Stream messages are stored in the buffer until they are consumed by another component. However, If there are no samplers or clients consuming the stream, then the stream registry purges the messages immediately.

JDBC configuration

Basic configuration

Queries

Option	Description
Name	Name of the query and the dataview it creates.
Sql	The SQL query that represents what data will be displayed in the dataview. By default, this runs only on the default database file member. In some IBM i machines, database files may have one or more members. A member is similar to a subset of the file and each member contains records. To run a query on a non-default file member, follow these steps: Create an alias that references the file and the member. This can be created within the terminal or via a database client. For example: CREATE ALIAS QSYS.ALIAS1 FOR QSYS.FILENAME(MEMBERNAME) Use the created alias in the query. For example: SELECT * FROM QSYS.ALIAS1
Row limit	Maximum number of rows to be displayed on the dataview. The rows are counted from the results of the query. Default value: `200`
Stream	If ticked, enables the publishing of query results to a stream. Query result rows are streamed as JSON data containing column name-value pairs. A single row then counts as one stream message. On the first sample, all rows displayed in the dataview are streamed. On succeeding samples, only new and updated rows are streamed. When enabled, the resulting stream has fully qualified stream name in the following format: `managedEntity-name.sampler-name(type).query-name` For example: `ME.ibmi-jdbc.queryA` This setting is disabled by default. Caution: The stream option is not supported on Linux: Red Hat on IBM POWER8.

Example stream output in FKM plugin

The following dataview shows an example stream from the IBM i JDBC sampler used by an FKM sampler:

Example IBM i JDBC stream in the FKM stream

Connection

Option	Description
Database	IBM i Db2 for i database server option.
Server Name	Host name or IP address of the Db2 for i server.
Port	Configured port of the database application. Default value: `8471`
Database Name	Default database, schema, or catalog to open. Setting a default affects your query usage. For example: If you specify a default database, for example, `MYDB`, containing the table `TBL1`then the query `SELECT * FROM TBL1` in the Sql option would suffice. If you have another database, `MYDB2`, containing the table `TBL2`, then you have to specify `SELECT * FROM MYDB2.TBL2` in the Sql option. Notice that the fully qualified table name was specified, including the database it belongs to.
User Name	Authorised user to connect to the database.
Password	Password for the authorised user. Choose the appropriate field when specifying the password: `stdAES` — use this to input your plaintext password. If you select `stdAES`, you can define your password directly in the sampler and store it in standard AES encryption hash in the Gateway. `var` — use this to pass the password as a variable. The variable is defined in Managed entity > Advanced > Var. This is useful for situations where you have multiple samplers that use the same credentials. `extPwd` — use this for passwords provided by an external provider. For more information, see Securing your Gateway with an external password provider in Secure Passwords.

Advanced configuration

The Advanced tab shows the JDBC settings for the sampler.

Option Description

Option	Description
Connection pool size	Sets the maximum size that the pool is allowed to reach, including both idle and in-use connections. This option is set per IBM i JDBC sampler. Default value: `5`
Connection timeout	Sets the maximum number of seconds that a query waits for a connection from the pool. A connection may time out when it cannot be established, for example, due to issues with network. Default value: `30`
Idle connection timeout	Sets the maximum number of seconds that a connection can be idle in the pool. Default value: `600`

Connection pool size

Sets the maximum size that the pool is allowed to reach, including both idle and in-use connections.

This option is set per IBM i JDBC sampler.

Default value: 5

Connection timeout

Sets the maximum number of seconds that a query waits for a connection from the pool. A connection may time out when it cannot be established, for example, due to issues with network.

Default value: 30

Idle connection timeout

Sets the maximum number of seconds that a connection can be idle in the pool.

Default value: 600

Job view

This view shows IBM i server jobs. Jobs are the basic unit of work on the IBM i. Additional "cpu" statistics can be obtained by enabling this in the configuration.

Note: Enabling cpu statistics will increase data collection time due to additional JTOpen calls in the background. If cpu statistics are enabled, we recommend using filters to limit the number of rows returned in the dataview.

Here is the view with cpu statistics switched off:

ibmi_image3

Here is the view with cpu statistics switched on:

ibmi_image4

Headline legend

Name	Description
system	The IBM i system name.
totalJobs	The total number of user and system jobs in the system.
totalActiveJobs	The number of active jobs in the system, including both user and system jobs.
maxJobs	The maximum number of jobs allowed on the system.
totalBatchJobs	The number of batch jobs currently running on the system.
jobsMatchingFilter	The number of jobs that matched filter criteria.
jobsMaxRows	The number of rows that is set in the max rows setting.

Table legend

Name	Description
key	Job name/job number. For example, ADMIN/000294.
name	The job name.
number	The job number. For example, 000294.
user	The user name. For example, QWEBADMIN.
type	The job type. Possible values are: AUTOSTART BATCH INTERACTIVE SCPF_SYSTEM SPOOLED_READER SPOOLED_WRITER SUBSYSTEM_MONITOR SYSTEM
status	The job status. Possible values are: ACTIVE JOBQ - job currently on a job queue OUTQ - completed running but still has output on an output queue
activeJobStatus	The active job status. This is the active status of the initial thread of the job. There are many active job statuses designated by a 4-letter code. A blank status field represents a job that is in transition or is not active. Some examples: DEQW - waiting for completion of a dequeue operation DSPW - waiting for input from a work station display MSGW - waiting for a message from a message queue SEMW - waiting for a semaphore (a synchronization function that is used to allow multiple jobs or threads to serialize their access to shared data) TIMA - waiting in a pool activity level for a time interval to end. TIMW - waiting for a time interval to end.
statusInQueue	The status of the job on the job queue. Possible values are: BLANK HELD READY SCHEDULED RLS - job is ready to be selected
subsystem	The subsystem in which the job is running.
priority	The priority at which the job is currently running, relative to other jobs on the system, ranges from 0 (highest) to 99 (lowest).
endReason	This is the job end reason, which only has a value if the job was already ended. Possible values are: 0: Job not ending. 1: Job ending in a normal manner. 2: Job ended while it was still on a job queue. 3: System ended abnormally. 4: Job ending normally after a controlled end was requested. 5: Job ending immediately. 6: Job ending abnormally. 7: Job ended due to the CPU limit being exceeded. 8: Job ended due to the storage limit being exceeded. 9: Job ended due to the message severity level bein exceeded. 10: Job ended due to the disconnect time interval being exceeded. 11: Job ended due to the inactivity time interval being exceeded. 12: Job ended due to a device error. 13: Job ended due to a signal. 14: Job ended due to an unhandled error.
jobEnteredSystemDate	The date the job entered the system.
jobEnteredSystemTime	The time the job entered the system.
jobStartDate	The start date for the job.
jobStartTime	The start time for the job.
jobEndDate	The end date for the job, if available. This value is for jobs whose status is JOBQ or ACTIVE. For jobs with a status of OUTQ, the value for this field is blank.
jobEndTime	The end time for the job, if available. This value is for jobs whose status is JOBQ or ACTIVE. For jobs with a status of OUTQ, the value for this field is blank.
timeElapsed	The elapsed time for the job. This is the difference between the start datetime and the end datetime or the datetime of the current sample, if the job does not yet have an end datetime. Depending on the actual time elapsed, this field will be displayed in the format <dddd:hh:mm:ss>.
totalCpuUsed	The total amount of processing time (in ms) that the job used. Note: This field will not be displayed if enableCpuStatistics is set to false.
cpuPercentElapsed	Processing unit used by the job - in percent during the elapsed (sampling) time. Note: This field will not be displayed if enableCpuStatistics is set to false.
cpuTimeElapsed	Processing unit used by the job in ms - time during the elapsed (sampling) time. Note: This field will not be displayed if enableCpuStatistics is set to false.

Job configuration

Note: All filters in this plug-in use Java Regular Expressions.

filters > jobName

This will filter the dataview to include only jobs matching a regex or a list of jobs.

Mandatory: No

Default: blank

filters > useRegexForJobName

If set to true, the jobname filter will use a Java regex as indicated in the Javadoc for java.util.regex.Pattern.

If set to false, the jobname filter will expect a list of specific and generic AS/400 jobnames separated by the pipe symbol. A generic jobname is indicated by a prefix, followed by an asterisk. Example lists of jobnames are:

QSERVER
QSERVER|QCTL
QSERVER|QU*|QCTL|QT*
Q*

When using a list of jobnames (instead of a regex filter), queries into the IBMi are more specific and relatively faster (compare to using a regex filter for jobnames, which will query for all jobnames and apply the regex on the results). If the list of jobnames doesn't include valid specific/generic jobnames, or isn't separated by | symbols, it will be treated as a regex instead.

Mandatory: No

Default: True

filters > jobStatus

This will filter the dataview to include only jobs based on the job status. Possible values are:

ACTIVE
JOBQ - job currently on a job queue
OUTQ - completed running but still has output on an output queue

Mandatory: No

Default: None

filters > jobSubsystem

This will filter the dataview to include only jobs being run on the specified subsystem.

Note: This filter works by regex. If the subsystem filter has a value and enableCpuStatistics is false, then the subsystem filter will be ignored.

Mandatory: No

Default: none

filters > jobType

This will filter the dataview to include only jobs with the specified type. For example, BATCH will filter only batch jobs. Possible values are:

AUTOSTART
BATCH
INTERACTIVE
SCPF_SYSTEM
SPOOLED_READER
SPOOLED_WRITER
SUBSYSTEM_MONITOR
SYSTEM

Mandatory: No

Default: none

filters > jobUser

This will filter the dataview to include only jobs matching the configured job user name.

Note: This filter works by an exact match but is not case sensitive.

Mandatory: No

Default: blank

filters > maxRows

The maximum number of rows that will appear on the dataview.

Mandatory: No

Default: 20 rows

enableCpuStatistics

This is a flag that will determine whether or not CPU statistics are retrieved by the plugin. Disabling CPU statistics will improve performance of the plugin, but the following fields will not be displayed: totalCpuUsed, cpuPercentElapsed, cpuTimeElapsed.

Mandatory: No

Default: false

filters > lastXHours

This will filter the dataview to include only jobs that have dates (DateEntered) that fall within the last number of hours specified.

Mandatory: No

Log Reader view

Note: Beginning Geneos 5.3.0, the IBM i Log Reader is available to send the contents of IBM i IFS log files into a stream.

This view shows the status of IFS log files and the associated outbound streams coming from the IBM i Log Reader plugin:

IBM i Log Reader dataview

You can configure IBM i Log Reader sampler to read log files from the IBM i IFS, then send the contents of the log files as a stream for consumption by other plugins, such as the FKM and State Tracker plugins.

Headline legend

Headline name	Description
system	Name of the IBM i system that the sampler is connected to.
totalStreams	Number of streams that have been created on the sampler.

Table legend

Headline name	Description
name	Name of the stream. IBM i Log Reader outbound streams have a fully qualified stream name in the following format: `managedEntity-name.sampler-name.file-path`
status	Status of the file stream. Possible values: `OK` — file is being read without issue. `FILE_NOT_FOUND` — file was not found in the file system. `READ_ACCESS_DENIED` — file cannot be read because the logged-in user is not authorised to read the file. `FILE_IO_ERROR` — an error was encountered while reading the file.
currentBufferSize	Number of messages that the sampler holds in the stream. The sampler holds these messages until they are consumed by another sampler.
maxBufferSize	Maximum number of messages per stream that the sampler can hold before it starts to drop earlier messages. This field is set by the Buffer size configuration. For more information, see Log Reader configuration.
totalMessagesReceived	Total number of messages that the samplers has received in the stream. Every line in the log file counts as a message.
totalMessagesLost	Total number of messages that the sampler has dropped because the buffer was full.

Log Reader configuration

Basic configuration

Option Description

Filename

Option	Description
Filename	Name of the log file to read in the IBM i host. This configuration supports wildcard expressions for filenames. Supported wildcard characters are `*` and `?`. When you use wildcard characters for filenames, the stream rows are added to the Log Reader dataview as these are detected. Only one file will be associated with a wildcard pattern and stream at a time. The newest or most recently updated file matching the wildcard character will be monitored.
Rewind	If ticked, the IBM i Log Reader reads from the beginning of a log file. Otherwise, the IBM i Log Reader reads from the last read position when the Netprobe or sampler is restarted. If both rewind and file position support are disabled, then the Log Reader reads from the end of the file. This option is disabled by default.

Name of the log file to read in the IBM i host.

This configuration supports wildcard expressions for filenames. Supported wildcard characters are * and ?. When you use wildcard characters for filenames, the stream rows are added to the Log Reader dataview as these are detected.

Only one file will be associated with a wildcard pattern and stream at a time. The newest or most recently updated file matching the wildcard character will be monitored.

Rewind

If ticked, the IBM i Log Reader reads from the beginning of a log file. Otherwise, the IBM i Log Reader reads from the last read position when the Netprobe or sampler is restarted.

If both rewind and file position support are disabled, then the Log Reader reads from the end of the file.

This option is disabled by default.

Advanced configuration

Option Description

Buffer size

Option	Description
Buffer size	Sets the maximum number of messages per stream that the IBM i Log Reader sampler holds in memory at a time. Messages clear the buffer when the stream is received by an FKMsampler. You can toggle between entering a numerical value (`data`) or a variable (`var`). Default value: `1000`
Worker pool size	Number of worker tasks that can be executed for reading files concurrently. This enables the IBM i Log Reader sampler to read multiple files at the same time during a sampling. Files are queued and picked up for processing by an available worker. After being read, the files return to the queue for the next sample. You can tune the worker pool size so that the sampling of large or rapidly growing files would not block the sampling of other files. You can toggle between entering a numerical value (`data`) or a variable (`var`). Default value: `10`

Sets the maximum number of messages per stream that the IBM i Log Reader sampler holds in memory at a time. Messages clear the buffer when the stream is received by an FKMsampler.

You can toggle between entering a numerical value (data) or a variable (var).

Default value: 1000

Worker pool size

Number of worker tasks that can be executed for reading files concurrently. This enables the IBM i Log Reader sampler to read multiple files at the same time during a sampling.

Files are queued and picked up for processing by an available worker. After being read, the files return to the queue for the next sample. You can tune the worker pool size so that the sampling of large or rapidly growing files would not block the sampling of other files.

You can toggle between entering a numerical value (data) or a variable (var).

Default value: 10

Log Reader position file

By default, the IBM i Log Reader reads from the last read position of a log file when the Netprobe or sampler is restarted. It does this by maintaining position files, located in a directory called /ibmi-log-position directory under the Netprobe working directory. Position files are managed as follows:

In the /ibmi-log-position directory has subdirectories for each IBM i Log Reader sampler. The directory name format is <ME-name>.<sampler-name>.
There is one position file per file being monitored, and updates immediately after each stream message is sent.
A position file is removed when it has not been updated for a specified number of days. For more information, see Advanced configuration — File position support.

Position files enable you to stop and restart the Netprobe and have it pick up where it left off without missing any new lines added to the log.

Caution: If rewind is enabled, then the IBM i Log Reader plugin will always read the monitored file from the beginning.

Advanced configuration — File position support

Option Description

Enabled

Option	Description
Enabled	If ticked, then the IBM i Log Reader plugin keeps track of the current position of each monitored file. This makes it possible to resume from the last read position when the Netprobe is stopped or restarted. If both rewind and file position support are disabled, then the Log Reader reads from the end of the file. This option is ticked by default.
Remove after inactive for (days)	Number of days that a position file is allowed to be inactive before it is deleted. Default value: `7`

If ticked, then the IBM i Log Reader plugin keeps track of the current position of each monitored file. This makes it possible to resume from the last read position when the Netprobe is stopped or restarted.

If both rewind and file position support are disabled, then the Log Reader reads from the end of the file.

This option is ticked by default.

Remove after inactive for (days)

Number of days that a position file is allowed to be inactive before it is deleted.

Default value: 7

Message view

This view shows messages for a specific message queue. It can be used to monitor and alert on messages in an IBM i message queue.

Messages are sorted from newest to oldest.

ibmi_image5

Headline legend

Name	Description
system	The IBM i system name.
queuePath	The path of the message queue. For example, /QYS.LIB/QSYSOPR.MSGQ, where QSYSOPR is the name of the message queue.
totalMessages	The number of messages in the queue.
messagesMatchingFilter	The number of messages matching the filter
messageMaxRows	The number of rows that is set in the max rows setting.

Table legend

Name	Description
key	This field is a combination of the message key (the integer representation of the 4-byte message key) and the date the message was sent (YYYY-MM-DD).
id	The message ID.
severity	The message severity, which is a value between 0 and 99, or -1 if it is not set.
type	The message type. Possible message types are: COMPLETION DIAGNOSTIC ESCAPE ESCAPE_NOT_HANDLED INFORMATIONAL INQUIRY MESSAGE_OPTION_UP_TO_10 NOTIFY NOTIFY_NOT_HANLDED REPLY_FROM_SYSTEM_REPLY_LIST REPLY_MESSAGE_DEFAULT_USED REPLY_NOT_VALIDITY_CHECKED REPLY_SYSTEM_DEFAULT_USED REPLY_VALIDITY_CHECKED REQUEST REQUEST_WITH_PROMPTING SENDERS_COPY
date	The date the message was sent (YYYY-MM-DD).
time	The time the message was sent.
senderJobName	The sender job name.
senderJobUser	The sender job's user.
senderJobNumber	The sender job number.
text	The text of the message with the substitution text inserted.

Message Configuration

Note: All filters in this plug-in use Java Regular Expressions.

queuePath

This is the message queue to monitor for the sampler. For example, /QSYS.LIB/QSYSOPR.MSGQ.

Mandatory: Yes

filters > severity

The message severity filter filters the messages to be displayed based on the message's severity. For example, if 50 is entered in this field, only messages with a severity of 50 and above will be shown.

The minimum and maximum values for severity are 0 and 99, respectively.

Mandatory: No

Default: 0

filters > senderJobUser

This will filter the dataview to include only messages from the sender job user.

Note: This filter works by an exact match but is not case-sensitive.

Mandatory: No

Default: none

filters > senderJobName

This will filter the dataview to include only messages from the sender job name.

Note: This filter works by an exact match but is not case-sensitive.

Mandatory: No

Default: none

filters > maxRows

The maximum number of queued messages that will be fetched and displayed on the dataview.

Note: The maximum number of messages are fetched first, before filters are applied.

Mandatory: No

Default: 20

filters > lastXHours

This will filter the dataview to include only messages that have dates that fall within the last number of hours specified.

Mandatory: No

Pool view

This view shows the IBM i's storage pools. Storage pools segment the OS/400 working memory so that each subsystem can access its own specified piece of memory.

ibmi_image6

Headline legend

Name	Description
system	The IBM i system name.
partitionId	The identifier for the partition.
pools	The number of storage pools.
totalAuxiliaryStorage	Total auxiliary storage for the partition.
systemASP	Storage capacity of the system auxiliary storage pool (ASP1), in MB.
percentageSystemASPUsed	The percentage of the system storage pool currently in use.

Table legend

Name	Description
id	The system pool identifier.
name	The storage pool name, e.g. *INTERACT.
size	The amount of main storage, in KB, currently allocated to the pool.
reservedSize	The amount of storage, in KB, in the pool reserved for system use.
databasePages	The rate, in pages per second, at which database pages are brought into the storage pool.
databaseFaults	The rate, in page faults per second, of database page faults against pages containing either database data or access paths.
nonDatabasePages	The rate, in pages per second, at which non-database pages are brought into the storage pool.
nonDatabaseFaults	The rate, in page faults per second, of non-database faults against pages other than those designated as database pages.

Queue view

This view is used to monitor specific message queues on the IBM i. A message queue is like a mail box for messages - which is a communication sent from one user, program, or procedure to another. The IBM i has several message queues that hold messages that provide helpful information when finding and reporting problems. For example:

QSYSOPR - the system operator message queue. This queue contains messages that require a reply from the IBM i operator.
QSYSMSG - an optional message queue that holds severe error messages.
QHST - the IBM i history log contains messages that track the system's activities.

The IBM i also provides message queues for the following:

Each workstation on the system
Each user enrolled on the system

ibmi_image7

Headline legend

Name	Description
system	The IBM i system name.
totalQueues	The total number of message queues in the system.

Table legend

Name	Description
name	The name of the message queue. If useFullPathForRowname is enabled, then this column displays the qualified path name of the message queue instead.
path	The qualified path name of the message queue. If useFullPathForRowname is enabled, then this column does not appear in the dataview, and instead the queueName column is shown.
queueName	If useFullPathForRowname is enabled, then this column displays the name of the message queue. Otherwise, it does not appear in the dataview.
totalMessages	The total number of messages in the queue.
severityCodeFilter	This is the severity code used by the message queue to filter messages. For example, for an interactive job, the messages are displayed at the display station if the severity code is high enough. By default, message queues have a severity code filter of zero (0). The value in this column will be between 0 and 99. Caution: Beginning Geneos 5.7.x, this column will be deprecated.

Queue configuration

Note: All filters in this plug-in use Java Regular Expressions.

filters > queueNameFilter

Caution: Beginning Geneos 5.7.x, this setting will be deprecated and will be replaced with new filters for Queue library and Queue name. For more information, see Queue Advanced Configuration.

This will filter the dataview to include only queues with names matching this configuration.

Mandatory: No

filters > maxRows

The maximum number of rows that will appear on the dataview.

Mandatory: No

Default: 20 rows

useFullPathForRowname

If enabled, the name column on the dataview shows the qualified path name, while a separate queueName column displays the queue name:

IBM i Queue useFullPathForRowname view

Mandatory: No

Default: false

Subsystem view

IBM i subsystems are an operating environment, defined by a subsystem description, where the system coordinates processing and resources. They are used to control how different jobs run on your system and how much resources are allocated to different jobs. This view shows configured subsystems of an IBM i system.

SECOFR required

Note: User type SECOFR is required to show data for all subsystems. If a non-SECOFR is used, only subsystems that the user has authority on will be shown with data. In such cases, the status will state "User is not authorised to subsystem."

ibmi_image8

Headline legend

Name	Description
system	The IBM i system name.
subsystems	The total number of subsystems in the system.

Table legend

Name	Description
key	Library/name of subsystem. For example, QSYS/QSPL.
name	The name of the subsystem.
library	The name of the library where the subsystem resides.
activeJobs	The number of active jobs in the subsystem.
maxActiveJobs	The maximum number of possible jobs for the subsystem. NO_MAX means no maximum has been set.
pools	The number of storage pools defined for the subsystem.
status	The status of the subsystem. Possible values are: ACTIVE INACTIVE If the user that is utilised by the Netprobe does not have sufficient administrative rights for the subsystem, then 'User is not authorised to subsystem' will be shown in this column.