Hitachi

JP1 Version 12 JP1/Automatic Operation Service Template Reference


4.9.1 Output of the NNMi topology database content

Function

Acquires the content of the topology database of JP1/Cm2/NNMi, and outputs them to the file in the specified output type.

This component requires the following server:

- NNMi server (Execution target server)

This is the target server where this component is executed. JP1/Cm2/NNMi needs to have been set up.

For details about how to specify the output type, see the JP1/Cm2/NNMi manual.

Use situation

This can be used when checking the contents of the topology database after adding or deleting the monitoring target to/from JP1/Cm2/NNMi.

Prerequisites

For the latest support information about [Required product in the System]/[Required products on the execution target server]/[Prerequisite product OS running in the execution target server], see the release notes.

[Required product in the System]

JP1/Automatic Operation 11-00 or later

[Required products on the execution target server]

(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 execution target server]

(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 (32-bit x86),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 for required products on the execution target server]

If JP1/Cm2/NNMi 09-10 is used, the account credentials (values that are used in the user name and password when executing the JP1/Cm2/NNMi script) in the NNMi server must already be set.

Cautions

(1) Do not execute multiple instances of this component simultaneously on the NNMi server.

(2) This component executes the nnmtopodump command on the NNMi server. For this reason, do not execute the nnmtopodump command on the NNMI server while this component is being executed. In the same way, do not execute this component while the nnmtopodump command is being executed on the NNMi server.

(3) If the OS running on NNMi 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 manual.

Version

02.00.00

Plug-in tags

Gather JP1 information,NNMi,Windows,Linux

Plug-in name displayed in the task log

jp1nnmGetTopoDump

Return code

0: Normal

12: Error (Mistake by user) Invalid property

14: Error (Mistake by user) File inaccessible

21: Error (Environmental error) No command was found (An error was detected in the component script)

27: Error (Check with the task log about the error detail) Unidentified error

41: Error (An error has been detected in the component) Property not entered

Property list

The following table lists the properties:

Property key

Property name

Description

Default value

I/O type

Required

plugin.destinationHost

Host name of the execution target server

Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported.

localhost

Input

R

JP1CM2NNM.dumpType

Output type of the topology database content

Specifies the output type of the JP1/Cm2/NNMi topology database content.

node

Input

R

common.outputFilePath

Output file path

Specifies the file to be output as a full path.

--

Input

R

common.returnValue

Return value for the plugin

The return value of this plugin stored.

--

Output

O