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 nameProperty nameExplanation
--First Registration DateShows the first date on which the service was recognized by PFM - Manager.
Last Registration DateShows the last date on which the service was recognized by PFM - Manager.
Data Model VersionShows 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.
DirectoryShows the name of the current folder in which the service runs.
Host NameShows the name of the host on which the service runs.
Process IDShows the process ID of the service.
Physical AddressIf the IPv6 communication functionality is disabled, this property shows the IP address and port number of the host on which the service runs.
Physical Address (IPv4)If the IPv6 communication functionality is enabled, this property shows the IP address (IPv4) of the host on which the service runs.
Physical Address (IPv6)If the IPv6 communication functionality is enabled, this property shows the IP address (IPv6) of the host on which the service runs.
Port NumberIf the IPv6 communication functionality is enabled, this property shows the port number of the host on which the service runs.
User NameShows the name of the user who executed the service process.
Time ZoneShows 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 TypeShows the CPU type.
Hardware IDShows the hardware ID.
OS TypeShows the OS type.
OS NameShows the OS name.
OS VersionShows the OS version.
Network Services--Stores information on the Performance Management communication common library. The properties stored in this folder cannot be modified.
Build DateShows the Agent Collector service creation date.
INI FileShows the name of the folder storing the jpcns.ini file.
Network ServicesService--Stores information on the service. The properties stored in this folder cannot be modified.
DescriptionShows additional service information such as the host name and service type.
Local Service NameShows the service ID.
Remote Service NameShows the service ID of the Agent Store service to which the Agent Collector service connects.
AH Service NameShows 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.
serviceYes 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 HostSpecifies 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 HostSpecifies the PFM - Web Console host that is to be started when the PFM - Web Console 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 PortSpecifies 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 ConfigurationsAlarmJP1 Event ModeSpecifies which of the following events is issued when 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 Recordsrecord-id#1--Stores record properties.
DescriptionShows record description. This property cannot be modified.
LogYes 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.
Log (ITSLM)If there is a link to JP1/ITSLM - Manager, this property displays Yes or No indicating whether records from JP1/ITSLM - Manager are to be registered in the Store database of PFM - Agent Platform. If there is no linkage, this value is fixed to No. This property cannot be changed.
Monitoring (ITSLM)If there is a link to JP1/ITSLM - Manager, a setting in JP1/ITSLM - Manager displays Yes or No indicating whether records are to be sent to JP1/ITSLM - Manager. If there is no linkage, this value is fixed to No. This property cannot be changed.
Collection Interval#2Specifies 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#2Specifies 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.
LOGIFSpecifies 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 WithSynchronizes 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 Recordsrecord-id#1--Stores record properties.
DescriptionShows record description. This property cannot be modified.
LogYes 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.
Log (ITSLM)If there is a link to JP1/ITSLM - Manager, this property displays Yes or No indicating whether records from JP1/ITSLM - Manager are to be registered in the Store database of PFM - Agent Platform. If there is no linkage, this value is fixed to No. This property cannot be changed.
Monitoring (ITSLM)If there is a link to JP1/ITSLM - Manager, a setting in JP1/ITSLM - Manager displays Yes or No indicating whether records are to be sent to JP1/ITSLM - Manager. If there is no linkage, this value is fixed to No. This property cannot be changed.
Collection IntervalSpecifies 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 OffsetSpecifies 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.
LOGIFSpecifies 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 Job Management Partner 1/Performance Management Planning and Configuration Guide.
Restart when Abnormal StatusSpecifies 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 RunningSpecifies whether to automatically restart the service if only the Agent Store service or only the Agent Collector service is running.
Restart ConfigurationsAction HandlerAuto RestartSpecifies 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. A value in the range from 1 to 1,440 minutes can be set in 1-minute increments.
Auto Restart - Repeat LimitSets (as an integer from 1 to 10) the number of times in succession a restart is to be attempted when the Auto-restart functionality is used.
Scheduled RestartYes or No is selected from a list to specify whether to use the scheduled restart functionality for the Action Handler service.
Scheduled Restart - IntervalSets (as an integer from 1 to 1000) the restart interval when the scheduled restart functionality is used.
Scheduled Restart - Interval UnitWhen the scheduled restart functionality is used, sets the unit of the restart interval to Hour, Day, Week, or Month, as selected from a list.
Scheduled Restart - Origin - YearThe restart year can be specified as an integer in the range from 1971 to 2035.
Scheduled Restart - Origin - MonthThe restart month can be specified as an integer in the range from 1 to 12.
Scheduled Restart - Origin - DayThe restart day can be specified as an integer in the range from 1 to 31.
Scheduled Restart - Origin - HourThe restart time (hour) can be specified as an integer in the range from 0 to 23.
Scheduled Restart - Origin - MinuteThe restart time (minute) can be specified as an integer in the range from 0 to 59.
Agent CollectorAuto RestartSpecifies 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. A value in the range from 1 to 1,440 minutes can be set in 1-minute increments.
Auto Restart - Repeat LimitSets (as an integer from 1 to 10) the number of times in succession a restart is to be attempted when the Auto-restart functionality is used.
Scheduled RestartYes or No is selected from a list to specify whether the scheduled restart functionality for the Agent Collector service is to be used.
Scheduled Restart - IntervalSets (as an integer from 1 to 1000) the restart interval when the scheduled restart functionality is used.
Scheduled Restart - Interval UnitWhen the scheduled restart functionality is used, sets the unit of the restart interval to Hour, Day, Week, or Month, as selected from a list.
Scheduled Restart - Origin - YearThe restart year can be specified as an integer in the range from 1971 to 2035.
Scheduled Restart - Origin - MonthThe restart month can be specified as an integer in the range from 1 to 12.
Scheduled Restart - Origin - DayThe restart day can be specified as an integer in the range from 1 to 31.
Scheduled Restart - Origin - HourThe restart time (hour) can be specified as an integer in the range from 0 to 23.
Scheduled Restart - Origin - MinuteThe restart time (minute) can be specified as an integer in the range from 0 to 59.
Agent StoreAuto RestartSpecifies 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. A value in the range from 1 to 1,440 minutes can be set in 1-minute increments.
Auto Restart - Repeat LimitSets (as an integer from 1 to 10) the number of times in succession a restart is to be attempted when the Auto-restart functionality is used.
Scheduled RestartYes or No is selected from a list to specify whether the scheduled restart functionality for the Agent Store service is to be used.
Scheduled Restart - IntervalSets (as an integer from 1 to 1000) the restart interval when the scheduled restart functionality is used.
Scheduled Restart - Interval UnitWhen the scheduled restart functionality is used, sets the unit of the restart interval to Hour, Day, Week, or Month, as selected from a list.
Scheduled Restart - Origin - YearThe restart year can be specified as an integer in the range from 1971 to 2035.
Scheduled Restart - Origin - MonthThe restart month can be specified as an integer in the range from 1 to 12.
Scheduled Restart - Origin - DayThe restart day can be specified as an integer in the range from 1 to 31.
Scheduled Restart - Origin - HourThe restart time (hour) can be specified as an integer in the range from 0 to 23.
Scheduled Restart - Origin - MinuteThe restart time (minute) can be specified as an integer in the range from 0 to 59.
ITSLM Connection Configuration--Shows information about the connection to the JP1/ITSLM - Manager.
ITSLM Connection ConfigurationITSLM Connection--Shows information about the JP1/ITSLM - Manager connection destination.
ITSLM HostShows the host name of the connected JP1/ITSLM - Manager. If there is no connection to JP1/ITSLM - Manager, this property is not shown.
ITSLM PortShows the port number of the connected JP1/ITSLM - Manager. If there is no connection to JP1/ITSLM - Manager, this property is not shown.
MANAGE ITSLM CONNECTION--Sets whether to stop the connection to JP1/ITSLM - Manager.
DISCONNECT ITSLM CONNECTIONSpecifies from a list of items the host name of the JP1/ITSLM - Manager to disconnect from. If you specify the empty string from the list, nothing happens. If there is no connection to JP1/ITSLM - Manager, the list shows only the empty string.
Agent ConfigurationUser Defined Record DataMaxCountStores the property that defines the maximum number of user records that can be collected.
Application Monitoring Settinginstance-name#3--Shows the monitoring instance name that is added.
Process[01-15] Kind#4Shows 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#4Enter a process name that does not exceed 127 bytes.
Process[01-15] Range#4Enter 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 SETTINGADD AN APPLICATION MONITORING SETTINGShows the monitoring instance name to be added.
DELETE AN APPLICATION MONITORING SETTINGSelects the monitoring instance name to be deleted. Specify None if you do not want to delete a monitoring instance.
Advanced application monitoring--Specifies settings for collecting information about the operating status of processes.
Advanced application monitoringApplication monitoring settingCase SensitiveSpecifies whether to distinguish letter-case in comparisons to monitoring conditions.
  • Yes: Case sensitive
  • No: Not case sensitive
Application monitoring settingapplication-name#5--The name of an added application.
Monitoring[01-15] Label#6Specifies a name of no more than 31 bytes for identifying the monitoring condition.
Monitoring[01-15] is set by default. If nothing is specified, Monitoring[01-15] is set.
The value specified for this property must be unique.
Monitoring[01-15] Field#6The field to be monitored.
  • None: No field specified.
  • Program Name: See the Program Name field of the PD_APS record.
  • Command Line: See the Command Line field of the PD_APS record.
  • Service Name: See the Service Name field of the PD_ASVC record.
The default is None.
Monitoring[01-15] Condition#6Specifies the monitoring condition (as a maximum of 4,096 bytes).
The default is one space.
Monitoring[01-15] Range#6Specifies the minimum and maximum thresholds for the monitoring count, connected by a hyphen (-) (for example, 1-2). You can specify values in the range from 0 to 65535.
ADDITION OR DELETION A SETTINGADD AN APPLICATION MONITORING SETTINGSpecifies the name of an application to be added (as a maximum of 63 bytes).
The value specified for this property must be unique.
DELETE AN APPLICATION MONITORING SETTINGSelects the name of an application to be deleted. The default is that no application names are shown.
User Command Settinguser-record-name#7ExecuteSpecifies whether to use the function for periodically executing user commands.
  • Yes: Use.
  • No: Do not use.
UserCommandSpecifies 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 7. Records.
#2
If Sync Collection With is displayed, neither Collection Interval nor Collection Offset is displayed.
#3
The instance name set in ADD AN APPLICATION MONITORING SETTING in ADDITION OR DELETION A SETTING is displayed for the folder name. For details about how to set the instance name, see 5.7 Settings for collecting information about the application operating status.
#4
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.
#5
The application name set in the property ADD AN APPLICATION MONITORING SETTING in Advanced Application Monitoring > ADDITION OR DELETION A SETTING is displayed for the folder name.
#6
In Monitoring[01-15] Label, Monitoring[01-15] Field, Monitoring[01-15] Condition, and Monitoring[01-15] Range, a value in the range from 01 and 15 is set for [01-15] in each property name. Examples of the property items that are actually displayed include Monitoring01 Label, Monitoring06 Field, Monitoring10 Condition, and Monitoring15 Range.
#7
PD_UPD, PD_UPDB, PI_UPI, or PI_UPIB is displayed for the folder name.