jp1pfmSuggestionGetAgentInformation

1

sid

string

No

Specify the tree ID of the IM management node of Performance Management.

Specify the same value as sid of the jp1pfmSuggestionGetAgentAllInformation function.

2

method

string

No

Specify "jp1pfmSuggestionGetAgentInformation".

3

args

object

No

Specify an object with the members in No. 4 and later.

4

allInformation

string

No

Specify the value stored in suggestion of the response of the jp1pfmSuggestionGetAgentAllInformation function.

5

member

number[]

No

Specify the items to be obtained as an array.

The values you can specify are as follows:

• "productId"

  Product ID

• "displayName"

  Display name

• "healthSeverity"

  Severity of the health check status

• "healthDetail"

  Health check status

• "status"

  Agent status

• "businessGroupName"

  Name of the business group associated with the monitoring host

• "resourceGroupName"

  Name of the JP1 resource group associated with the monitoring host

For details on the value stored in suggestion of the response for each of the above values, see Table 5-6 Values specified for member and a value stored in suggestion.

"productId"

The value of the product ID is stored.

"displayName"

The value of the display name is stored.

A different value is stored depending on whether the product name display functionality of Performance Management is enabled.

For example, if PFM - Agent for Platform (Windows) has been set up on the host with the host name of hostA, the following value is stored:

• When the product name display function is enabled:

  hostA<Windows>

• When the product name display function is disabled:

  TA1hostA

"healthSeverity"

The value of the severity of the health check status is stored.

One of the following values is stored. The value of the applicable health check status shows the default value^#.

• Information

  Applicable health check status: Running, Suspended

• Warning

  Applicable health check status: Incomplete

• Error

  Applicable health check status: Stopped, Unconfirmed, Host Not Available

• None

  Applicable health check status: Not Supported

The values of the above health check statuses are the default value^#.

#

It depends on the JP1 Event - health-check-status-value property setting of the Health Check Configurations node on a health check agent. Note that the severity that corresponds to Suspended is fixed and cannot be changed.

"healthDetail"

The value of the health check status is stored.

One of the following values is stored:

• Not Supported

  Not Support (agent that does not support health check)

• Running

  Running

• Incomplete

  Incomplete

• Stopped

  Stopped service

• Unconfirmed

  Unconfirmed

• Host Not Available

  Host Not Available

• Suspended

  Monitoring suspended

"status"

The value of the agent status is stored.

One of the following values is obtained depending on the status of the alarm bound to the agent.

If monitoring of the agent is suspended, Suspended is obtained regardless of the existence or status of the bound alarm.

• OK

  Everything is normal.^#

• Warning

  No error, but one or more warnings.

• Exception

  One or more errors.

• Suspended

  Monitoring is suspended.

#

The following statuses are also considered to be normal:

- No bound alarm.

- Active setting of the alarm is disabled.

"businessGroupName"

The name of the business group associated with the monitoring host can be obtained.

If the business group functionality is disabled or a business group is not assigned to a host, an empty string is obtained.

"resourceGroupName"

The name of the JP1 resource group associated with the monitoring host can be obtained.

An empty string is obtained if:

• The business group functionality is disabled.

• The authentication mode of PFM - Manager is in PFM authentication mode.

• No business group is assigned.

• No resource group is assigned to the business group.

The args object in the suggestion definition file does not specify necessary members required.

KAJY24113-E

A Performance Management tree SID of a type that cannot be accepted in this function was specified for sid in the suggestion definition file.

An incorrect value is specified for allInformation or member in the suggestion definition file.