Documentation for PythonAPI
22.40.00py2

ipfixobject

This module contains IpfixObject implementation.

There is no need to import this module directly. Use the methods of the Ruleset object to create and manipulate IpfixObjects.

>>> o = r.ipfixobject_add('Test Ipfix')

Classes defined here:

IpfixObject

Base class for IpfixObjects.

This class should not be instantiated and should instead be created and accessed through:

  • Ruleset.ipfixobject_add
  • Ruleset.ipfixobject_find
  • Ruleset.ipfixobject_find_id
  • Ruleset.ipfixobject_list
  • Ruleset.ipfixobject_remove

Class variables are read-only, use methods to alter the object.

Methods:
Ungrouped rename(self, newname)
Rename the current object
set_collectors(self, new_collectors)
Set 'collectors' class variable
set_templatestring(self, new_templatestring)
Set 'templatestring' class variable
Properties:
collectors Ipfix collectors
creation_date Date and time when this object was created
creator Username that created this object
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'
modification_date Date and time when this object was last modified
modified_by Username that last modified this object
name Name of the ipfix object
systemid System ID of the PacketLogic this object belongs to
templatestring Template string

rename(self, newname)

Rename the current object

destroys netobject cache

Parameters:
  • newname (str) - The name that the object should have after rename process

set_collectors(self, new_collectors)

Set 'collectors' class variable

>>> ipfixobject.set_collectors("[172.21.54.23]:4739,[172.21.54.38]:2055")
Parameters:
  • new_collectors (str ) - The collectors that should be set for the object

set_templatestring(self, new_templatestring)

Set 'templatestring' class variable

Parameters:
  • new_templatestring (str ) - The templatestring that should be set for the object

collectors

Ipfix collectors

creation_date

Date and time when this object was created

creator

Username that created this object

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.

modification_date

Date and time when this object was last modified

modified_by

Username that last modified this object

name

Name of the ipfix object

systemid

System ID of the PacketLogic this object belongs to. (Replaces machineid)

templatestring

Template string

IpfixObjectField

Undocumented!
Properties:
flags ipfix field flags
id id number of the ipfix field
name Name of the ipfix field

flags

ipfix field flags

id

id number of the ipfix field

name

Name of the ipfix field