Hitachi

JP1 Version 11 JP1/Performance Management - Agent Option for Service Response Description, User's Guide and Reference


E.2 Agent Collector service properties

The following table lists the properties of the Agent Collector service of PFM - Agent for Service Response.

Table E‒2: Properties of the Agent Collector service of PFM - Agent for Service Response

Folder name

Property name

Description

--

First Registration Date

Displays the first date and time the service was recognized by PFM - Manager.

Last Registration Date

Displays the most recent date and time the service was recognized by PFM - Manager.

Data Model Version

Displays the version of the data model.

General

--

Stores information such as host names and folders. You cannot change properties stored in this folder.

Directory

Displays the name of the current folder where the service is running.

Host Name

Displays the name of the physical host where the service is running.

Process ID

Displays the service's process ID.

Physical Address

If the IPv6 communication function is disabled, displays the IP address and port number of the host where the service is running.

Physical Address(IPv4)

If the IPv6 communication function is enabled, displays the IP address (IPv4) of the host where the service is running.

Physical Address(IPv6)

If the IPv6 communication function is enabled, displays the IP address (IPv6) of the host where the service is running.

Port Number

If the IPv6 communication function is enabled, displays the port number of the host where the service is running.

User Name

Displays the name of the user who executed the service process.

Time Zone

Displays the time zone in which the service is used.

System

--

Stores information about the operating system where the service is running. You cannot change properties stored in this folder.

CPU Type

Displays the CPU type.

Hardware ID

Displays the hardware ID.

OS Type

Displays the type of operating system.

OS Name

Displays the name of the operating system.

OS Version

Displays the version of the operating system.

Network Services

--

Stores information about the Performance Management communication common library. You cannot change properties stored in this folder.

Build Date

Displays the creation date of the Agent Store service.

INI File

Displays the name of the directory containing the jpcns.ini file.

Network Services

Service

--

Stores information about the service. You cannot change properties stored in this folder.

Description

Displays additional service information, such as host name and service type.

Local Service Name

Displays the service ID.

Remote Service Name

Displays the service ID of the Agent Store service to which the Agent Collector service connects.

AH Service Name

Displays the service ID of the Action Handler service 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 JP1/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 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.

Monitoring Console Https

Specifies whether to use HTTPS-encrypted communication to access PFM - Web Console when PFM - Web Console is started by JP1/IM - Manager monitor startup. By default, this property is set to No.

  • Yes: Use encrypted communication.

  • No: Do not use encrypted communication.

JP1 Event Configurations

Alarm

JP1 Event Mode

Specifies which of the following events 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 records of the PD record type. The record IDs of the collected records are displayed in boldface type.

Detail Records

record-ID#1

--

Stores the properties of a record.

Description

Displays a description of the record. You cannot change this property.

Log

Select Yes or No from the list to specify whether or not the record is to be logged into (stored in) the Store database. If this value is set to Yes and Collection Interval is set to a value greater than 0, the record is logged into the database.

Log(ITSLM)

Displays Yes or No to indicate whether JP1/SLM - Manager logs the record into the Store database of PFM - Agent for Service Response when JP1/SLM - Manager is linked. If JP1/SLM - Manager is not linked, No is always displayed. You cannot change this property.

Monitoring(ITSLM)

Displays Yes or No for the JP1/SLM - Manager setting to indicate whether the record is to be sent to JP1/SLM - Manager when JP1/SLM - Manager is linked. If JP1/SLM - Manager is not linked, No is always displayed. You cannot change this property.

Collection Interval

Specifies the data collection interval. You can specify a value in the range from 0 to 2,147,483,647 seconds (inclusive) in increments of 1. If you specify 0 for the property, 0 seconds is assumed, in which case no data is collected.

Collection Offset

Specifies the offset value (in seconds) for starting data collection. The specified value must not exceed the value specified for Collection Interval, and must be in the range from 0 to 32,767 seconds (inclusive). The storage time for data collection does not depend on the Collection Offset value, and is the same time as the Collection Interval.

Over 10 Sec Collection Time

This property is only displayed if collection of historical data takes precedence over the display processing of real-time reports (if the functionality that prioritizes the collection of historical data is enabled). Whether record collection might require 10 seconds or more is indicated by Yes or No.

  • Yes: Might require 10 seconds or more.

  • No: Does not require 10 seconds.

The value of this property cannot be changed.

Realtime Report Data Collection Mode

This property is only displayed if collection of historical data takes precedence over the display processing of real-time reports (if the functionality that prioritizes the collection of historical data is enabled). Specifies the display mode of the real-time report.

  • Reschedule: Reschedule mode

  • Temporary Log: Temporary save mode

Note that temporary save mode (Temporary Log) must be specified for records whose Over 10 Sec Collection Time value is Yes.

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.

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.

Interval Records

--

Stores the properties of records of the PI record type. The record IDs of the collected records are displayed in boldface type.

Interval Records

record-ID#1

--

Stores the properties of a record.

Description

Displays a description of the record. You cannot change this property.

Log

Select Yes or No from the list to specify whether or not the record is to be logged into (stored in) the Store database. If this value is set to Yes and Collection Interval is set to a value greater than 0, the record is logged into the database.

Log(ITSLM)

Displays Yes or No to indicate whether JP1/SLM - Manager logs the record into the Store database of PFM - Agent for Service Response when JP1/SLM - Manager is linked. If JP1/SLM - Manager is not linked, No is always displayed. You cannot change this property.

Monitoring(ITSLM)

Displays Yes or No for the JP1/SLM - Manager setting to indicate whether the record is to be sent to JP1/SLM - Manager when JP1/SLM - Manager is linked. If JP1/SLM - Manager is not linked, No is always displayed. You cannot change this property.

Collection Interval

Specifies the data collection interval. You can specify a value in the range from 0 to 2,147,483,647 seconds (inclusive) in increments of 1. If you specify 0 for the property, 0 seconds is assumed, in which case no data is collected.

Collection Offset

Specifies the offset value (in seconds) for starting data collection. The specified value must not exceed the value specified for Collection Interval, and must be in the range from 0 to 32,767 seconds (inclusive). The storage time for data collection does not depend on the Collection Offset value, and is the same time as the Collection Interval.

Over 10 Sec Collection Time

This property is only displayed if collection of historical data takes precedence over the display processing of real-time reports (if the functionality that prioritizes the collection of historical data is enabled).#2 Whether record collection might require 10 seconds or more is indicated by Yes or No.

  • Yes: Might require 10 seconds or more.

  • No: Does not require 10 seconds.

The value of this property cannot be changed.

Realtime Report Data Collection Mode

This property is only displayed if collection of historical data takes precedence over the display processing of real-time reports (if the functionality that prioritizes the collection of historical data is enabled).#2 Specifies the display mode of the real-time report.

  • Reschedule: Reschedule mode

  • Temporary Log: Temporary save mode

Note that temporary save mode (Temporary Log) must be specified for records whose Over 10 Sec Collection Time value is Yes.

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

Description

Displays a description of the record. You cannot change this property.

Log

Select Yes or No from the list to specify whether or not the record is to be logged into (stored in) the Store database. If this value is set to Yes and Collection Interval is set to a value greater than 0, the record is logged into the database.

Collection Interval

Specifies the data collection interval. You can specify a value in the range from 0 to 2,147,483,647 seconds (inclusive) in increments of 1. If you specify 0 for the property, 0 seconds is assumed, in which case no data is collected.

Collection Offset

Specifies the offset value (in seconds) for starting data collection. The specified value must not exceed the value specified for Collection Interval, and must be in the range from 0 to 32,767 seconds (inclusive). The storage time for data collection does not depend on the Collection Offset value, and is the same time as the 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.

Agent Configuration

--

Stores the properties of the records for the settings of the data interpolation and the probe.

Agent Configuration

Agent

--

Stores the properties of records for the data interpolation.

Data Interpolation

Select Yes or No from the list to specify whether or not you use the last stored data to interpolate data when the performance data is not stored. If this value is Yes, the last stored data is interpolated when the performance data is not stored.

Probe

--

Stores the properties of records for setting the probe.

Use Probe

Select Yes or No from the list to specify whether or not the Probe Daemon is to start when the Agent Collector service starts. If this value is Yes, the Probe Daemon is to start when the Agent Collector service starts. If this value is No, the Probe Daemon is not to start when the Agent Collector service starts.

If this value is set to Yes and the Probe Daemon is stopped, the Probe Daemon is starting. If this value is set to No and the Probe Daemon is started, the Probe Daemon is stopping.

Reload

Select Yes or No from the list to specify whether or not the measurement condition registration file is to be reloaded. If this value is set to Yes, the measurement condition registration file is reloaded.

Probe Status

Displays the status of the Probe Daemon, and one of the following values can be displayed:

  • Active

    The Probe Daemon is started or stopping.

  • Inactive

    The Probe Daemon is stopped or starting.

  • Unknown

    Failure to collect the Probe Daemon status.

  • Reloading

    The Probe Daemon is reloading.

IE Probe Status

Displays the status of the IE Probe Daemon, and one of the following values can be specified:

  • Active

    The IE Probe Daemon is started or stopping.

  • Inactive

    The IE Probe Daemon is stopped or starting.

  • Unknown

    Failure to collect the IE Probe Daemon status.

  • Reloading

    The IE Probe Daemon is stopped or starting.

Initial

Displays the number of the tasks which are added but whose properties are not specified.

Invalid

Displays the number of the tasks one or more of whose property values are invalid.

Valid

Displays the number of the tasks one or more of whose properties are updated. To apply the changes, the measurement condition registration file must be reloaded.

Deleted

Displays the number of the deleted tasks. To apply the changes, the measurement condition registration file must be reloaded.

Applied

Displays the number of the registered tasks in the measurement condition registration file.

Probe\Task List#2

--

Stores the properties of records for the measurement conditions.

Probe\ADD OR DELETE A TASK#3

--

Stores the properties of the records for the settings to add or delete the measurement conditions.

New Task ID

Specifies the measurement condition ID.

New Task Protocol

Select one of the following protocols from the list to create a new task:

  • HTTP

  • HTTPS

  • SMTP

  • POP3

  • IMAP4

  • DNS

  • DHCP

  • FTP

  • TCP

  • WEBTRANS

  • USERSERV

Delete A Task

Specifies the task to be deleted; otherwise, specifies None.

Reserved

Reserved record. Not available for use.

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 JP1/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)

Specifies the interval for checking the operating status of the service when Auto-restart is used. You can specify a value in the range from 1 to 1,440 minutes (inclusive) in increments of 1.

Auto Restart - Repeat Limit

Specifies the number of times a restart is retried in succession when Auto-restart is used. You can specify an integer in the range from 1 to 10.

Scheduled Restart

Select Yes or No from the list to specify whether to use Scheduled restart for the Action Handler service.

Scheduled Restart - Interval

Sets the restart interval as an integer in the range from 1 to 1,000 when Scheduled restart is used.

Scheduled Restart - Interval Unit

Select Hour, Day, Week, or Month from the list as the unit of the restart interval when Scheduled restart 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)

Specifies the interval for checking the operating status of the service when Auto-restart is used. You can specify a value in the range from 1 to 1,440 minutes (inclusive) in increments of 1.

Auto Restart - Repeat Limit

Specifies the number of times a restart is retried in succession when Auto-restart is used. You can specify an integer in the range from 1 to 10.

Scheduled Restart

Select Yes or No from the list to specify whether to use Scheduled restart for the Agent Collector service.

Scheduled Restart - Interval

Sets the restart interval as an integer in the range from 1 to 1,000 when Scheduled restart is used.

Scheduled Restart - Interval Unit

Select Hour, Day, Week, or Month from the list as the unit of the restart interval when Scheduled restart 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)

Specifies the interval for checking the operating status of the service when Auto-restart is used. You can specify a value in the range from 1 to 1,440 minutes (inclusive) in increments of 1.

Auto Restart - Repeat Limit

Specifies the number of times a restart is retried in succession when Auto-restart is used. You can specify an integer in the range from 1 to 10.

Scheduled Restart

Select Yes or No from the list to specify whether to use Scheduled restart for the Agent Store service.

Scheduled Restart - Interval

Sets the restart interval as an integer in the range from 1 to 1,000 when Scheduled restart is used.

Scheduled Restart - Interval Unit

Select Hour, Day, Week, or Month from the list as the unit of the restart interval when Scheduled restart 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.

ITSLM Connection Configuration

--

Displays information about the linked JP1/SLM - Manager.

ITSLM Connection Configuration

ITSLM Connection

--

Displays information about the connection-target JP1/SLM - Manager.

ITSLM Host

Displays the host name of the connected JP1/SLM - Manager. This property is displayed only when JP1/SLM - Manager is connected.

ITSLM Port

Displays the port number of the connected JP1/SLM - Manager. This property is displayed only when JP1/SLM - Manager is connected.

MANAGE ITSLM CONNECTION

--

Specifies whether to disconnect JP1/SLM - Manager.

DISCONNECT ITSLM CONNECTION

From the list, select the host name of the JP1/SLM - Manager to be disconnected. If (empty string) is selected in the list, the system performs no action. If JP1/SLM - Manager is not connected, the list contains only (empty string).

Multiple Manager Configuration

Primary Manager

Displays the host name of the manager specified as the primary manager for multiple monitoring. This property cannot be changed.

Secondary Manager

Displays the host name of the manager specified as the secondary manager for multiple monitoring. This property cannot be changed.

Legend:

--: Not applicable

#1

The folder name shows the record ID without the database ID. For details about the record ID of each record, see 10. Records.

#2

This Probe\Task List means that the Task List folder is under the Probe folder. For details about the properties stored in this folder, see Table E-3.

#3

This Probe\ADD OR DELETE A TASK means that the ADD OR DELETE A TASK folder is under the Probe folder. For details about the properties stored in this folder, see Table E-3.

The properties of measurement condition for the Agent Collector service of PFM - Agent for Service Response are stored in the \Agent Configuration\Probe\Task List folder.

The following table lists the properties of the measurement condition:

Table E‒3: Properties of the measurement condition

Folder name#1

Property name

XML tag#2

Description

service-name _[0-9]+

--

--

service-name displays any one of the following services: HTTP, HTTPS, SMTP, POP3, IMAP4, DNS, DHCP, FTP, TCP, WEBTRANS or USERSERV services.

Task ID, Status, Task Label, Interval and Timeout properties are the common properties, regardless of the type of the measurement services.#1

Task ID

<TASKID>

Displays the measurement condition ID.

Status

--

As the setting status of the task's status property and the apply status of the Probe Daemon, display the following statuses:

  • Applied

    The status that the settings are applied to the Probe Daemon.

  • Deleted

    The status that the settings are deleted, but are not applied to the Probe Daemon.

  • Initial

    The status between the time a task is newly created and the time you click the OK button for the first time.

  • Invalid

    The status that the properties with the invalid values exist. The property names with the invalid values are separated by comma (,), surrounded by brackets ([]), and displayed after the "Invalid".

  • Valid

    The status that all the necessary properties are properly input but the settings are not applied to the Probe Daemon.

Task Label

<TASKLABEL>

Specifies a label name if you give any label name to the task. Hitachi recommends that the name is unique among the other task labels in the other measurement conditions.

The label names are stored in the Measurement Condition Name field in each record. You cannot use the comma (,) and double quotation mark (") to specify the label names. PFM - Web Console 08-50 or later supports Japanese (multibyte character sets) in a Japanese environment or Chinese (multibyte character sets, except for 4-byte characters) in a Chinese environment.

If no value is specified, the value specified in the measurement condition label definition file is assumed to be the task label. In this case, the task label cannot be checked as the properties.

Interval

<INTERVAL>

Specifies the interval time in seconds when measuring repeatedly. None is set by default. Specifies the value that is greater than the value of the Timeout property (timeout value).

Timeout

<TIMEOUT>

Specifies the maximum amount of time in seconds within which a single measurement must be completed.

Specifies the value that is smaller than the value of the Interval property.

HTTP_[0-9]+

--

--

Stores the properties for measuring the HTTP service.

URL#3

<URL>

Specifies the URL of the measuring target Web page up to 255-byte characters. None is set by default.

The protocol identifier (http://) is not included. The port number can be omitted. If the port number is omitted, the port number 80 is used.

Method

<POST>#4

Displays the request method. The default value is GET. You cannot use PFM - Web Console to change this value. As a result, if you use the POST method, edit the measurement condition registration file directly or define the measurement condition as a Web transaction.

PFM - Web Console cannot display a character string to be sent as the massage body (specified as the value of the <MESSAGE_BODY> tag in the measurement condition registration file) using the POST method. If the <MESSAGE_BODY> tag is specified in the measurement condition registration file, the specified value is not checked.

Depth

<DEPTH>

Specifies the depth of embedded resources and frames to be acquired within the range from 1 to 100 bytes. This is the depth of the resources and frames in the Web page that are to be downloaded. The following shows examples:

DEPTH=1 is specified:

Only the Web page is downloaded.

DEPTH=2 is specified:

The Web page and the resources and frames embedded in the page are downloaded.

3 or a greater value is specified in DEPTH:

The Web page, the resources and frames embedded in the page, and the information embedded in the acquired frames (such as the resources and frames embedded in the downloaded frames) are downloaded up to the specified depth. If nothing is embedded in an acquired frame, no more acquisition is performed.

For details about embedded resources and frames, see HTTP in 10. Records.

Web Auth

<WEB_AUTH>

Select Yes or No from the list to specify whether or not Web authentication is to be performed.

Web Username

<WEB_USERNAME>

Specifies the user name to be used for Web authentication by character string up to 64 bytes. None is set by default.

If the value of the Web Auth property is Yes, this value must be specified. If the value of the Web Auth property is No, this value is not applicable.

Proxy

<PROXY>

Select Yes or No from the list to specify whether or not a proxy is to be used.

Proxy Hostname#5

<PROXY_HOSTNAME>

Specifies the proxy server's host name or IP address by character string up to 255 bytes. None is set by default.

If the value of the Proxy property is Yes, this value must be specified. If the value of the Proxy property is No, this value is not applicable.

Proxy Port

<PROXY_PORT>

Specifies the proxy server's port number in the range from 1 to 65,535. None is set by default.

If the value of the Proxy property is Yes, this value must be specified. If the value of the Proxy property is No, this value is not applicable.

Proxy Auth

--

Select Yes or No from the list to specify whether or not proxy authentication is to be used.

If the value of the Proxy property is No, this value is not applicable.

Proxy Username

<PROXY_USERNAME>

Specifies the user name to be used for proxy authentication by character string up to 64 bytes. None is set by default.

If the value of the Proxy Auth property is Yes, this value must be specified. If the value of the Proxy Auth property is No, this value is not applicable.

HTTPS_[0-9]+#6

--

--

Stores the properties for measuring HTTPS service.

URL

<URL>

Specifies the URL of the measuring target Web page by using a character string of 255 or fewer bytes. None is set by default.

The protocol identifier (https://) is not included. The port number can be omitted. If the port number is omitted, port 80 is used.

Method

<POST>#4

Displays the request method. The default value is GET. You cannot use PFM - Web Console to change this value. As a result, if you use the POST method, edit the measurement condition registration file directly or define the measurement condition as a Web transaction.

PFM - Web Console cannot display a character string to be sent as the message body using the POST method.

Depth

<DEPTH>

Specifies the depth of embedded resources and frames to be acquired by using a number in the range from 1 to 100. This is the depth of the resources and frames in the Web page that are to be downloaded. The following shows examples.

DEPTH=1 is specified:

Only the Web page is downloaded.

DEPTH=2 is specified:

The Web page and the resources and frames embedded in the page are downloaded.

3 or a greater value is specified in DEPTH:

The Web page, the resources and frames embedded in the page, and the information embedded in the acquired frames (such as the resources and frames embedded in the downloaded frames) are downloaded up to the specified depth. If nothing is embedded in an acquired frame, no more acquisition is performed.

For details about embedded resources and frames, see HTTPS in 10. Records.

Web Auth

<WEB_AUTH>

Select Yes or No from the list to specify whether or not Web authentication is to be performed.

Web Username

<WEB_USERNAME>

Specifies the user name to be used for Web authentication by using a character string of 64 or fewer bytes. None is set by default.

This property must be specified if the value of the Web Auth property is Yes. This property is not applicable if the value of the Web Auth property is No.

Proxy

<PROXY>

Select Yes or No from the list to specify whether or not a proxy is to be used.

Proxy Hostname

<PROXY_HOSTNAME>

Specifies the proxy server's host name or IP address by using a character string of 255 or fewer bytes. None is set by default.

This property must be specified if the value of the Proxy property is Yes. This property is not applicable if the value of the Proxy property is No.

Proxy Port

<PROXY_PORT>

Specifies the proxy server's port number in the range from 1 to 65,535. None is set by default.

This property must be specified if the value of the Proxy property is Yes. This property is not applicable if the value of the Proxy property is No.

Proxy Auth

--

Select Yes or No from the list to specify whether or not proxy authentication is to be used.

This property is not applicable if the value of the Proxy property is No.

Proxy Username

<PROXY_USERNAME>

Specifies the user name to be used for proxy authentication by using a character string of 64 or fewer bytes. None is set by default.

This property must be specified if the value of the Proxy Auth property is Yes. This property is not applicable if the value of the Proxy Auth property is No.

SSL Auth Ignore

<SSL_AUTH_IGNORE>

Select Yes or No from the list to specify whether or not measurement is to continue when SSL server authentication fails.

Select Yes to continue measurement when SSL server authentication fails.

Client Auth

<CLIENT_AUTH>

Select Yes or No from the list to specify whether or not client authentication is to be performed.

Client Certification File

<CLIENT_CERT_FILE>

Specifies the file in which the client certificate and private key are stored, by using a character string of 255 or fewer bytes. None is specified by default.

Specify the name of a file that is stored in installation-folder\agtv\probe\cert. Do not include the path. The file must be converted to Base64-encoded X.509 format. PFM - Web Console 08-50 or later supports Japanese (multibyte character sets) in a Japanese environment or Chinese (multibyte character sets, except for 4-byte characters) in a Chinese environment.

SMTP_[0-9]+

--

--

Stores the properties for measuring the SMTP service.

Hostname

<HOSTNAME>

Specifies the SMTP server's host name or IP address by character string up to 255 bytes. None is set by default.

Port

<PORT>

Specifies the SMTP server's port number in the range from 1 to 65,535.

Message Size

<MSG_SIZE>

Specifies the size of the text for a measurement email by character string up to 10,000 bytes. None is set by default.

Destination Mail Address

<DST_MAIL_ADDR>

Specifies exactly one email address to which a measurement email is to be sent by character string up to 256 bytes. None is set by default.

Source Mail Address

<SRC_MAIL_ADDR>

Specifies the email address from which a measurement email is to be sent by character string up to 256 bytes. None is set by default.

POP3 Auth

<POP3_AUTH>

Select Yes or No from the list to specify whether or not POP3 (POP before SMTP) authentication is to be performed.

POP3 Hostname

<POP3_HOSTNAME>

Specifies the POP3 server's host name or IP address by character string up to 255 bytes. None is set by default.

If the value of the POP3 Auth property is Yes, this value must be specified. If the value of the POP3 Auth property is No, this value is not applicable.

POP3 Port

<POP3_PORT>

Specifies the POP3 server's port number in the range from 1 to 65,535.

If the value of the POP3 Auth property is Yes, this value must be specified. If the value of the POP3 Auth property is No, this value is not applicable.

POP3 Username

<POP3_USERNAME>

Specifies the user name to be used for POP3 authentication by character string up to 40 bytes. None is set by default.

If the value of the POP3 Auth property is Yes, this value must be specified. If the value of the POP3 Auth property is No, this value is not applicable.

POP3_[0-9]+

--

--

Stores the properties for measuring the POP3 service.

Hostname

<HOSTNAME>

Specifies the POP3 server's host name or IP address by character string up to 255 bytes. None is set by default.

Port

<PORT>

Specifies the POP3 server's port number in the range from 1 to 65,535.

Username

<USERNAME>

Specifies the user name to be used in the POP3 service by character string up to 40 bytes. None is set by default.

Delete Mail

<NON_DELETE_MAIL>

Select Yes or No from the list to specify whether or not read emails are to be deleted.

IMAP4_[0-9]+

--

--

Stores the properties for measuring the IMAP4 service.

Hostname

<HOSTNAME>

Specifies the IMAP4 server's host name or IP address by character string up to 255 bytes. None is set by default.

Port

<PORT>

Specifies the IMAP4 server's port number in the range from 1 to 65,535.

Username

<USERNAME>

Specifies the user name to be used in the IMAP4 service by character string up to 64 bytes. None is set by default.

Delete Mail

<DELETE_MAIL>

Select Yes or No from the list to specify whether or not read emails are to be deleted.

DNS_[0-9]+

--

--

Stores the properties for measuring the DNS service.

IP Address

<IPADDRESS>

Specifies the DNS server's IP address by character string up to 15 bytes. Only the IP address is accepted; the DNS name is not accepted. None is set by default.

Port

<PORT>

Specifies the DNS server's port number in the range from 1 to 65,535.

Query

<QUERY>

Specifies the name of the host to be searched by character string up to 255 bytes. None is set by default.

Retry

<RETRY>

Specifies the number of retries in the range from 1 to 5. From this value and the timeout value specified in the <TIME_OUT> tag contained in the <GEN_PARAM> tag, the retry timeout value is determined and set automatically. The formula is as follows:

Retry timeout value = timeout value/(number of retries + 1)

DHCP_[0-9]+

--

--

Stores the properties for measuring the DHCP service.

Hostname

<HOSTNAME>

Specifies the DHCP server's host name or IP address by character string up to 255 bytes. None is set by default.

Port

<PORT>

Specifies the DHCP server's port number in the range from 1 to 65,535.

Probe Port

<PROBE_PORT>

Specifies the port number of the probe in the range from 1 to 65,535 that is used as the DHCP client in measuring the measurement condition.

Accept Offer

<NON_ACCEPT_OFFER>#7

Select Yes or No from the list to specify whether or not IP address assigned from the DNS server is to be accepted.

FTP_[0-9]+

--

--

Stores the properties for measuring the FTP service.

Hostname#5

<HOSTNAME>

Specifies the FTP server's host name or IP address by character string up to 255 bytes. None is set by default.

Port

<PORT>

Specifies the FTP server's port number in the range from 1 to 65,535.

Username

<USERNAME>

Specifies the user name to be used in the FTP service by character string up to 64 bytes. None is set by default.

Direction

<TRANS_DIRECTION>

Specifies the file transfer method. To transfer a file to the server, specify UPLOAD; to transfer a file from the server, specify DOWNLOAD.

A transfer file for measurement must already be stored in the following folder:

For UPLOAD:

installation-folder\agtv\probe\probedata\ftp

For DOWNLOAD:

Specified account's home directory

File

<FILE_NAME>

Specifies the name of the file to be transferred by character string up to 32 bytes. PFM - Web Console 08-50 or later supports Japanese (multibyte character sets) in a Japanese environment or Chinese (multibyte character sets, except for 4-byte characters) in a Chinese environment. None is set by default.

Connection Mode

<PASSIVE>#8

Select ACTIVE or PASSIVE from the list to specify the connection mode. The connection establishment method depends on the connection mode, as described below:

In the ACTIVE mode:

The connection request for file transfer is issued from the FTP server.

In the PASSIVE mode:

The connection request for file transfer is issued from the FTP probe.

TCP_[0-9]+

--

--

Stores the properties for measuring the TCP service.

Hostname#5

<HOSTNAME>

Specifies the TCP server's host name or IP address by character string up to 255 bytes. None is set by default.

Port

<PORT>

Specifies the TCP server's port number in the range from 1 to 65,535. None is set by default.

WEBTRANS_[0-9]+

--

--

Stores the properties for measuring the Web transaction.

Filename

<TRANSACTION_FILE>

Specifies the name of the Web transaction file. None is set by default.

Specify a file with the extension.xml that is stored in installation-folder\agtv\probe\webtrans.

  • Do not include the path.

  • The specified name is not case sensitive.

PFM - Web Console 08-50 or later supports Japanese (multibyte character sets) in a Japanese environment or Chinese (multibyte character sets, except for 4-byte characters) in a Chinese environment.

Transaction

<TRANSACTION_NAME>

Specifies the name of the Web transaction by character string up to 255 bytes. None is set by default.

The vertical bar character (|) cannot be used. PFM - Web Console 08-50 or later supports Japanese (multibyte character sets) in a Japanese environment or Chinese (multibyte character sets, except for 4-byte characters) in a Chinese environment.

USERSERV_[0-9]+

--

--

Stores the properties for measuring the user-defined service.

User Service ID

<USER_SERVICE_ID>

Specifies a user-defined service ID in the range from 1 to 100 that has been registered in the command registration file. None is set by default.

IESCENA_[0-9]+

--

--

Stores the properties for measuring the IE scenario.

Filename

<IESCENA_FILE>

Specifies the name of the IE scenario file.

Specify a file with the extension.xml that is stored in installation-folder\agtv\probe\iescena.

  • Do not include the path.

  • The specified name is not case sensitive.

PFM - Web Console 08-50 or later supports Japanese (multibyte character sets) in a Japanese environment or Chinese (multibyte character sets, except for 4-byte characters) in a Chinese environment.

Legend:

--: Not applicable

#1

The listed folders are the folders under the \Agent Configuration\Probe\Task List folder.

The string after the folder name, "[0-9]+", means a numeric character occurring one or more times. This number is the same as the one you specified as a task ID when creating a task.

The following is an example of the properties for Web transaction measurement when its Task ID is 100:

[Figure]

#2

The listed tags are used to define the properties in the measurement condition registration file.

#3

To use an IP address to specify a host name, use an IPv4 dotted-decimal address (for example: http://172.16.233.12/example.html) or an IPv6 hexadecimal address enclosed in square brackets, using colons as separators (for example: http://[ACE6:45:75:91::1]/example.html).

#4

If the POST method is used, the setting is defined in the <POST> tag. If the GET method is used, the tags are omitted.

#5

To specify an IPv4 address for the host name, use dotted-decimal format (for example: 172.16.233.12). To specify an IPv6 address, use hexadecimal format, using colons as separators (for example: ACE6:45:75:91::1).

#6

For the URL and Proxy Hostname properties of the HTTPS_[0-9]+ folder, you cannot specify an IPv6 address for the host name.

#7

If No is specified, the setting is defined in the <NON_ACCEPT_OFFER> tag. If Yes is specified, the tags are omitted.

#8

If the Passive method is used, the setting is defined in the <PASSIVE> tag. If the Active method is used, the tags are omitted.