Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
Name
nnmcustompollerconfig.sh — Create, list, update, delete, enable, and disable Custom Poller configuration.
SYNOPSIS
nnmcustompollerconfig.sh
nnmcustompollerconfig.sh
createCollection
[-uuid <object uuid
>]
-name <name
>
-type <collection type
>
[-filterVariable <mib filter variable
>]
[-affectNodeStatus <true|false>]
[-exportCollection <true|false>]
[-compressExport <true|false>]
[-generateIncident <true|false>
-incidentSource <incident source object
>]
nnmcustompollerconfig.sh
createComparisonMap
[-uuid <object uuid
>]
-variable <name
>|<uuid
>
-ordering <ordering
>
-comparisonOperator <comparison operator
>
-comparisonValue <comparison value
>
-stateMapping <state mapping
>
nnmcustompollerconfig.sh
createCountThreshold
[-uuid <object uuid
>]
-variable <name
>|<uuid
>
{ (-lowState <low state
>
-lowValue <low value
>
[-lowValueRearm <lowValueRearm
>]
[-lowTriggerCount <low trigger count
>]
) | (-highState <high state
>
-highValue <high value
>
[-highValueRearm <high value rearm
>]
[-highTriggerCount <high trigger count
>]) }
nnmcustompollerconfig.sh
createMibDefinition
-converstionType <conversion type
>
-isTabular <true|false>
-oidType <oid type
>
-oid <oid
>
[-uuid <object uuid
>]
nnmcustompollerconfig.sh
createMibExpression
-expression <mib expression
>
[-displayVariable <display variable
>]
-author <unique key
>
[-desc <"description"
>]
[-displayFilter <name
>]
[-conversionAlgorithm <conversation algorithm
>]
-key <unique key
> -name <name
>
nnmcustompollerconfig.sh
createPolicy
-name <>name
>
-pollingInterval <polling interval
>
-ordering <ordering
>
[-uuid <object uuid
>]
-collection <name
>|<uuid
>
-nodeGroup <name
>|<uuid
>
-activeState <active state
>
[-filter <mib filter
>]
nnmcustompollerconfig.sh
createReportCollection
-reportGroup <name
>|<uuid
>
{[-uuid <object uuid
>]
-collection <name
>|<uuid
>}
| {-list <csv list of identifiers
>}
nnmcustompollerconfig.sh
createReportGroup
[-uuid <object uuid
>]
-name <name
>
nnmcustompollerconfig.sh
createTimeThreshold
[-uuid <object uuid
>]
-variable <name
>|<uuid
>
{ (-lowState <low state
>
-lowValue <low value
>
[-lowValueRearm <lowValueRearm
>]
-lowDuration <low duration
>
-lowWindowDuration <low window duration
>)
| (-highState <high state
> -highValue <high value
>
[-highValueRearm <high value rearm
>]
-highDuration <high duration
>
-highWindowDuration <high window duration
>) }
nnmcustompollerconfig.sh
createVariable
-collection <name
>|<uuid
>
[-uuid <object uuid
>]
-reportDataType <report data type
>
-mibExpression <key
>|<name
>
-name <name
>
nnmcustompollerconfig.sh
deleteCollection
-collection <name
>|<uuid
>
| -list <csv list of identifiers
>
nnmcustompollerconfig.sh
deleteComparisonMap
-map <uuid
>
| -list <csv list of identifiers
>
nnmcustompollerconfig.sh
deleteCountThreshold
-threshold <uuid
>
| -list <csv list of identifiers
>
nnmcustompollerconfig.sh
deleteMibDefinition
-mibDefinition <oid
>|<uuid
>
| -list <csv list of identifiers
>
nnmcustompollerconfig.sh
deleteMibExpression
-mibExpression <key
>|<name
>
| -list <csv list of identifiers
>
nnmcustompollerconfig.sh
deletePolicy
-policy <name
>|<uuid
>
| -list <csv list of identifiers
>
nnmcustompollerconfig.sh
deleteReportCollection
-reportCollection <uuid
>
| -list <csv list of identifiers
>
nnmcustompollerconfig.sh
deleteReportGroup
-reportGroup <name
>|<uuid
>
| -list <csv list of identifiers
>
nnmcustompollerconfig.sh
deleteTimeThreshold
-threshold <uuid
>
| -list <csv list of identifiers
>
nnmcustompollerconfig.sh
deleteVariable
-variable <name
>|<uuid
>
| -list <csv list of identifiers
>
nnmcustompollerconfig.sh
disable
nnmcustompollerconfig.sh
enable
nnmcustompollerconfig.sh
listCollection
[-exportCollection <true|false>]
[-name <name
>]
[-generateIncident <true|false>]
[-incidentSource <incident source object
>]
[-compressExport <true|false>]
[-uuid <object uuid
>]
[-type <collection type
>]
[-filterVariable <mib filter variable
>]
[-affectNodeStatus <true|false>]
nnmcustompollerconfig.sh
listComparisonMap
[-ordering <ordering
>]
[-stateMapping <state mapping
>]
[-comparisonOperator <comparison operator
>]
[-uuid <object uuid
>]
[-comparisonValue <comparison value
>]
[-variable <name
>|<uuid
>]
nnmcustompollerconfig.sh
listCountThreshold
[-highState <high state
>]
[-lowTriggerCount <low trigger count
>]
[-lowValueRearm <lowValueRearm
>]
[-lowValue <low value
>]
[-highTriggerCount <high trigger count
>]
[-lowState <low state
>]
[-uuid <object uuid
>]
[-highValueRearm <high value rearm
>]
[-variable <name
>|<uuid
>]
[-highValue <high value
>]
nnmcustompollerconfig.sh
listMibDefinition
[-converstionType <conversion type
>]
[-isTabular <true|false>]
[-oidType <oid type
>]
[-oid <oid
>]
[-uuid <object uuid
>]
nnmcustompollerconfig.sh
listMibExpression
[-author <unique key
>]
[-conversionAlgorithm <conversation algorithm
>]
[-desc <"description"
>]
[-displayFilter <name
>]
[-displayVariable <display variable
>]
[-expression <mib expression
>]
[-key <unique key
>]
[-name <name
>]
nnmcustompollerconfig.sh
listPolicy
[-activeState <active state
>]
[-collection <name
>|<uuid
>]
[-filter <mib filter
>]
[-name <name
>]
[-nodeGroup <name
>|<uuid
>]
[-ordering <ordering
>]
[-pollingInterval <polling interval
>]
[-uuid <object uuid
>]
nnmcustompollerconfig.sh
listReportCollection
[-collection <name
>|<uuid
>]
[-list <csv list of identifiers
>]
[-reportGroup <name
>|<uuid
>]
[-uuid <object uuid
>]
nnmcustompollerconfig.sh
listReportGroup
[-name <name
>]
[-uuid <object uuid
>]
nnmcustompollerconfig.sh
listTimeThreshold
[-highDuration <high duration
>]
[-highState <high state
>]
[-lowWindowDuration <low window duration
>]
[-lowDuration <low duration
>]
[-lowValueRearm <lowValueRearm
>]
[-lowValue <low value
>]
[-lowState <low state
>]
[-uuid <object uuid
>]
[-highValueRearm <high value rearm
>]
[-variable <name
>|<uuid
>]
[-highWindowDuration <high window duration
>]
[-highValue <high value
>]
nnmcustompollerconfig.sh
listVariable
[-collection <name
>|<uuid
>]
[-uuid <object uuid
>]
[-reportDataType <report data type
>]
[-mibExpression <key
>|<name
>]
[-name <name
>]
nnmcustompollerconfig.sh
status
nnmcustompollerconfig.sh
updateCollection
-collection <name
>|<uuid
>
[-exportCollection <true|false>]
[-name <name
>]
[-generateIncident <true|false>]
[-incidentSource <incident source object
>]
[-compressExport <true|false>]
[-type <collection type
>]
[-filterVariable <mib filter variable
>]
[-affectNodeStatus <true|false>]
nnmcustompollerconfig.sh
updateComparisonMap
-map <uuid
>
[-variable <name
>|<uuid
>]
[-ordering <ordering
>]
[-comparisonOperator <comparison operator
>]
[-comparisonValue <comparison value
>]
[-stateMapping <state mapping
>]
nnmcustompollerconfig.sh
updateCountThreshold
-threshold <uuid
>
[-variable <name
>|<uuid
>]
[-lowState <low state
>]
[-lowValue <low value
>]
[-lowValueRearm <lowValueRearm
>]
[-lowTriggerCount <low trigger count
>]
[-highState <high state
>]
[-highValue <high value
>]
[-highValueRearm <high value rearm
>]
[-highTriggerCount <high trigger count
>]
nnmcustompollerconfig.sh
updateMibDefinition
-mibDefinition <oid
>|<uuid
>
[-oid <oid
>]
[-oidType <oid type
>]
[-converstionType <conversion type
>]
[-isTabular <true|false>]
nnmcustompollerconfig.sh
updateMibExpression
-mibExpression <key
>|<name
>
[-expression <mib expression
>]
[-displayVariable <display variable
>]
[-author <unique key
>]
[-desc <"description"
>]
[-displayFilter <name
>]
[-conversionAlgorithm <conversation algorithm
>]
[-key <unique key
>]
[-name <name
>]
nnmcustompollerconfig.sh
updatePolicy
-policy <name
>|<uuid
>
[-name <name
>]
[-pollingInterval <polling interval
>]
[-ordering <ordering
>]
[-collection <name
>|<uuid
>]
[-nodeGroup <name
>|<uuid
>]
[-activeState <active state
>]
[-filter <mib filter
>]
nnmcustompollerconfig.sh
updateReportGroup
-reportGroup <name
>|<uuid
>
[-name <name
>]
nnmcustompollerconfig.sh
updateTimeThreshold
-threshold <uuid
>
[-variable <name
>|<uuid
>]
[-lowState <low state
>]
[-lowValue <low value
>]
[-lowValueRearm <lowValueRearm
>]
[-lowDuration <low duration
>]
[-lowWindowDuration <low window duration
>]
[-highState <high state
>]
[-highValue <high value
>]
[-highValueRearm <high value rearm
>]
[-highDuration <high duration
>]
[-highWindowDuration <high window duration
>]
nnmcustompollerconfig.sh
updateVariable
-variable <name
>|<uuid
>
[-collection <name
>|<uuid
>]
[-reportDataType <report data type
>]
[-mibExpression <key
>|<name
>]
[-name <name
>]
DESCRIPTION
The general format of the nnmcustompollerconfig.sh
command line is the following:
nnmcustompollerconfig.sh <
command>
<options
>-
Each of the available choices for
command
are listed below, in the Commands section. Similarly, the availableoptions
for each of the commands are found in the Options section. Many commands share similar options. See the Synopsis section above for the appropriate list of options for each command.For more info on how to correctly specify a Mib Expression, refer to the Mib Expressions section.
To understand how deleting Report Groups affect NPS, please read Report Groups and NPS.
Please read Deleting Collections and Policies from the Command Line to fully understand how removing select configuration will affect other Custom Poller configuration.
See Oid Output Format for information on changing the output format for the Expression field on MibExpressions.
Commands
batch
-
Runs the tool in batch mode with the supplied input file or \"-\" to read from standard-in. Note that in batch mode, the input file lists several other commands to perform. The entire batch operation is performed as a single database transaction, which means that if there is an error part way through the batch operation, all previous operations which had succeeded are rolled back. The error message will list the line number in the batch file that had the error.
createCollection
-
Creates a new Custom Poller Collection with the specified name and type. Refer to the Collection Type for more information on the which fields are supported for different Collection Types.
createComparisonMap
-
Creates a new Comparison Map for the specified variable. Note, Ordering must be unique per variable.
createCountThreshold
-
Creates a new Count Threshold for the specified Variable.
createMibDefinition
-
Creates a new Mib Definition. Note, Oid must be unique.
createMibExpression
-
Creates a new Mib Expression using the specified key. An Author must exist to create new Mib Expressions. Note, Key must be unique.
createPolicy
-
Creates a new Policy. A Node Group must exist to create new Policies. A Collection must have Variables before mapping to a Policy. Note, Ordering must be unique per Collection. Cannot create duplicate Policies with the same Collection and Node Group.
createReportCollection
-
Creates a new Report Collection.
createReportGroup
-
Creates a new Report Group.
createTimeThreshold
-
Creates a new Time Threshold for the specified Variable.
createVariable
-
Creates a new Variable for the specified Collection.
deleteCollection
-
Deletes either a single Collection or a list of Collections.
deleteComparisonMap
-
Deletes either a single Comparison Map or a list of Comparison Maps.
deleteCountThreshold
-
Deletes either a single Count Threshold or a list of Count Thresholds.
deleteMibDefinition
-
Deletes either a single Mib Definition or a list of Mib Definitions.
deleteMibExpression
-
Deletes either a single Mib Expression or a list of Mib Expressions.
deletePolicy
-
Deletes either a single Policy or a list of Policies.
deleteReportCollection
-
Deletes either a single Report Collection or a list of Report Collections.
deleteReportGroup
-
Deletes either a single Report Group or a list of Report Groups.
deleteTimeThreshold
-
Deletes either a single Time Threshold or a list of Time Thresholds.
deleteVariable
-
Deletes either a single Variable or a list of Variables.
enable
-
Enable Custom Poller.
disable
-
Disable Custom Poller.
listCollection
-
List Collections based on optional filters. Specifying no filters will list all Collections. All Collections matching the filter(s) will be listed. The wildcards "*" and "?" are supported.
The fields for listCollection are: uuid,name,type,filterVariable,affectNodeStatus,generateIncident,exportCollection,compressExport,incidentSource
listComparisonMap
-
List Comparison Maps based on optional filters. Specifying no filters will list all Comparison Maps. All Comparison Maps matching the filter(s) will be listed. The wildcards "*" and "?" are supported.
The fields for listComparisonMap are: uuid,variable,stateMapping,comparisonValue,comparisonOperator,ordering
listCountThreshold
-
List Count Thresholds based on optional filters. Specifying no filters will list all Count Thresholds. All Count Thresholds matching the filter(s) will be listed. The wildcards "*" and "?" are supported.
The fields for listCountThreshold are: uuid,variable,lowValue,lowValueRearm,lowState,lowTriggerCount,highValue,highValueRearm,highState,highTriggerCount
listMibDefinition
-
List Mib Definitions based on optional filters. Specifying no filters will list all Mib Definitions. All Mib Definitions matching the filter(s) will be listed. The wildcards "*" and "?" are supported.
The fields for listMibDefinition are: uuid,oid,oidType,conversionType,isTabular
listMibExpression
-
List Mib Expressions based on optional filters. Specifying no filters will list all Mib Expressions. All Mib Expressions matching the filter(s) will be listed. The wildcards "*" and "?" are supported.
The fields for listMibExpression are: key,name,desc,author,expression,displayVariable,displayFilter,conversionAlgorithm
listPolicy
-
List Policies based on optional filters. Specifying no filters will list all Policies. All Policies matching the filter(s) will be listed. The wildcards "*" and "?" are supported.
The fields for listPolicy are: uuid,name,collection,ordering,activeState,nodeGroup,filter,pollingInterval
listReportCollection
-
List Report Collections based on optional filters. Specifying no filters will list all Report Collections. All Report Collections matching the filter(s) will be listed. The wildcards "*" and "?" are supported.
The fields for listReportCollection are: uuid,reportGroup,collection
listReportGroup
-
List Report Groups based on optional filters. Specifying no filters will list all Report Groups. All Report Groups matching the filter(s) will be listed. The wildcards "*" and "?" are supported.
The fields for listReportGroup are: uuid,name
listTimeThreshold
-
List Time Thresholds based on optional filters. Specifying no filters will list all Time Thresholds. All Time Thresholds matching the filter(s) will be listed. The wildcards "*" and "?" are supported.
The fields for listTimeThreshold are: uuid,variable,lowValue,lowValueRearm,lowState,lowDuration,lowWindowDuration,highValue,highValueRearm,highState,highDuration,highWindowDuration
listVariable
-
List Variables based on optional filters. Specifying no filters will list all Variables. All Variables matching the filter(s) will be listed. The wildcards "*" and "?" are supported.
The fields for listVariable are: uuid,name,collection,mibExpression,reportDataType
status
-
The status of Custom Poller.
updateCollection
-
Update fields on a Collection.
updateComparisonMap
-
Update fields on a Comparison Map.
updateCountThreshold
-
Update fields on a Count Threshold.
updateMibDefinition
-
Update fields on a Mib Definition.
updateMibExpression
-
Update fields on a Mib Expression.
updatePolicy
-
Update fields on a Policy.
updateReportGroup
-
Update fields on a Report Group.
updateTimeThreshold
-
Update fields on a Time Threshold.
updateVariable
-
Update fields on a Variable.
Options
-activeState <
active state
>-
The Active State of the Policy (active | inactive | suspended).
-affectNodeStatus <
true|false
>-
Affect Node Status (true | false).
-author <
unique key
>-
Unique Author Key. The Author indicates who created or last modified the MIB Expression.
-collection <
name
>|<uuid
>-
The name of the Collection.
-comparisonOperator <
comparison operator
>-
Operator used to evaluate the Comparison Value and subsequently determine State (< | <= | = | != | > | >= | isNull | isNotNull | default).
-comparisonValue <
comparison value
>-
The value returned when the MIB Expression is evaluated when polled. While this is not required for default, isNull, and isNotNull, please specify any string for a fake value.
-compressExport <
true|false
>-
Compress Export File (true | false).
-conversionAlgorithm <
conversation algorithm
>-
Used to determine the display format for the Display Variable (numeric | mib_variable | alphabetic | ifname_indirect | iface_name). Configurable but not supported for Bulk collection.
-desc <
"description"
>-
The user defined description for the MIB Expression.
-displayFilter <
name
>-
The value that NNMi displays for the Display Variable is determined by the criteria you provide here. Enter a valid regular expression.
-displayVariable <
display variable
>-
Specify the MIB Variable you want to display.
-exportCollection <
true|false
>-
Export Collection (true | false).
-expression <
mib expression
>-
Specify the expression string in quotes. Refer to the Mib Expressions section for more info on how to successfully provide all necessary information.
-filter <
mib filter
>-
The MIB Filter value to be used as the filter for determining the Polling instances.
-filterVariable <
mib filter variable
>-
Required for multiple instance (repeating) MIB Variables only. The MIB Filter Variable is the MIB Variable whose value you want to use as a filter to determine which instances of the MIB Expression to Custom Poll. You must also specify a MIB Filter value when creating the associated policy.
-generateIncident <
true|false
>-
Generate Incident (true | false).
-highDuration <
high duration
>-
Designate the minimum time within which the value must remain in the High range before the threshold state changes to High and (optionally) an incident is generated. See the Specifying a Duration section to understand how to provide this information correctly.
-highState <
high state
>-
The State when the results of polling the MIB Expression exceed the specified High Value for the specified Count or Duration (normal | warning | minor | major | critical).
-highTriggerCount <
high trigger count
>-
Designate the number of consecutive polling intervals the returned value must be greater than the specified High Value to meet the threshold criteria. The default value is 1.
-highValue <
high value
>-
Designate the value that above will become a threshold situation. The appropriate value depends on the MIB Expression definition.
-highValueRearm <
high value rearm
>-
Designate the lower boundary of the High Threshold range of values. The appropriate value depends on the MIB Expression definition.
-highWindowDuration <
high window duration
>-
Designate the window of time within which the High Duration criteria must be met. See the Specifying a Duration section to understand how to provide this information correctly.
-incidentSource <
incident source object
>-
Incident Source Object (custom_code_collection | custom_polled_instance).
-isTabular <
true|false
>-
Specifies whether the MIB variable represented by the selected OID defines multiple instances grouped in a MIB table.
-key <
unique key
>-
Unique Key.
-list <
csv list of identifiers
>-
A comma separated list of identifiers for the objects. Specifying different identifier types (uuid, name, etc) per object is allowed.
-lowDuration <
low duration
>-
Designate the minimum time within which the value must remain in the Low range before the threshold state changes to Low and (optionally) an incident is generated. See the Specifying a Duration section to understand how to provide this information correctly.
-lowState <
low state
>-
The State when the results of polling the MIB Expression are below the specified Low Value for the specified Count or Duration (normal | warning | minor | major | critical).
-lowTriggerCount <
low trigger count
>-
Designate the number of consecutive polling intervals the returned value must be less than the specified Low Value to meet the threshold criteria. The default value is 1.
-lowValue <
low value
>-
Designate the value that below which indicates entering the Low range. The appropriate value depends on the MIB Expression definition.
-lowValueRearm <
lowValueRearm
>-
Designate the upper boundary of the Low Threshold range of values. The appropriate value depends on the MIB Expression definition.
-lowWindowDuration <
low window duration
>-
Designate the window of time within which the Low Duration criteria must be met. See the Specifying a Duration section to understand how to provide this information correctly.
-map <
uuid
>-
The uuid of the Comparison Map.
-mibDefinition <
oid
>|<uuid
>-
The oid or uuid of the Mib Definition.
-mibExpression <
key
>|<name
>-
The name or key of the MIB Expression.
-name <
name
>-
The name of the settings.
-nodeGroup <
name
>|<uuid
>-
The name or uuid of the Node Group to which the Policy applies.
-oid <
oid
>-
The numeric representation of the OID (Object Identification) value for an associated MIB variable.
-oidType <
oid type
>-
The base type to be used for the associated MIB variable value (integer | unsigned_integer | octet_string | counter | counter64 | gauge | time_ticks | ip_address).
-conversionType <
conversion type
>-
The conversion type to be used for the associated MIB variable value (default | bigint | long | string | hex_string | byte_array | ip_address).
-ordering <
ordering
>-
The priority ordering for the settings.
-policy <
name
>|<uuid
>-
The name or uuid of the Policy.
-pollingInterval <
polling interval
>-
The interval in which to perform the Custom Poll. Enter either a Java Duration or number of milliseconds.
-reportCollection <
uuid
>-
The uuid of the Report Collection.
-reportDataType <
report data type
>-
The data type for the Report (gauge | percent | counter | integer | string | unset).
-reportGroup <
name
>|<uuid
>-
The name or uuid of the Report Group.
-stateMapping <
state mapping
>-
The State to assign to the Polled Instance when the polled value is returned (normal | warning | minor | major | critical).
-threshold <
uuid
>-
The uuid of the Count or Time Threshold.
-type <
collection type
>-
Collection type (instance | bulk)
-uuid <
object uuid
>-
The unique object identifier.
-variable <
name
>|<uuid
>-
The name or uuid of the Variable.
Additional Parameters
-fields <
fields
>-
Selects the output fields for table data as a comma-separated list
-format <
style
>-
Sets the output format for table data; valid values are TEXT, LIST, CSV or XML.
-http.host <
host
>-
The server host; default is localhost.
-http.port <
port
>-
The server port; default is 80.
-jndiHost <
hostname
>-
The server jndi host; default is localhost
-jndiPort <
port
>-
The server jndi port; default is 1099
-p <
password
>-
The password of the user
-quiet
-
Suppresses the normal output and only print errors.
-u <
username
>-
The username to run this command
Mib Expressions
This section explains how to correctly specify the "-expression" option for Mib Expression commands.
An expression can be either a single operand OR an arithmetic expression of multiple operands.
The two halves that make up an operand is an oid and a name. The user can specify either 1) an oid, 2) a name, or 3) an oid and name. Option 1) is always successful. If the corresponding MIB is loaded, the correct name will be found. Otherwise, the name will be set to the oid. Option 2) requires the MIB to be loaded as the oid must be looked up. An error will be thrown if the MIB is not loaded. Option 3) is always successful. In all cases,the oid is not validated upon creation or modification of the Mib Expression. If the provided oid is incorrect, it will be found upon polling.
The format for an operand is: "oid:name", "oid", or "name". A colon ":" is the delimiter between the oid and name. Note: numerical constants can also be specified as operands for arithmetic expressions.
- Operand Examples:
-
oid = .1.3.6.1.2.1.2.2.1.10 --> looked up name --> .1.3.6.1.2.1.2.2.1.10:ifInOctets
oid = .1.3.6.1.2.1.2.2.1.10 --> could not find name --> .1.3.6.1.2.1.2.2.1.10:.1.3.6.1.2.1.2.2.1.10
name = ifInOctets --> looked up oid --> .1.3.6.1.2.1.2.2.1.10:ifInOctets
oid:name = .1.3.6.1.2.1.2.2.1.10:ifInOctets
constant = 0.5
Supported operators for arithmetic expressions are: "+", "-", "/", and "*". There can be any amount of whitespace or none between operands, operators, and parentheses. Operators must be explicitly defined and not implicitly inferred.
- Arithmetic Expression Examples:
-
Correctly formatted expression = ((.1.3.6.1.2.1.2.2.1.11+.1.3.6.1.2.1.31.1.1.1.5)/(.1.3.6.1.2.1.1.3*0.01))
Correctly formatted expression = ( ( .1.3.6.1.2.1.2.2.1.11 + .1.3.6.1.2.1.31.1.1.1.5 ) / ( .1.3.6.1f.2.1.1.3 * 0.01 ) )
Incorrectly defined = ( .1.3.6.1.2.1.2.2.1.11 + .1.3.6.1.2.1.31.1.1.1.5 ) 10.0
Incorrectly defined = ( .1.3.6.1.2.1.2.2.1.11 + .1.3.6.1.2.1.31.1.1.1.5 ) (10.0)
Correctly defined = ( .1.3.6.1.2.1.2.2.1.11 + .1.3.6.1.2.1.31.1.1.1.5 ) * 10.0
Collection Type
At this time, some features of Custom Poller are not supported for BULK Collections. Fields associated with these features may still be configured using this tool but will not be used. If the fields were configured and the Collection Type is changed to INSTANCE, the fields will retain their values. For more information on all the features not support for BULK Collection, please refer to the Help.
- Unsupported fields for BULK Collection:
-
Affect Node Status for Collections
Incident Generation for Collections
Thresholds for Variables
Comparison Maps for Variables
Report Groups and NPS
Caution: If you delete a Report Group, NNM iSPI Performance for Metrics removes all historical reporting data associated with that Report Group. To retain the historical reporting data, change the Active State of the associated Custom Poller policy to Suspend.
Deleting Collections and Policies from the Command Line
Caution: If you delete a Collection or Policy using the command line tool, related configuration will also be removed. This tool mimics the same functionality as the UI. When deleting a collection, all Policies, Variables, Custom Node Collections and Custom Polled Instances that were a result of the collection will also be removed. If a Policy is removed, Custom Node Collections and Custom Polled Instances are also deleted.
Specifying a Duration
A Duration can be specified either in number of milliseconds or the following format. The format should be: "PddDThhHmmMss.nnnS" where dd=days, hh=hours, mm=minutes, ss=seconds, nnn=milliSeconds.
- Examples:
-
25 minutes = 1500000 = PT25M
10 minutes 30 seconds = 630000 = PT10M30S
4 hours 30 minutes = 16200000 = PT4H30M
OID Output Format
By default, the command line output for the Expression field of a MibExpression is displayed in OID format. There is a NNM Java System Property that allows the user to change the output of the expression to instead show Object names. Set the following property to true to instead see Object names instead of OIDs.
com.hp.nnm.custompoller.nnmcustompollerconfig.sh.showObjectNameInsteadOfOid=true
- Examples:
-
Without property: (.1.3.6.1.2.1.2.2.1.10 / (.1.3.6.1.2.1.1.3 * 0.01))
With property: (ifInOctets / (sysUpTime * 0.01))
EXAMPLES
Create an Instance Collection:
nnmcustompollerconfig.sh createCollection -name "xyz instance collection" -type instance
Create a Mib Expression with a simple expression:
nnmcustompollerconfig.sh createMibExpression -key testKey -name "abc expression" -author com.customer.author -expression .1.3.6.1.2.1.2.2.1.10
Update a Policy's polling interval:
nnmcustompollerconfig.sh updatePolicy -policy "xyz policy" -pollingInterval 1500000
List all Report Collections associated with a specific Collection:
nnmcustompollerconfig.sh listReportCollection -collection abcCollection
List all Report Groups whose name starts with USA:
nnmcustompollerconfig.sh listReportGroup -name USA*
Delete a Variable:
nnmcustompollerconfig.sh deleteVariable -variable xyzVariable
We welcome your comments!
To open the configured email client on this computer, open an email window.
Otherwise, copy the information below to a web mail client, and send this email to network-management-doc-feedback@hpe.com.
Help Topic ID:
Product:
Topic Title:
Feedback: