22.40.00py2
statisticsobject
This module contains StatisticsObject implementation.
There is no need to import this module directly. Use the methods of the Ruleset object to create and manipulate StatisticsObjects.
>>> o = r.statisticsobject_add('Test Statistics')
Classes defined here:
- StatisticsObject - Base class for StatisticsObjects
StatisticsObject
Base class for StatisticsObjects.
This class should not be instantiated and should instead be created and accessed through:
- Ruleset.statisticsobject_add
- Ruleset.statisticsobject_find
- Ruleset.statisticsobject_find_id
- Ruleset.statisticsobject_list
- Ruleset.statisticsobject_remove
Class variables are read-only, use methods to alter the object.
| Methods: | ||
|---|---|---|
| Ungrouped | change(self, total_fields=None, graph_fields=None, graph_freq=None, min_bytes_in=None, min_bytes_out=None, no_root=None, so_root=None, split=None) Change properties of the statistics object |
|
| rename(self, newname) Rename the current object |
||
| Properties: | |
|---|---|
| creation_date | Date and time when this object was created |
| creator | Username that created this object |
| graph_fields | Graph fields |
| graph_freq | Graph freq |
| id | id number of this object |
| is_global | True if this object resides on another system (always false in 12.1) |
| machineid | Use of property 'machineid' is deprecated since v11.0beta5, use 'systemid' |
| min_bytes_in | Min bytes in |
| min_bytes_out | Min bytes out |
| modification_date | Date and time when this object was last modified |
| modified_by | Username that last modified this object |
| name | Name of the statistics object |
| no_root | NetObject root |
| so_root | ServiceObject root |
| split | Split string |
| systemid | System ID of the PacketLogic this object belongs to |
| total_fields | Total fields |
change(self, total_fields=None, graph_fields=None, graph_freq=None, min_bytes_in=None, min_bytes_out=None, no_root=None, so_root=None, split=None)
Change properties of the statistics object. Any unspecified (or set to
None) property will be left as is.
- total_fields (
int) - Bitwise or of one or more of: Statistics.TOTALFIELD_BYTES_IN, TOTALFIELD_AVG_LATENCY_IN, TOTALFIELD_AVG_LATENCY_OUT, TOTALFIELD_BYTES_IN, TOTALFIELD_BYTES_OUT, TOTALFIELD_BYTES_TOTAL, TOTALFIELD_CHANNEL_RX_DROPS, TOTALFIELD_CHANNEL_RX_ERRORS, TOTALFIELD_CHANNEL_RX_PACKET, TOTALFIELD_CHANNEL_RX_SPEED, TOTALFIELD_CHANNEL_TX_DROPS, TOTALFIELD_CHANNEL_TX_ERRORS, TOTALFIELD_CHANNEL_TX_PACKETS, TOTALFIELD_CHANNEL_TX_SPEED, TOTALFIELD_CONNS, TOTALFIELD_CONNS_IN, TOTALFIELD_CONNS_OUT, TOTALFIELD_CURCONNS_IN, TOTALFIELD_CURCONNS_OUT, TOTALFIELD_PKTDROPS_IN, TOTALFIELD_PKTDROPS_OUT, TOTALFIELD_QUALITY_IN, TOTALFIELD_QUALITY_IN_EXT, TOTALFIELD_QUALITY_IN_INT, TOTALFIELD_QUALITY_OUT, TOTALFIELD_QUALITY_OUT_EXT, TOTALFIELD_QUALITY_OUT_INT, TOTALFIELD_QUALITY_PKTS_IN, TOTALFIELD_QUALITY_PKTS_OUT, TOTALFIELD_RTT_IN, TOTALFIELD_RTT_OUT, TOTALFIELD_SUBITEMS, TOTALFIELD_UCONNS, TOTALFIELD_UCONNS_IN, TOTALFIELD_UCONNS_OUT
- graph_fields (
int) - Bitwise or of one or more of: Statistics.GRAPHFIELD_AVG_LATENCY_IN, GRAPHFIELD_AVG_LATENCY_OUT, GRAPHFIELD_BPS_IN, GRAPHFIELD_BPS_OUT, GRAPHFIELD_BPS_TOTAL, GRAPHFIELD_CHANNEL_RX_DROPS, GRAPHFIELD_CHANNEL_RX_ERRORS, GRAPHFIELD_CHANNEL_RX_PACKETS, GRAPHFIELD_CHANNEL_RX_SPEED, GRAPHFIELD_CHANNEL_TX_DROPS, GRAPHFIELD_CHANNEL_TX_ERRORS, GRAPHFIELD_CHANNEL_TX_PACKETS, GRAPHFIELD_CHANNEL_TX_SPEED, GRAPHFIELD_CPS, GRAPHFIELD_CPS_IN, GRAPHFIELD_CPS_OUT, GRAPHFIELD_CURCONNS_IN, GRAPHFIELD_CURCONNS_OUT, GRAPHFIELD_LINK_UTILIZATION_IN, GRAPHFIELD_LINK_UTILIZATION_OUT, GRAPHFIELD_PKTDROPS_IN, GRAPHFIELD_PKTDROPS_OUT, GRAPHFIELD_QUALITY_IN, GRAPHFIELD_QUALITY_IN_EXT, GRAPHFIELD_QUALITY_IN_INT, GRAPHFIELD_QUALITY_OUT, GRAPHFIELD_QUALITY_OUT_EXT, GRAPHFIELD_QUALITY_OUT_INT, GRAPHFIELD_QUALITY_PKTS_IN, GRAPHFIELD_QUALITY_PKTS_OUT, GRAPHFIELD_RTT_IN, GRAPHFIELD_RTT_OUT, GRAPHFIELD_SUBITEMS, GRAPHFIELD_UCPS, GRAPHFIELD_UCPS_IN, GRAPHFIELD_UCPS_OUT, GRAPH_MODE_SIZE, GRAPH_MODE_SPEED
- min_bytes_in (
long) - Minimum incoming bytes
- min_bytes_out (
long) - Minimum outgoing bytes
- split (
*char) - Distribution string
- NotImplementedError - If trying to set grap_freq, no_root or so_root
rename(self, newname)
Rename the current object
destroys netobject cache
- newname (
str) - The name that the object should have after rename process
creation_date
Date and time when this object was created
creator
Username that created this object
graph_fields
Graph fields
graph_freq
Graph freq
id
id number of this object
is_global
True if this object resides on another system (always false in 12.1)
machineid
Use of property 'machineid' is deprecated since v11.0beta5, use 'systemid' instead.
min_bytes_in
Min bytes in
min_bytes_out
Min bytes out
modification_date
Date and time when this object was last modified
modified_by
Username that last modified this object
name
Name of the statistics object
no_root
NetObject root
so_root
ServiceObject root
split
Split string
systemid
System ID of the PacketLogic this object belongs to. (Replaces machineid)
total_fields
Total fields