Hitachi

JP1 Version 12 JP1/Integrated Management 2 - Manager Command, Definition File and API Reference


4.5 Methods available in the user-created plug-in

The following table lists and describes the methods that are commonly available in the methods of the user-created plug-in.

Table 4‒34: List of methods commonly available in the methods of the user-created plug-in

No.

Method name#

Description

1

jp1Imdd.callRest

The method to call the REST API

2

jp1Imdd.readFile

The method to read a file and return the content of the file as a string

3

jp1Imdd.encodeBase64

The method to convert a string into a Base64-formatted value and return it

4

jp1SimtService.get

The method to return the configuration information SID and the data labeled value

5

jp1SimtService.join

The method to return the configuration information SID that has been generated by combining structured identifiers

6

jp1SimtService.pack

The method to return the structured identifier generated by combining the class and name of the structured identifier that takes a non-host-name value for the name

7

jp1SimtService.packHost

The method to return the structured identifier generated by combining the class and name of the structured identifier that takes a host name for the name

8

jp1SimtService.parse

The method to split a configuration information SID into structured identifiers, separate each structured identifier into the class part and the URL-decoded name part with the underscore (_) between them removed, and return the resulting data

9

jp1Logger.trace

The method for logging

10

jp1Imdd.execCmd

The method to execute a command remotely

11

jp1Imdd.getPluginConfDirPath

The method to return the absolute path to the parent directory of the directory that stores plug-in definition files

12

jp1Imdd.getVersion

The method to return the version of JP1/IM

13

jp1EmService.getEvent

The method to retrieve events related to an IM management node from the integrated monitoring database

14

jp1SimtService.getLink

The method to retrieve link information

15

jp1EmService.changeEventStatus

The method to change the event status

16

jp1SimtService.getTreeSid

The method to retrieve the tree SID corresponding to the specified configuration information SID

#

jp1Imdd, jp1SimtService, and jp1Logger of these methods represent a global object. So, do not define a global object with the same name as one of these names. Also, do not define a global object with the name that starts with jp1 or hitachi.

Organization of this section