Command-line parameters for the PI Interface for SNMP
- Last UpdatedFeb 13, 2023
- 3 minute read
- PI System
- PI Interface for SNMP 1.7.0.37
- Interfaces
These parameters are provided for debugging purposes, to help you read the file. To ensure a correctly-formatted file, use the PI Interface Configuration Utility to configure the interface. The interface also supports standard UniInt parameters. For details, refer to the PI Universal Interface (UniInt) User Guide.
Note: PI Interface for SNMP requires the instead of the default .
Interface-specific command-line parameters used in the interface startup batch file to configure settings
|
Parameter and syntax |
Description |
|---|---|
|
-cr |
Optional: If the cr parameter is specified, the interface will write Configure to rejected points. By default, the interface will not write any values to rejected points. |
|
-device=<device-spec> |
Optional: Retrieve data only from the specified device. The device can be specified as an IP address or a hostname. This parameter can be used only with a device that supports the ifAlias group. If this flag is enabled, it will also require the use of a password file. |
|
-denc |
Optional: If you have changed the Run as account, use this command line parameter to enable the interface to remove the old Run as account information from Windows Credential Manager before establishing the new Run as account and restarting the interface. Caution: Read the Note in the Install interface as Windows service topic to understand the proper procedure for changing the Run as account. |
|
-enc |
Optional: Tells the interface to use Windows Credential Manager for storage of host configuration, and deletes the password files after making updates to Windows Credential Manager. |
|
-ignoredevice=devicename |
Optional: Tells the interface to ignore the specified device(s). This switch can be used more than once on the command line, for example to exclude scan classes. The devicename can be either the name or IP address of the device. The switch supports wildcard characters (*) so multiple devices can be ignored. The wildcard can be placed at the beginning, end, or anywhere in the middle of the devicename string; and more than one wildcard character can be used. |
|
-out |
Optional: Enables SNMP SET/PI output support in the interface. If this parameter is not present, the interface rejects points whose location2 attribute is negative. Default: Do not allow output points. |
|
-port=# |
Optional: Specifies the port number that the interface uses to communicate with the SNMP enabled device. The default is 161. Default: -port=161 |
|
-pwd |
Optional: Tells the interface to either read a SNMPv1 / SNMPv2c community string or to use SNMPv3 security information from the pisnmp#.pwd file for each host configuration. Note: # in the password file name is the interface service ID. The interface updates Windows Credential Manager with the information contained in the pisnmp#.pwd file. If -enc is specified, the pisnmp#.pwd file will be deleted after updating Windows Credential Manager. |
|
-retries=# |
Optional: Specifies the number of times the interface retries its transmission of an SNMP GetRequest message to the network device. The default number of retries is 3. Default: -retries=3 |
|
-setcount=# |
Optional: Specifies the number of tags per set. When location3 is set to 1, the interface groups tags into a single request for efficiency. The default number of tags per set is 5. Default: -setcount=5 |
|
-tc=# |
Optional: The tc parameter is used to specify the number of threads used by the interface to collect data from the devices. The number of threads can range from 1 to 50. The default is 10 if the tc parameter is not specified. Default: -tc=10 |
|
-timeout=# |
Optional: Specifies the number of milliseconds that the interface will wait for a reply from the network device. The default timeout is 3000 milliseconds. If the interface does not get a reply after the specified number of retries and timeout, it writes I/O Timeout to the point(s) for that particular scan. Default: -timeout=3000 Maximum: -timeout=300000 |
Prior to version 1.3.0.0, the interface stored some of its configuration information in a file named pisnmp.ini. Later versions of the interface use this file if it is present, but settings in the startup batch file, which is maintained using PI ICU, take precedence over settings configured in pisnmp.ini.
The following table lists current command-line equivalents to the old pisnmp.ini parameters:
|
Parameter in pisnmp.ini |
Parameter in pisnmp.bat |
|---|---|
|
consecutive_timeouts= |
cto= |
|
port= |
port= |
|
retries= |
retries= |
|
tags_per_set= |
setcount= |
|
timeout= |
timeout= |