How to use the nhConfig command (Legacy KB ID CNC TS9721 )

Document ID : KB000051939
Last Modified Date : 14/02/2018
Show Technical Document Details

nhConfig Command Syntax

nhConfig [-help] [-rev] [-verbose] [-verify] -dciCmd nhSvGetCfg [-dciOut dciOutputFile] [-dciRule ruleFile [-dataFiles file1 ... filen]] [-dciIn dciInputFile] [-commit {yes-no}] [-createNew {yes-no}] [-merge {yes-no}]

Arguments Description
-----------------------------------------------------
-help Displays the syntax of the nhConfig command.

-rev Displays the product version.

-verbose Prints information at each phase of processing.

-verify - Processes input and produces an element file, but does not add the elements to the Network Health database. If you specify -verify, the command automatically includes -verbose. Specifying -verify also implies setting -commit to no and -createNew to no.

-dciCmd nhSvGetCfg - Specifies that nhConfig use the nhSvGetCfg command to extract information from a StrataView Plus NMS.

-dciOut dciOutputFile - Saves the processed element information in the specified file. Use this argument to create a file so that you can review the configuration information.

-dciRule rulesFile - Specifies the pathname of a rules file that you can use to filter and group elements from the NMS database in the poller configuration.

-dataFiles file1 ... filen - Specifies the pathnames of data files that you can use with the specified rules file to process the configuration information.

-dciIn dciInputFile - Specifies an input file to the nhConfig command. You can use the -dciIn dciInputFile option as an alternative to the -dciCmd nhSvGetCfg option for the nhConfig command. By using the dciOutputFile from a previous run of the nhConfig command as the argument to -dciIn, you can examine the output of a previous configuration extraction without having to repeat the extraction process.

-commit {yes-no} - Specifies whether to commit changes to the Network Health database. When set to yes (the default), commits changes to the database. This merges the element information with elements from the database and saves the results. Specifying -commit yes implies setting -merge to yes. When set to no, produces a change file and does not commit changes to the database.

-createNew {yes-no} - Specifies whether to create new elements in the Network Health database. When set to yes (the default), creates new elements in the database. When set to no, does not create new elements in the database. Existing elements in the database might be updated.

-merge {yes-no} - Specifies whether to merge the processed element information with elements from the Network Health database. When set to yes (the default), merges the element information with elements from the database. When set to no, does not merge the element information with elements from the database. If -commit is set to yes, setting -merge to no has no effect.

----------

When you run the nhConfig command, you can use the -dciOut option to create an element file that you can review to see the information for each element that was added. You can also use the dciOutputFile from a previous run of the nhConfig command as an argument to the -dciIn option. This lets you examine the output of a previous configuration extraction without having to repeat the extraction process. If you use the -verify option, the nhConfig command creates a temporary element file in the $NH_HOME/tmp directory and does not update the poller configuration. The command displays the element file name at the end of processing. You can review the element file to determine whether you want to import the elements or use some grouping or filtering options.

You can use the -dciRule and -dataFiles options to customize the extraction process. You can use these options to:

Filter out elements that you do not want to include in your Network Health reports

Group elements by name, type, or other criteria

Include or exclude (filter) elements on the Network Health system where the command runs

Change e.lement information.

Related Issues/Questions:
How to use the nhConfig command
Valid switches for the nhConfig command
nhConfig Command Syntax

Problem Environment:
eHealth


(Legacy KB ID CNC TS9721 )