What does the eHealth command nhModifyElements do (Legacy KB ID CNC TS19442 )

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

 Each time the nhModifyElements command is run, a dci file is created and stored in a $NH_HOME/tmp/nhiCfgServer/CfgDci.<index> directory.  The directory which contains the dci file is named "CfgDci.<index>" The most recent directory created has an extension index of "0" and each previous file has an index incremented by "1". 

 

 

   For example, you might see CfgDci.0, CfgDci.1, etc.

 

The command nhModifyElements changes selected attributes for one or more elements maintained by eHealth. You can use three methods to specify elements:
use standard input (stdin),
use the -inFile argument,
or redirect the output of the nhListElements command as input.

 

 

CAUTION: Improper use of this command can result in failure to poll or incorrect report data.  Use this command only if you are an advanced user and are familiar with the effects of this command.

 

nhModifyElements [ -h ] [ -rev ] -fieldName <fieldName> [ -value <value> ] [ -inFile <fileName> ] [ -verify ]

 

-h   (Optional) Displays this command usage.

 

-rev (Optional) Displays the eHealth software revision.

 

-fieldName <fieldName>
    (Required) Specifies a DCI element field to update. Fields representing
    database handles and deprecated fields are not supported. You can
    update only one field at a time. For a complete list of the valid DCI
    element fieldName values, refer to the eHealth Integration Guide.

 

-value <value>
    (Optional) Modifies a property for a set of elements without requiring
    you to generate an input file where the data format is name,value.
    For details on the values you can specify for each field, refer to the
    eHealth Integration Guide.
    NOTE: You cannot use the -value parameter with the name or alias fields

 

-inFile <filename>
    (Optional) Specifies the name of the file that contains the list of
    modifications. Use -inFile to specify unique values for each element,
    not the same value for all elements; or, create a list and use -value
    to specify the same value for all elements in the list. If you do not
    specify an input file, eHealth reads input from standard input. Input
    has the following format:

 

    name[,value]
    name[,value]
    ...
    name[,value]

 

    If you do not use the -value argument, you must specify a value for each element in the list.

 

-verify
    (Optional) Processes the input and produces a DCI file, but does not modify the elements in the eHealth configuration.

 

The following example changes the poll rate of all elements in the file subnet5Routers to normal:

 

   nhModifyElements -fieldName pollRate -value normal -inFile subnet5Routers

 

The following command finds all elements that have not collected data for four hours and turns off polling for them:

 

   nhListElements -noDbDataFor 4 - nhModifyElements -fieldName poll -value no

 

The following command lists all elements that have a speed of 9600 bps and changes them to a speed of 19200 bps:

 

   nhListElements -where "speedIn = 9600" - nhModifyElements -fieldName speedIn -value 19200

 

For more information, refer to the Admin Reference documentation at eHealth Administr.ation Reference.

 

 

.

Related Issues/Questions:
What does the eHealth command nhModifyElements do
Is there a dci file created by running the command nhModifyElements
What causes the dci file to be created in the $NH_HOME/tmp/nhiCfgServer/CfgDci.<index> directory

Problem Environment:
eHealth 6.0
eHealth 5.7


(Legacy KB ID CNC TS19442 )