Job Management Partner 1/Performance Management - Agent Option for Platform Description, User's Guide and Reference

Appendix E.2 Agent Collector service properties

The table below shows the properties of the Agent Collector service of PFM - Agent for Platform.

Table E-2 Properties of the Agent Collector service of PFM - Agent for Platform

Folder name Property name Explanation

-- First Registration Date Shows the first date on which the service was recognized by PFM - Manager.

Last Registration Date Shows the last date on which the service was recognized by PFM - Manager.

Data Model Version Shows the version of the data model.

General -- Stores information such as the host name and folders. The properties stored in this folder cannot be modified.

Directory Shows the name of the current folder in which the service runs.

Host Name Shows the name of the host on which the service runs.

Process ID Shows the process ID of the service.

Physical Address Shows the IP address and port number of the host on which the service runs.

User Name Shows the name of the user who executed the service process.

Time Zone Shows the time zone used by the service.

System -- Stores the OS information of the OS under which the service has been started. The properties stored in this folder cannot be modified.

CPU Type Shows the CPU type.

Hardware ID Shows the hardware ID.

OS Type Shows the OS type.

OS Name Shows the OS name.

OS Version Shows the OS version.

Network Services -- Stores information on the Performance Management communication common library. The properties stored in this folder cannot be modified.

Build Date Shows the Agent Collector service creation date.

INI File Shows the name of the folder storing the jpcns.ini file.

Network Services Service -- Stores information on the service. The properties stored in this folder cannot be modified.

Description Shows additional service information such as the host name and service type.

Local Service Name Shows the service ID.

Remote Service Name Shows the service ID of the Agent Store service to which the Agent Collector service connects.

AH Service Name Shows the service ID of the Action Handler service that is located on the same host.

JP1 Event Configurations -- Sets the condition for issuing JP1 events.

service Yes or No is selected from a list for the Agent Collector service, Agent Store service, Action Handler service, and Status Server service to specify whether to output JP1 system events for each service.

JP1 Event Send Host Specifies the name of the event server to which J1/Base connects. However, only the event server running on the logical host or physical host on the same machine as for the Action Handler service can be specified. From 0 to 255 bytes of alphanumeric characters, periods (.), and hyphens (-) can be specified. If a value outside this range is specified, it is assumed that no value has been specified. If no value is specified, the host on which the Action Handler service is running is used as the host that issues events. If localhost is specified, the physical host is assumed.

Monitoring Console Host Specifies the PFM - Web Console host that is to be started when the PFM - Web Console browser is started by starting the JP1/IM - Manager monitor. From 0 to 255 bytes of alphanumeric characters, periods (.), and hyphens (-). If a value outside this range is specified, it is assumed that no value has been specified. If no value is specified, the PFM - Manager host to be connected is assumed.

Monitoring Console Port Specifies the port number of PFM - Web Console (http request port number) to be started. A value in the range from 1 to 65,535 can be specified. If a value outside this range is specified, it is assumed that no value has been specified. If no value is specified, 20358 is set.

JP1 Event Configurations Alarm JP1 Event Mode Specifies whether a JP1 system event or a JP1 user event is to be issued if the alarm status changes.

JP1 User Event: A JP1 user event is issued.

JP1 System Event: A JP1 system event is issued.

Detail Records -- Stores the properties of PD-type records. The record ID of the record being collected is displayed in bold letters.

Detail Records record-id^#1 -- Stores record properties.

Description Shows record description. This property cannot be modified.

Log Yes or No is selected from a list to specify whether to register records in the Store database. If this value is Yes and the Collection Interval is greater than 0, records are registered in the database.

Collection Interval Specifies the data collection interval. A value in the range from 0 to 2,147,483,647 seconds can be specified in 1-second increments. If 0 is specified, the collection interval is 0 and no data is collected.

Collection Offset Specifies the offset value for starting data collection. A value in the range from 0 to 32,767 seconds can be specified in 1-second increments, but cannot exceed the range specified for Collection Interval. Regardless of the value specified for Collection Offset, the data collection recording time is the same as the value specified for Collection Interval.

LOGIF Specifies the condition for registering records in the database. Only those records satisfying the condition are registered in the database. Displays the conditional expression (character string) created in the LOGIF Expression Setting window, which is displayed by clicking LOGIF on the bottom frame of the Property window of the service that is displayed under the Services tab in PFM - Web Console.

Sync Collection With Synchronizes collection with the record specified in the following format:
Sync Collection With =record-type, record-id
Example: Sync Collection With=Interval Records, PI

Interval Records -- Stores the properties of PI-type records. The record ID of the record being collected is displayed in bold letters.

Interval Records record-id^#1 -- Stores record properties.

Description Shows record description. This property cannot be modified.

Log Yes or No is selected from a list to specify whether to register records in the Store database. If this value is Yes and the Collection Interval is greater than 0, records are registered in the database.

Collection Interval Specifies the data collection interval. A value in the range from 0 to 2,147,483,647 seconds can be specified in 1-second increments. If 0 is specified, the collection interval is 0 and no data is collected.

Collection Offset Specifies the offset value for starting data collection. A value in the range from 0 to 32,767 seconds can be specified in 1-second increments, but cannot exceed the range specified for Collection Interval. Regardless of the value specified for Collection Offset, the data collection recording time is the same as the value specified for Collection Interval.

LOGIF Specifies the condition for registering records in the database. Only those records satisfying the condition are registered in the database. Displays the conditional expression (character string) created in the LOGIF Expression Setting window, which is displayed by clicking LOGIF on the bottom frame of the Property window of the service that is displayed under the Services tab in PFM - Web Console.

Log Records -- Stores the properties of PL-type records. This record is not supported in PFM - Agent for Platform and thus is not used.

Restart Configurations -- Sets the condition for automatically restarting the PFM service. The condition can be set when the version of PFM - Manager or PFM - Base is 09-00 or later. For details about the PFM service Auto-restart functionality, see the chapter explaining the Performance Management functions in the manual Job Management Partner 1/Performance Management Planning and Configuration Guide.

Restart when Abnormal Status Specifies whether to automatically restart the service if the Status Server service cannot correctly obtain the statuses of the Action Handler service, Agent Collector service, and Agent Store service.

Restart when Single Service Running Specifies whether to automatically restart the service if only the Agent Store service or only the Agent Collector service is running.

Restart Configurations Action Handler Auto Restart Specifies whether to use the Auto-restart functionality for the Action Handler service.

Auto Restart - Interval (Minute) Sets the interval in minutes for checking the operating status of the service when the Auto-restart functionality is used.

Auto Restart - Repeat Limit Sets the number of times restart is retried in succession when the Auto-restart functionality is used.

Scheduled Restart Specifies whether to use the scheduled restart functionality for the Action Handler service.

Scheduled Restart - Interval Sets the restart interval when the scheduled restart functionality is used.

Scheduled Restart - Interval Unit Sets the unit of the restart interval when the scheduled restart functionality is used.

Scheduled Restart - Origin - Year The restart year can be specified as an integer in the range from 1971 to 2035.

Scheduled Restart - Origin - Month The restart month can be specified as an integer in the range from 1 to 12.

Scheduled Restart - Origin - Day The restart day can be specified as an integer in the range from 1 to 31.

Scheduled Restart - Origin - Hour The restart time (hour) can be specified as an integer in the range from 0 to 23.

Scheduled Restart - Origin - Minute The restart time (minute) can be specified as an integer in the range from 0 to 59.

Agent Collector Auto Restart Specifies whether to use the Auto-restart functionality for the Agent Collector service.

Auto Restart - Interval (Minute) Sets the interval in minutes for checking the operating status of the service when the Auto-restart functionality is used.

Auto Restart - Repeat Limit Sets the number of times restart is retried in succession when the Auto-restart functionality is used.

Scheduled Restart Specifies whether to use the scheduled restart functionality for the Agent Collector service.

Scheduled Restart - Interval Sets the restart interval when the scheduled restart functionality is used.

Scheduled Restart - Interval Unit Sets the unit of the restart interval when the scheduled restart functionality is used.

Scheduled Restart - Origin - Year The restart year can be specified as an integer in the range from 1971 to 2035.

Scheduled Restart - Origin - Month The restart month can be specified as an integer in the range from 1 to 12.

Scheduled Restart - Origin - Day The restart day can be specified as an integer in the range from 1 to 31.

Scheduled Restart - Origin - Hour The restart time (hour) can be specified as an integer in the range from 0 to 23.

Scheduled Restart - Origin - Minute The restart time (minute) can be specified as an integer in the range from 0 to 59.

Agent Store Auto Restart Specifies whether to use the Auto-restart functionality for the Agent Store service.

Auto Restart - Interval (Minute) Sets the interval in minutes for checking the operating status of the service when the Auto-restart functionality is used.

Auto Restart - Repeat Limit Sets the number of times a restart is retried in succession when the Auto-restart functionality is used.

Scheduled Restart Specifies whether to use the scheduled restart functionality for the Agent Store service.

Scheduled Restart - Interval Sets the restart interval when the scheduled restart functionality is used.

Scheduled Restart - Interval Unit Sets the unit of the restart interval when the scheduled restart functionality is used.

Scheduled Restart - Origin - Year The restart year can be specified as an integer in the range from 1971 to 2035.

Scheduled Restart - Origin - Month The restart month can be specified as an integer in the range from 1 to 12.

Scheduled Restart - Origin - Day The restart day can be specified as an integer in the range from 1 to 31.

Scheduled Restart - Origin - Hour The restart time (hour) can be specified as an integer in the range from 0 to 23.

Scheduled Restart - Origin - Minute The restart time (minute) can be specified as an integer in the range from 0 to 59.

Agent Configuration User Defined Record DataMaxCount Stores the property that defines the maximum number of user records that can be collected.

Application Monitoring Setting instance-name^#2 -- Shows the monitoring instance name that is added.

Process[01-15] Kind^#3 Shows the process type:

None: No process is specified.

Service Name: See the value of the Service Name field of the PD_SVC record.

Command Line: See the value of the Program field of the PD record.

Process[01-15] Name^#3 Enter a process name that does not exceed 127 bytes.

Process[01-15] Range^#3 Enter the upper and lower limits of the number of processes. Insert a hyphen between the limits (for example, 1-2). If a single value without a hyphen is specified, the same value can be specified for the upper and lower limits. For example, when 10 is specified, 10-10 is set. A value in the range from 0 to 65535 can be specified.

ADDITION OR DELETION A SETTING ADD AN APPLICATION MONITORING SETTING Shows the monitoring instance name to be added.

DELETE AN APPLICATION MONITORING SETTING Selects the monitoring instance name to be deleted. Specify None if you do not want to delete a monitoring instance.

User Command Setting user-record-name^#4 Execute Specifies whether to use the function for periodically executing user commands.

Yes: Use.

No: Do not use.

UserCommand Specifies the absolute path for user commands. The maximum length of the string that can be specified for an absolute path is 255 bytes.
Alphanumeric characters and symbols can be specified, except for the following characters:
| < >

Legend:

--: Not applicable

#1

For the folder name, a record ID without a database ID is displayed. For details about record IDs of individual records, see 5. Records.

#2

For the folder name, the instance name set in ADD AN APPLICATION MONITORING SETTING is displayed. For details about how to set the instance name, see 3.2.5 Settings for collecting application operation and non-operation information.

#3

For Process[01-15] Kind, Process[01-15] Name, and Process[01-15] Range, a value in the range from 01 to 15 appears in place of [01-15] in each property name. For example, the property items that are actually displayed will be Process01 Kind, Process07 Name, and Process15 Range.

#4

For the folder name, PD_UPD, PD_UPDB, PI_UPI, or PI_UPIB is displayed.

Folder name	Property name	Explanation
--	First Registration Date	Shows the first date on which the service was recognized by PFM - Manager.
Last Registration Date	Shows the last date on which the service was recognized by PFM - Manager.
Data Model Version	Shows the version of the data model.
General	--	Stores information such as the host name and folders. The properties stored in this folder cannot be modified.
Directory	Shows the name of the current folder in which the service runs.
Host Name	Shows the name of the host on which the service runs.
Process ID	Shows the process ID of the service.
Physical Address	Shows the IP address and port number of the host on which the service runs.
User Name	Shows the name of the user who executed the service process.
Time Zone	Shows the time zone used by the service.
System	--	Stores the OS information of the OS under which the service has been started. The properties stored in this folder cannot be modified.
CPU Type	Shows the CPU type.
Hardware ID	Shows the hardware ID.
OS Type	Shows the OS type.
OS Name	Shows the OS name.
OS Version	Shows the OS version.
Network Services	--	Stores information on the Performance Management communication common library. The properties stored in this folder cannot be modified.
Build Date	Shows the Agent Collector service creation date.
INI File	Shows the name of the folder storing the jpcns.ini file.
Network Services	Service	--	Stores information on the service. The properties stored in this folder cannot be modified.
Description	Shows additional service information such as the host name and service type.
Local Service Name	Shows the service ID.
Remote Service Name	Shows the service ID of the Agent Store service to which the Agent Collector service connects.
AH Service Name	Shows the service ID of the Action Handler service that is located on the same host.
JP1 Event Configurations	--	Sets the condition for issuing JP1 events.
service	Yes or No is selected from a list for the Agent Collector service, Agent Store service, Action Handler service, and Status Server service to specify whether to output JP1 system events for each service.
JP1 Event Send Host	Specifies the name of the event server to which J1/Base connects. However, only the event server running on the logical host or physical host on the same machine as for the Action Handler service can be specified. From 0 to 255 bytes of alphanumeric characters, periods (.), and hyphens (-) can be specified. If a value outside this range is specified, it is assumed that no value has been specified. If no value is specified, the host on which the Action Handler service is running is used as the host that issues events. If localhost is specified, the physical host is assumed.
Monitoring Console Host	Specifies the PFM - Web Console host that is to be started when the PFM - Web Console browser is started by starting the JP1/IM - Manager monitor. From 0 to 255 bytes of alphanumeric characters, periods (.), and hyphens (-). If a value outside this range is specified, it is assumed that no value has been specified. If no value is specified, the PFM - Manager host to be connected is assumed.
Monitoring Console Port	Specifies the port number of PFM - Web Console (http request port number) to be started. A value in the range from 1 to 65,535 can be specified. If a value outside this range is specified, it is assumed that no value has been specified. If no value is specified, 20358 is set.
JP1 Event Configurations	Alarm	JP1 Event Mode	Specifies whether a JP1 system event or a JP1 user event is to be issued if the alarm status changes. JP1 User Event: A JP1 user event is issued. JP1 System Event: A JP1 system event is issued.
Detail Records	--	Stores the properties of PD-type records. The record ID of the record being collected is displayed in bold letters.
Detail Records	record-id^#1	--	Stores record properties.
Description	Shows record description. This property cannot be modified.
Log	Yes or No is selected from a list to specify whether to register records in the Store database. If this value is Yes and the Collection Interval is greater than 0, records are registered in the database.
Collection Interval	Specifies the data collection interval. A value in the range from 0 to 2,147,483,647 seconds can be specified in 1-second increments. If 0 is specified, the collection interval is 0 and no data is collected.
Collection Offset	Specifies the offset value for starting data collection. A value in the range from 0 to 32,767 seconds can be specified in 1-second increments, but cannot exceed the range specified for Collection Interval. Regardless of the value specified for Collection Offset, the data collection recording time is the same as the value specified for Collection Interval.
LOGIF	Specifies the condition for registering records in the database. Only those records satisfying the condition are registered in the database. Displays the conditional expression (character string) created in the LOGIF Expression Setting window, which is displayed by clicking LOGIF on the bottom frame of the Property window of the service that is displayed under the Services tab in PFM - Web Console.
Sync Collection With	Synchronizes collection with the record specified in the following format: Sync Collection With =record-type, record-id Example: Sync Collection With=Interval Records, PI
Interval Records	--	Stores the properties of PI-type records. The record ID of the record being collected is displayed in bold letters.
Interval Records	record-id^#1	--	Stores record properties.
Description	Shows record description. This property cannot be modified.
Log	Yes or No is selected from a list to specify whether to register records in the Store database. If this value is Yes and the Collection Interval is greater than 0, records are registered in the database.
Collection Interval	Specifies the data collection interval. A value in the range from 0 to 2,147,483,647 seconds can be specified in 1-second increments. If 0 is specified, the collection interval is 0 and no data is collected.
Collection Offset	Specifies the offset value for starting data collection. A value in the range from 0 to 32,767 seconds can be specified in 1-second increments, but cannot exceed the range specified for Collection Interval. Regardless of the value specified for Collection Offset, the data collection recording time is the same as the value specified for Collection Interval.
LOGIF	Specifies the condition for registering records in the database. Only those records satisfying the condition are registered in the database. Displays the conditional expression (character string) created in the LOGIF Expression Setting window, which is displayed by clicking LOGIF on the bottom frame of the Property window of the service that is displayed under the Services tab in PFM - Web Console.
Log Records	--	Stores the properties of PL-type records. This record is not supported in PFM - Agent for Platform and thus is not used.
Restart Configurations	--	Sets the condition for automatically restarting the PFM service. The condition can be set when the version of PFM - Manager or PFM - Base is 09-00 or later. For details about the PFM service Auto-restart functionality, see the chapter explaining the Performance Management functions in the manual Job Management Partner 1/Performance Management Planning and Configuration Guide.
Restart when Abnormal Status	Specifies whether to automatically restart the service if the Status Server service cannot correctly obtain the statuses of the Action Handler service, Agent Collector service, and Agent Store service.
Restart when Single Service Running	Specifies whether to automatically restart the service if only the Agent Store service or only the Agent Collector service is running.
Restart Configurations	Action Handler	Auto Restart	Specifies whether to use the Auto-restart functionality for the Action Handler service.
Auto Restart - Interval (Minute)	Sets the interval in minutes for checking the operating status of the service when the Auto-restart functionality is used.
Auto Restart - Repeat Limit	Sets the number of times restart is retried in succession when the Auto-restart functionality is used.
Scheduled Restart	Specifies whether to use the scheduled restart functionality for the Action Handler service.
Scheduled Restart - Interval	Sets the restart interval when the scheduled restart functionality is used.
Scheduled Restart - Interval Unit	Sets the unit of the restart interval when the scheduled restart functionality is used.
Scheduled Restart - Origin - Year	The restart year can be specified as an integer in the range from 1971 to 2035.
Scheduled Restart - Origin - Month	The restart month can be specified as an integer in the range from 1 to 12.
Scheduled Restart - Origin - Day	The restart day can be specified as an integer in the range from 1 to 31.
Scheduled Restart - Origin - Hour	The restart time (hour) can be specified as an integer in the range from 0 to 23.
Scheduled Restart - Origin - Minute	The restart time (minute) can be specified as an integer in the range from 0 to 59.
Agent Collector	Auto Restart	Specifies whether to use the Auto-restart functionality for the Agent Collector service.
Auto Restart - Interval (Minute)	Sets the interval in minutes for checking the operating status of the service when the Auto-restart functionality is used.
Auto Restart - Repeat Limit	Sets the number of times restart is retried in succession when the Auto-restart functionality is used.
Scheduled Restart	Specifies whether to use the scheduled restart functionality for the Agent Collector service.
Scheduled Restart - Interval	Sets the restart interval when the scheduled restart functionality is used.
Scheduled Restart - Interval Unit	Sets the unit of the restart interval when the scheduled restart functionality is used.
Scheduled Restart - Origin - Year	The restart year can be specified as an integer in the range from 1971 to 2035.
Scheduled Restart - Origin - Month	The restart month can be specified as an integer in the range from 1 to 12.
Scheduled Restart - Origin - Day	The restart day can be specified as an integer in the range from 1 to 31.
Scheduled Restart - Origin - Hour	The restart time (hour) can be specified as an integer in the range from 0 to 23.
Scheduled Restart - Origin - Minute	The restart time (minute) can be specified as an integer in the range from 0 to 59.
Agent Store	Auto Restart	Specifies whether to use the Auto-restart functionality for the Agent Store service.
Auto Restart - Interval (Minute)	Sets the interval in minutes for checking the operating status of the service when the Auto-restart functionality is used.
Auto Restart - Repeat Limit	Sets the number of times a restart is retried in succession when the Auto-restart functionality is used.
Scheduled Restart	Specifies whether to use the scheduled restart functionality for the Agent Store service.
Scheduled Restart - Interval	Sets the restart interval when the scheduled restart functionality is used.
Scheduled Restart - Interval Unit	Sets the unit of the restart interval when the scheduled restart functionality is used.
Scheduled Restart - Origin - Year	The restart year can be specified as an integer in the range from 1971 to 2035.
Scheduled Restart - Origin - Month	The restart month can be specified as an integer in the range from 1 to 12.
Scheduled Restart - Origin - Day	The restart day can be specified as an integer in the range from 1 to 31.
Scheduled Restart - Origin - Hour	The restart time (hour) can be specified as an integer in the range from 0 to 23.
Scheduled Restart - Origin - Minute	The restart time (minute) can be specified as an integer in the range from 0 to 59.
Agent Configuration	User Defined Record DataMaxCount	Stores the property that defines the maximum number of user records that can be collected.
Application Monitoring Setting	instance-name^#2	--	Shows the monitoring instance name that is added.
Process[01-15] Kind^#3	Shows the process type: None: No process is specified. Service Name: See the value of the Service Name field of the PD_SVC record. Command Line: See the value of the Program field of the PD record.
Process[01-15] Name^#3	Enter a process name that does not exceed 127 bytes.
Process[01-15] Range^#3	Enter the upper and lower limits of the number of processes. Insert a hyphen between the limits (for example, 1-2). If a single value without a hyphen is specified, the same value can be specified for the upper and lower limits. For example, when 10 is specified, 10-10 is set. A value in the range from 0 to 65535 can be specified.
ADDITION OR DELETION A SETTING	ADD AN APPLICATION MONITORING SETTING	Shows the monitoring instance name to be added.
DELETE AN APPLICATION MONITORING SETTING	Selects the monitoring instance name to be deleted. Specify None if you do not want to delete a monitoring instance.
User Command Setting	user-record-name^#4	Execute	Specifies whether to use the function for periodically executing user commands. Yes: Use. No: Do not use.
UserCommand	Specifies the absolute path for user commands. The maximum length of the string that can be specified for an absolute path is 255 bytes. Alphanumeric characters and symbols can be specified, except for the following characters: \| < >

[Contents][Back][Next]

[Trademarks]