packetlogic2.pldb.statistics

int.bit_length() -> int

Number of bits necessary to represent self in binary. >>> bin(37) '0b100101' >>> (37).bit_length() 6

Returns self, the complex conjugate of any int.

Immediately disconnects the resource.

After this method has been called this object becomes useless.

It may be used to force a disconnect when the garbage collector can't be trusted to do a timely disconnect.

Store the current transaction to the database.

When you do this PacketLogic will reload the ruleset. This will take a lot of CPU resources from the system, try to do this in batches.

Observe that if you don't commit the changes you've made, no other resource (including the client) will see your changes.

• message parameter is ignored in v12.1 firmware and earlier.

Invalidate all Statistics data for requested path and all its children

• This method requires firmware v13.1 or newer

List the statistics database of available statistics data.

>>> x.date_list()
['2005-12-01', '2005-12-02', '2005-12-03', '2005-12-04', '2005-12-05', '2005-12-06', '2005-12-07', '2005-12-08', '2005-12-09']

List available fields.

>>> s.fields_list()
{'graphs': [{'desc': 'Incoming bps', 'id': 1, 'type': 1},
            {'desc': 'Outgoing bps', 'id': 2, 'type': 1},
            {'desc': 'CPS', 'id': 4, 'type': 2},
            {'desc': 'Unestablished CPS', 'id': 8, 'type': 2},
            {'desc': 'Incoming CPS', 'id': 16, 'type': 2},
            {'desc': 'Outgoing CPS', 'id': 32, 'type': 2},
            {'desc': 'Unestablished Incoming CPS', 'id': 64, 'type': 2},
            {'desc': 'Unestablished Outgoing CPS', 'id': 128, 'type': 2},
            {'desc': 'Incoming concurrrent connections', 'id': 256, 'type': 2},
            {'desc': 'Outgoing concurrent connections', 'id': 512, 'type': 2},
            {'desc': 'Incoming Quality of Experience', 'id': 1024, 'type': 3},
            {'desc': 'Outgoing Quality of Experience', 'id': 2048, 'type': 3}],
 'totals': [{'desc': 'Incoming Bytes', 'id': 1, 'type': 1},
            {'desc': 'Outgoing Bytes', 'id': 2, 'type': 1},
            {'desc': 'Connections', 'id': 4, 'type': 2},
            {'desc': 'Unestablished Connections', 'id': 8, 'type': 2},
            {'desc': 'Incoming Connections', 'id': 16, 'type': 2},
            {'desc': 'Outgoing Connections', 'id': 32, 'type': 2},
            {'desc': 'Incoming Unestablished Connections', 'id': 64, 'type': 2},
            {'desc': 'Outgoing Unestablished Connections', 'id': 128, 'type': 2},
            {'desc': 'Incoming Quality of Experience', 'id': 256, 'type': 3},
            {'desc': 'Outgoing Quality of Experience', 'id': 512, 'type': 3}]}

Retrieve graph data between two dates.

>>> s.graph("2009-01-05", "2008-01-05", "/Host per services", 24, 0, s.GRAPH_MODE_SIZE)
[{'bytes out': 528960416.0, 'connections': 7485.5, 'bytes in': 95168704.0},
 {'bytes out': 503229952.0, 'connections': 7073.0, 'bytes in': 136215120.0},
 {'bytes out': 561612864.0, 'connections': 7457.75, 'bytes in': 165719856.0},
 {'bytes out': 574073536.0, 'connections': 7316.66650390625, 'bytes in': 125461376.0}, 
 {'bytes out': 575875264.0, 'connections': 7071.0, 'bytes in': 142020688.0}, 
 {'bytes out': 533374208.0, 'connections': 7379.75, 'bytes in': 128362920.0}, 
 {'bytes out': 542574656.0, 'connections': 7120.75, 'bytes in': 145863184.0}, 
 {'bytes out': 627854016.0, 'connections': 7328.91650390625, 'bytes in': 124391448.0},
 {'bytes out': 356714592.0, 'connections': 8949.1669921875, 'bytes in': 111401304.0}, 
 {'bytes out': 276146240.0, 'connections': 9937.1669921875, 'bytes in': 121161912.0}, 
 {'bytes out': 271035360.0, 'connections': 10208.8330078125, 'bytes in': 105619560.0}, 
 {'bytes out': 282889088.0, 'connections': 9836.9169921875, 'bytes in': 105585656.0}, 
 {'bytes out': 257417728.0, 'connections': 9915.75, 'bytes in': 118984736.0},
 {'bytes out': 291532384.0, 'connections': 10910.6669921875, 'bytes in': 198847856.0}, 
 {'bytes out': 281107264.0, 'connections': 10963.0830078125, 'bytes in': 96303560.0}, 
 {'bytes out': 261479232.0, 'connections': 10322.6669921875, 'bytes in': 106611800.0}, 
 {'bytes out': 365030240.0, 'connections': 10602.9169921875, 'bytes in': 233681280.0}, 
 {'bytes out': 514466784.0, 'connections': 10718.75, 'bytes in': 129939368.0},
 {'bytes out': 394594048.0, 'connections': 10602.5, 'bytes in': 128155672.0},
 {'bytes out': 1116160000.0, 'connections': 11515.25, 'bytes in': 149660416.0},
 {'bytes out': 423695584.0, 'connections': 10865.25, 'bytes in': 121420984.0},
 {'bytes out': 592000384.0, 'connections': 10532.0, 'bytes in': 228060944.0},
 {'bytes out': 623388928.0, 'connections': 9260.9169921875, 'bytes in': 198206720.0}, 
 {'bytes out': 323936608.0, 'connections': 8981.25, 'bytes in': 117023752.0}]

• pathtype parameter requires v12.0 firmware or newer.

• mode parameter requires v12.0 firmware or newer.

• replymask parameter requires v14.0 firmware or newer.

• usage_rate parameter requires v14.1 firmware or newer.

Invalidate only graph data for requested path and all its children

• This method requires firmware v13.1 or newer

List stats nodes between two dates

>>> s.list("2005-12-01", "2005-12-02", "/")
[{'name': 'HostperNO', 
        'values': {'bytes out': 4900070621184.0,
                'connections': 351976704.0, 
                'outbound Quality of Experience': 99.520118713378906, 
                'inbound Quality of Experience': 99.921859741210938, 
                'bytes in': 21536893304832.0}, 
        'flags': 3,'type': 0}, 
{'name': 'Top Sites', 
                'values': {'bytes out': 4900070621184.0, 
                        'connections':351976704.0, 
                        'bytes in':21536893304832.0},
                'flags': 3, 'type': 0}, 
{'name': 'StatsByClass', 
                'values':{'bytes out': 4888053415936.0,
                        'bytes in': 21408400801792.0},
                'flags': 3, 'type': 0}]

• pathtype parameter requires v12.0 firmware or newer.

• replymask parameter requires v14.0 firmware or newer.

List nodes with calculated duration they satisfy thresholds.

>>> s.list_duration("2010-09-08", "2010-09-08", "/All Host?/",thresholds=[(s.GRAPHFIELD_BPS_IN, 1e6,-1)])
[{'duration': 36900L, 'flags': 11, 'name': '10.93.192.16', 'type': 514},
 {'duration': 52500L, 'flags': 11, 'name': '10.93.192.17', 'type': 514},
 {'duration': 300L, 'flags': 11, 'name': '10.93.192.25', 'type': 514},
 {'duration': 49200L, 'flags': 11, 'name': '10.93.192.39', 'type': 514},
 {'duration': 600L, 'flags': 11, 'name': '10.91.91.7', 'type': 514},
 {'duration': 3900L, 'flags': 11, 'name': '10.92.97.2', 'type': 514},
 {'duration': 300L, 'flags': 11, 'name': '10.92.97.5', 'type': 514},
 {'duration': 300L, 'flags': 11, 'name': '10.92.97.10', 'type': 514},
 {'duration': 1800L, 'flags': 11, 'name': '10.92.97.18', 'type': 514},
 {'duration': 7500L, 'flags': 11, 'name': '10.92.97.25', 'type': 514},
 {'duration': 3600L, 'flags': 11, 'name': '10.92.97.26', 'type': 514},
 {'duration': 300L, 'flags': 11, 'name': '10.92.97.28', 'type': 514},
 {'duration': 2400L, 'flags': 11, 'name': '10.91.91.12', 'type': 514},
 {'duration': 3600L, 'flags': 11, 'name': '10.91.91.40', 'type': 514},
 {'duration': 1800L, 'flags': 11, 'name': '10.91.91.41', 'type': 514},
 {'duration': 69000L, 'flags': 11, 'name': '10.92.102.104', 'type': 514}]

• This function requires firmware v12.4 or newer

List top N values matching a "search string" between two dates. N = 0, will return all the matching values.

>>> res=s.list_search ("2013-10-02", "2013-10-02", "/Applications", "Sub115",)
>>> for node in res:
...     print node
...
{'values': {'bytes out': 30924881920.0, 'bytes in': 6812166656.0}, 'type': 518, 'name': '/Web Browsing?ServiceObject/HTTP?ServiceObject/Sub115?NetObject'}
{'values': {'bytes out': 10508003328.0, 'bytes in': 2729902848.0}, 'type': 518, 'name': '/Messaging and Collaboration?ServiceObject/E-mail and Calendaring?ServiceObject/SMTP-TLS?ServiceObject/Sub115?NetObject'}
{'values': {'bytes out': 2935312384.0, 'bytes in': 2098169216.0}, 'type': 518, 'name': '/Web Browsing?ServiceObject/HTTP download?ServiceObject/AN-115?NetObject'}

• This method requires firmware v15.0 or newer.

List top N subscribers between two dates (N=0, returns all subscribers)

This function exists to limit the amount of data sent between the server and the client.It returns any node which is in the top N list for each of the fields being stored.

>>> res=s.list_subscribers("2013-09-14", "2013-09-14", "/Applications?Statistics Object")
>>> for node in res:
...     print node
...
{'values': {'bytes out': 30924881920.0, 'bytes in': 6812166656.0}, 'name': 'Sub113'}
{'values': {'bytes out': 10508003328.0, 'bytes in': 2729902848.0},  'name': 'Sub5'}
{'values': {'bytes out': 2935312384.0, 'bytes in': 2098169216.0},  'name': 'Sub49'}
{'values': {'bytes out': 577248896.0, 'bytes in': 1004788544.0},  'name': 'Sub362'}
{'values': {'bytes out': 7716958720.0, 'bytes in': 923890496.0},  'name': 'Sub74'}

• pathtype parameter requires v12.0 firmware or newer.

• replymask parameter requires v14.0 firmware or newer.

• This method requires firmware v15.0.2 or newer

List the names of stats nodes between two dates

• This method requires firmware v14.0.3 or newer

Verify that a path is expandable.

• pathtype parameter requires v12.0 firmware or newer.

Send a command to server to test if it is up.

Translate protocol name OR number to tuple with name AND number. Can be used to e.g translate numerical protocol in connlog.search() result to protocol name.

An unknown protocol will be translated to e.g '#7' or -1, unless strict is set to True, in which case ValueError is raised for unknown protocols.

Returns a dictionary with name:nr and nr:name items for IP protocols. Can be used to e.g translate numerical protocol in connlog.search() result to protocol name.

Returns a dictionary with columns and row data:

{"columns": ["name", "bytes_in", "bytes_out"],
 "rows": [("461233124", 1231515, 1231451),
          ("469878922", 9879872, 3874872),
          ("469879872", 8927342, 8723423)],
 "notices": ["some message", "other message"]}

Issue the query using callbacks

Abort the current transaction and discard the data.

This will also automatically happen if your connection drops or that you exit the program without commit.

Send services to pldbd

Sets stringtable for services and properties. Do NOT use this unless you know exactly what you are doing.

List all services

List all properties.

Count number of subitems for requested path between the two dates

• This method requires firmware v13.1 or newer

Subitem count for the list of stats nodes between two dates

• This method requires firmware v13.1 or newer

Count number of subscribers for requested path between the two dates

• This function requires firmware v12.4 or newer

Retrieve subscriber count for each requested interval between two dates.

• This function requires firmware v12.4 or newer

List subscriber count for each node for requested path between the two dates

• This function requires firmware v12.4 or newer

List top N nodes between two dates

This function exists to limit the amount of data sent between the server and the client.It returns any node which is in the top N list for each of the fields being stored.

Also if the requested Statistics node contains sub-nodes of more than one type then a Top N list would be sent for each type for each field.

>>> res=s.toplist("2009-01-14", "2009-01-14", "/v11 stats", 5, s.VALUETYPE_ROOT)
>>> for node in res["Toplist, bytes in"]:
...     if node['type'] == s.VALUETYPE_SERVICE:
...             print node
... 
{'values': {'bytes out': 30924881920.0, 'bytes in': 6812166656.0}, 'type': 518, 'name': 'BitTorrent transfer'}
{'values': {'bytes out': 10508003328.0, 'bytes in': 2729902848.0}, 'type': 518, 'name': 'BitTorrent encrypted transfer'}
{'values': {'bytes out': 2935312384.0, 'bytes in': 2098169216.0}, 'type': 518, 'name': 'HTTP'}
{'values': {'bytes out': 577248896.0, 'bytes in': 1004788544.0}, 'type': 518, 'name': 'SMTP'}
{'values': {'bytes out': 7716958720.0, 'bytes in': 923890496.0}, 'type': 518, 'name': 'CIFS'}

• pathtype parameter requires v12.0 firmware or newer.

• replymask parameter requires v14.0 firmware or newer.

• offset parameter requires v15.1 firmware or newer.

Retrieves total transfer for path between two dates.

>>> r.transfer_get("2006-01-20", "2006-01-21", "/NetObjects")
{'priority': 129, 'out': 1458559580273L, 'name': '/NetObjects', 'in': 1632574443658L}

• pathtype parameter requires v12.0 firmware or newer.

• replymask parameter requires v14.0 firmware or newer.

Wait for new data to be committed on resource.

This method returns as soon as the server signals that another client has committed new data to the resource. It also periodically tests the connection to the server. If connection is broken (or any other error happens) an exception is raised.

List all XFB (Transfer Behaviour) flags, that can be used in FlagObjects.