system.dnp3.freezeCounters
note
The following function uses system.dnp3 and the Legacy DNP3 driver. See system.dnp for DNP3 functions using the DNP3 driver.
This function is used in Python Scripting.
Description​
Issues a freeze command on the given counters.
Client Permission Restrictions​
Permission Type: DNP3 Management
Client access to this scripting function is blocked to users that do not meet the role/zone requirements for the above permission type. This function is unaffected when run in the Gateway scope.
Syntax​
system.dnp3.freezeCounters(deviceName, [indexes])
Parameters​
| Type | Parameter | Description |
|---|---|---|
| String | deviceName | The name of the DNP3 device driver. |
| List | indexes | A list of specific indexes on which to issue the freeze command. An empty list can be passed to freeze all counters. [optional] |
Returns​
Nothing
Scope​
Gateway, Vision Client, Perspective Session
Code Examples​
Example #1
# This example shows a request to freeze all counters in the outstation.
system.dnp3.freezeCounters("Dnp3")
Example #2
# This example shows a request to freeze counters at indexes 1, 3, and 5.
system.dnp3.freezeCounters("Dnp3", [1, 3, 5])