2.5.12 Obtain JP1/CM2 monitored node list
Function
Obtains the JP1/CM2/NNMi monitored node list.
This service template requires the following servers:
- NNMi server
This is the server where JP1/Cm2/NNMi is installed.
- Monitored node
This is the server or device monitored by JP1/Cm2/NNMi.
An overview of the process is given below.
1. Obtain the monitored node list of the NNMi server, and output it to the specified file in XML format. The output format of the file is identical to the output results of the JP1/Cm2/NNMi command nnmtopodump.
2. Transfer the file that was output from the NNMi server to the JP1/AO server, and delete the transfer source file from the NNMi server.
Prerequisites
For the latest support information about [Required product in the System]/[Prerequisite products in the system executing the service template]/[Prerequisite product OS running in the system executing the service template], see the release notes.
[Required product in the System]
JP1/Automatic Operation 12-00 or later
[Prerequisite products in the system executing the service template]
(1) Job Management Partner 1/Cm2/Network Node Manager i 10-00, 10-10, 10-50
(2) JP1/Network Node Manager i 11-00, 11-10, 11-50, 12-00, 12-10, 12-50, 12-60
[Prerequisite product OS running in the system executing the service template]
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
(5) Red Hat Enterprise Linux Server 6 (64-bit x86_64)
(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)
(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)
[Usage conditions of prerequisite products in the system executing the service template]
(1) When this service is executed, the JP1/AO server (loopback address resolved by "localhost") and NNMI server must be set as agentless connection targets.
(2) When using JP1/Cm2/NNMi 09-10, make sure that account credentials (the values used as a user name and password when a JP1/Cm2/NNMi script is executed) have already been specified.
Cautions
(1) Do not execute multiple instances of this service simultaneously in the NNMi server.
(2) This service executes the nnmtopodump command in the NNMi server. For this reason, do not execute the nnmtopodump command in the NNMi server while this service is being executed. In the same way, do not execute this service while the nnmtopodump command is being executed in the NNMi server.
(3) If the OS running in the execution target server is Linux, a command is executed at the default locale of the connected user defined in the agentless connection target. Set a locale supported by JP1/Cm2/NNMi for the default locale of the connection user. For details, see "Locale set for operation target devices during plug-in execution" and "Character set used for communication by JP1/AO during plug-in execution" in the JP1/AO manual and the JP1/Cm2/NNMi release notes.
(4) If a file name specified remotely or locally already exists, the existing file is overwritten. Also, the files on the remote side are deleted. For this reason, carefully check that there are no mistakes in the specified file name.
(5) If a folder with the path specified remotely does not exist, the folder is created. The created folder remains and is not deleted. Delete unused folders on a regular basis.
Version
02.00.00
Tags
Gather JP1 information,NNMi
Property list
The following shows the list of the property groups set in the property:
Property group |
Description |
Initial display |
---|---|---|
Monitoring system environment information |
Specify the environment information of the NNMi server. |
Y |
Output file storage information |
Specify the storage location of the output file. |
Y |
The following shows the list of the properties to be displayed in the "Service Definition" window:
- (Legend)
-
R: The property must be specified.
O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
---|---|---|---|---|---|---|
jp1cm2nnm.nnmHostName |
NNMi server host name |
Specifies the host name or IP address of the server where JP1/Cm2/NNMi is installed. IPv6 addresses are not supported. When a cluster configuration is used, specify the physical host or logical host of the execution system server. |
Input |
Disabled |
R |
Monitoring system environment information |
The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
---|---|---|---|---|---|---|
jp1cm2nnm.nodeListFileNameRemote |
Output file path (remote) |
Specifies the temporary file name when outputting the monitored node list file to the NNMi server as a full path. The remote file is deleted after transfer. |
Input |
Disabled |
R |
Output file storage information |
jp1cm2nnm.nodeListFileNameLocal |
Output file path (local) |
Specifies the file name of the JP1/AO server that obtains the monitored node list file as a full path. |
Input |
Disabled |
R |
Output file storage information |
The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:
Property key |
Characters that can be input |
---|---|
jp1cm2nnm.nnmHostName |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:
Property key |
Characters that can be input |
---|---|
jp1cm2nnm.nodeListFileNameRemote |
Enter no more than 256 characters. Do not include the following characters: < > | ; & * ? " % ` or a trailing \ or / |
jp1cm2nnm.nodeListFileNameLocal |
Enter no more than 256 characters. Do not include the following characters: < > | ; & * ? " % or a trailing \ or / |
Flow specification details
The following table shows the detailed specification of the flow:
Hierarchy |
Display name |
Plug-in |
||
---|---|---|---|---|
Plug-in name |
Description |
Error recovery method |
||
1 |
getNodeListFileJP1Cm2 |
Output of the NNMi topology database content |
Obtains the NNMi monitored node list. |
After removing the cause of the error, run the service again. |
2 |
FileTransferPlugin |
File-Forwarding Plug-in |
Transfers the monitored node list file. |
After removing the cause of the error, run the service again. |
3 |
osDeleteFile |
Delete file |
Deletes temporary files. |
Files remain in the target server. Delete them manually. |