Hitachi

JP1 Version 12 JP1/Performance Management Planning and Configuration Guide


B.1 Naming rules for service IDs and service keys

Performance Management services are managed by using the GUI for PFM - Web Console and various commands. The service ID and service key are used to identify the services. The following describes naming rules for service IDs and service keys.

The service ID and service key formats vary, depending on whether the product name display function is enabled. For details, see 3.1.2 Displaying and specifying services (the product name display function).

Organization of this subsection

(1) Service ID

A service of Performance Management is assigned a unique ID. This ID is called the service ID. When you use a command to verify the system configuration for Performance Management or back up the performance data for an individual agent, specify a Performance Management service ID to execute the command.

(a) If the product name display function is disabled

If the product name display function is disabled, the service ID format is the same for all services. The configuration of a service ID is shown below:

Figure B‒1: Example when the service ID is PN1001

[Figure]

The following describes components that make up the service ID.

  • Product ID

    The product ID is a one-byte identifier that indicates the Performance Management program product that provides this service.

    For the PFM - Manager services and the Action Handler service, the product ID is P. For the health check agent, the product ID is 0.

    For details about the product ID for each PFM - Agent or PFM - RM, see the list of identifiers in the appendixes of each PFM - Agent or PFM - RM manual.

  • Function ID

    The function ID is a one-byte identifier that indicates the function type for this service.

    The following table lists the function IDs and the service name for each function ID, and provides an overview of each function.

    Table B‒1: Service names and function IDs

    Function ID

    Service name

    Overview of function

    A

    Agent Collector

    Collects performance data

    Remote Monitor Collector

    Remote agent

    Group agent

    C

    Trap Generator

    Issues client functions and SNMP traps

    E

    Correlator

    Controls event sending between services

    H

    Action Handler

    Executes actions

    M

    Master Manager

    Contains the main functionality of Performance Management

    N

    Name Server

    Manages the service configuration information within the system

    P

    View Server

    The communication server between PFM - Web Console and PFM - Manager

    S

    Agent Store

    Manages performance data and event data

    Remote Monitor Store

    Master Store

    T

    Status Server

    Manages the status of services

  • Instance Number

    The instance number is an identifier that is a one-byte control number used by internal processing.

  • Device ID

    The device ID is an identifier containing characters (1-255 bytes) that indicate the host (for example) on which this service has been started in the Performance Management system. The device ID differs in settings depending on the services.

    The following table describes the service name and the contents of the device ID.

    Table B‒2: Service names and device IDs

    Service name

    Settings of device ID

    Name Server

    Defaults to 001 and cannot be modified.

    Master Manager

    Defaults to 001 and cannot be modified.

    View Server

    Sets the host name.

    Correlator

    Defaults to 001 and cannot be modified.

    Action Handler

    Sets the host name.

    Trap Generator

    Sets the host name.

    Agent Collector

    Sets the host name when in a non-instance configuration.

    In an instance configuration, instance-name[host-name] is set.

    Remote Monitor Collector

    Agent Store

    Sets the host name when in a non-instance configuration.

    In an instance configuration, instance-name[host-name] is set.

    Remote Monitor Store

    Remote agent

    Sets the instance-name [monitored-target-name@Remote-Monitor-Collector-service-operating-host-name].

    Group agent

    Sets the instance-name [group-name@Remote-Monitor-Collector-service-operating-host-name].

    Master Store

    Defaults to 001 and cannot be modified.

    Status Server

    Sets the host name.

(b) If the product name display function is enabled

If the product name display function is enabled, the service ID format will vary for each service. The following table describes the service name and the contents of the service ID.

Table B‒3: Service names and service IDs

Service name

Service ID

Name Server

<Name Server>

Master Manager

<Master Manager>

View Server

<View Server>

Correlator

<Correlator>

Action Handler

device-ID<Action Handler>

Trap Generator

<Trap Generator>

Agent Collector

device-ID<product-name>

Remote Monitor Collector

Remote agent

Group agent

Agent Store

device-ID<product-name>(Store)

Remote Monitor Store

Master Store

<Master Store>

Status Server

device-ID<Status Server>

Web Console#

<Web Console>

#

This service is only used for output from the jpctool service list command.

The following describes components that make up the service ID.

  • Device ID

    The device ID is an identifier containing characters (1-255 bytes) that indicate the host (for example) on which this service has been started in the Performance Management system. The device ID differs in settings depending on the services. The service ID format is the same as the one used when the product name display function is disabled. For details about the contents of device IDs, see Table B-2 Service names and device IDs.

  • Product name

    This indicates the product name of the PFM - Agent or PFM - RM.

(2) Service key

Specify an identifier called a service key to execute a command when starting or stopping each Performance Management service.

When you specify a service key to execute commands, you can use the formats listed below in (a) and (b), regardless of the status of the product name display function for the host that executes the commands.

Also, if you specify the service keys to execute jpcspm start, jpcspm stop, and jpctool service list commands, some service keys will indicate different services. For details, see the chapters that describe the corresponding command in the manual JP1/Performance Management Reference.

(a) If the product name display function is disabled

Table B‒4: Service key list (if the product name display function is disabled)

Service key

Meaning

all

Indicates the services of all Performance Management programs.

PFM - Web Console services are included if you specify links for start and stop with PFM - Web Console in the same host, and specify the services to execute the jpcspm start, jpcspm stop, and jpctool service list commands.

jp1pc

Indicates the services of all Performance Management programs. PFM - Web Console services are not included. You can only set this service key to execute jpcspm start, jpcspm stop, and jpctool service list commands.

mgr

Indicates the PFM - Manager service (except for the Action Handler service).

act

Indicates the Action Handler service.

stat

Indicates the Status Server service.

agt0

Indicates the services (Agent Collector and Agent Store) of the health check agent.

wc

Indicates the PFM - Web Console services.

For details about service keys for each PFM - Agent or PFM - RM, see the corresponding manual for each PFM - Agent or PFM - RM.

(b) If the product name display function is enabled

Table B‒5: Service key list (if the product name display function is enabled)

Service key

Description

Manager

Indicates the PFM - Manager services (except the Action Handler service).

AH

Indicates the Action Handler service.

StatSvr

Indicates the Status Server service.

HC

Indicates the health check agent services (Agent Collector and Agent Store).

WebConsole

Indicates the PFM - Web Console services.

Service keys specified during command execution are not case sensitive.

For details about service keys for each PFM - Agent or PFM - RM, see the corresponding manual for each PFM - Agent or PFM - RM. However, for PFM - Agent version 08-11 or earlier, see B.3 List of service keys for PFM - Agent version 08-11 or earlier (when the product name display function is enabled).