4.5.14 jp1SimtService.getLink
This method retrieves link information.
This method cannot be called from the __eventGet method provided by product plug-ins or from the method called by the __eventGet method.
The details of the jp1SimtService.getLink method are provided below.
- Method name
-
Object jp1SimtService.getLink(String type, String sid, int fromLayerCount, int toLayerCount, int countPerLayer, int linkCount, String lang, String jp1User, String jp1Token)
- Parameters
-
- type
-
Of the types of link information supported by the system, specify the one corresponding to the link information you want to retrieve. If you specify null or an empty string, applicable link information is returned regardless of link information type.
type describes a grouping of relations that have the same meaning. On the Related node tab in the Integrated Operation Viewer window, you can filter relations to display only those belonging to a specific type.
For relations within a JP1/IM product or between a JP1/IM product and another product, the following types are used. In addition to these types, the use of user-specified types is also allowed.
-
rootJobnetExecutionOrder: Relation of the execution order of root jobnets
-
managerAgent: Relation between the manager and agent of a JP1 product
-
rootJobnetAgent: Relation between a root jobnet and an AJS agent
-
sameNode: Relation between nodes with the same name
-
L2Connection: Relation between layer-2 connection lines managed by JP1/NNMi
-
Infrastructure: Relation between infrastructure resources managed by JP1/OA
-
monitoringConfiguration: Relation between a product and a monitoring target in a monitoring product configuration
-
- sid
-
Specify the SID of the node to be processed. Information regarding the nodes preceding and succeeding the specified node is returned. If you specify null or an empty string, link information on all nodes is returned.
- fromLayerCount
-
Specify the maximum number of preceding node layers to be retrieved in the range from 0 to 2147483647. If you specify null or an empty string for sid, the value specified for the fromLayerCount parameter is ignored.
- toLayerCount
-
Specify the maximum number of succeeding node layers to be retrieved in the range from 0 to 2147483647. If you specify null or an empty string for sid, the value specified for the toLayerCount parameter is ignored.
- countPerLayer
-
Specify the maximum number of nodes to be retrieved per node layer in the range from 1 to 2147483647. If you specify null or an empty string for sid, the value specified for this argument is ignored.
- linkCount
-
Specify the maximum number of links to be retrieved in the range from 1 to 2147483647. If you specify null or an empty string for sid, the value specified for the linkCount parameter is ignored.
- lang
-
Specify the language of the message. You can specify ja, ja-JP, or en. If you specify any other values, it is assumed that en is specified. For details, see Language conventions of user-created plug-ins in 4.4 Methods implemented in the plug-in.
- jp1User
-
By using a string of 1 to 31 bytes, specify the name of a JP1 user who has one of the following JP1 permission levels:
-
JP1_Console_Admin
-
JP1_Console_Operator
-
JP1_Console_User
-
- jp1Token
-
Specify a JP1 authentication token for the JP1 user specified for jp1User.
- Return values
-
After successful retrieval of link information, an object storing link information is returned. The following table describes the keys and their values stored in the object:
No.
Key
Value
1
links
Returns an array of retrieved link information. For details about the array of link information, see IM management node link definition file (imdd_nodeLink_def.conf) in Chapter 2. Definition Files.
2
exceedCountDetected
Indicates whether it has been detected that the value specified for the parameter has exceeded the maximum limit.
3
countPerLayer
Indicates whether it has been detected that the maximum number of nodes per layer has been exceeded.
4
layerinteger
Replaces integer with the number assigned to each layer. 0 is assigned to the layer specified for sid, with the number assigned to the layers succeeding it incremented starting from +1, and that assigned to the layers preceding it decremented starting from -1. In this way, this key indicates for all layers returned whether it has been detected that the maximum number of nodes allowed per layer has been exceeded.
-
true
Detected
-
false
Not detected
5
linkCount
Indicates whether it has been detected that the maximum number of links allowed has been exceeded.
-
true
Detected
-
false
Not detected
6
messageId
A message ID. When there is no message to be provided, null is specified.
7
message
The body of a message. When there is no message to be provided, null is specified.
The following table describes the keys and their values stored in the object after a failed attempt to retrieve link information:
No.
Key
Value
1
errorMessage
An error message. When any of the arguments is invalid, the KAJY22043-E error message is output.
For details about the error messages output in all the other cases, see the table under Status codes in 5.6.1 Event search.
2
errorMessageId
Returns the ID of the error message.
In methods of a product plug-in that calls this method, consider error messages and error processing based on the specifications of the plug-in, according to the value of the key errorMessageId.
Output the key errorMessage to the internal log of the product plug-in for use in troubleshooting it.
-
- Exception
-
None