packetlogic2.pldb.ruleset

Add a Object to the object-tree. The type and name of the Object is determined by the path.

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.

Return a list of all divert interfaces.

>>> r.divert_iface_list()
[]

• This function requires v12.2 to v14.0. In 14.1 and newer instead use divert_label.

Returns a simple object with boolean attributes showing enabled features. The members of the object, that can be True or False, are: bgp, fw, shaping, statistics, connlog (and its alias connsearch), enterprise, monitor, divert and vbs

Create a new FlowObject in pldb

>>> r.flowobject_add('Test FlowObject', 'sourceIPv4Address,sourceTransportPort', ['ipfix', 'dump_to_disk'], '[192.168.0.1]:2055,[192.168.0.2]:2055','sourceIPv4Address', r.EXPORT_FORMAT_JSON)
<PacketLogic FlowObject 'Test FlowObject'>

• This function requires v21.xx firmware or newer.

Find a FlowObject by its name

>>> r.flowobject_find('Test FlowObject')
<PacketLogic FlowObject>

• This function requires v21.xx firmware or newer.

Find a FlowObject by its id

>>> r.flowobject_find_id(83)
<PacketLogic FlowObject>

• This function requires v21.xx firmware or newer.

Return a list of all FlowObjects.

>>> r.flowobject_list()
[<PacketLogic FlowObject>,
 <PacketLogic FlowObject>]

• This function requires v21.xx firmware or newer.

Return a list of all FlowObject fields

>>> r.flowobject_list_field()
[<PacketLogic FlowObject Field 'protocolIdentifier'>,
 <PacketLogic FlowObject Field 'sourceTransportPort'>,
 <PacketLogic FlowObject Field 'sourceIPv4Address'>,
 ...]

• This function requires v21.xx firmware or newer.

Remove FlowObject

>>> r.flowobject_add("Example")
<PacketLogic FlowObject ('Example')>
>>> r.flowobject_remove("Example")

>>> object = r.flowobject_add("Example")
>>> r.flowobject_remove(object)

• This function requires v15.0 firmware or newer.

Create a new firewall rule.

        >>> r.fwrule_add('Test', r.FWRULE_ACTION_ACCEPT, quick=True)
        <PacketLogic Rule 'Test'>

        >>> rewrite_object_id = r.object_get('/RewriteObjects/Netaccess server').id
        >>> r.fwrule_add('Test', r.FWRULE_ACTION_REWRITE, quick=True, rewrite_object=rewrite_object_id)
        <PacketLogic Rule 'Test'>

        >>> rewrite_object = r.object_get('/RewriteObjects/Netaccess server')
        >>> r.fwrule_add('Test', r.FWRULE_ACTION_REWRITE, quick=True, rewrite_object=rewrite_object)
        <PacketLogic Rule 'Test'>

@type name: C{str}
@param name: The name of the new firewall rule, a rule
with this name must not already exist.

@type action: C{int}
@param action: Action when the rule matches, one of:
FWRULE_ACTION_ACCEPT FWRULE_ACTION_REJECT,
FWRULE_ACTION_DROP, FWRULE_ACTION_REWRITE,
FWRULE_ACTION_DIVERT, FWRULE_ACTION_INJECT, FWRULE_ACTION_ENRICH.

@type quick: C{boolean}
@param quick: Give this rule the quick property.

@type log: C{int}
@param log: Log level to use for this rule. 0 = Off. 1 = Brief. 2 = Verbose

@type rewrite_object: C{int} or L{rewriteobject.RewriteObject}
@param rewrite_object: The id or the actual L{rewriteobject.RewriteObject}
                       describing what to rewrite when
                       this rule matches and action is
                       FWRULE_ACTION_REWRITE.

@type monitor_iface: C{int}
@param monitor_iface: If non zero, packets matching
                      this rule will also be sent to
                      the specified interface id. See
                      L{monitor_iface_list
                      <Ruleset.monitor_iface_list>}.

@type inject_data: C{str}
@param inject_data: The content that shall be injected for
                    FWRULE_ACTION_INJECT rules. The
                    content is usually a HTTP 307
                    redirect response.

@type divert_iface: C{int}
@param divert_iface: Interface to divert packets to when
                     using FWRULE_ACTION_DIVERT. See
                     L{divert_iface_list
                     <Ruleset.divert_iface_list>}. For
                     use with 14.0 and earlier
                     only. For 14.1 and newer use
                     divert_label instead.

@type monitor_label: C{str]
@param monitor_label: Label to monitor packets to when monitor_iface
                      is set to the index of the "Label" interface.

@type divert_label: C{str}
@param divert_label: Label to divert packets to when using FWRULE_ACTION_DIVERT.

@type enrich_object: C{int} or L{enrichobject.EnrichObject}
@param enrich_object: The id or the actual L{enrichobject.EnrichObject}
                       describing what to enrich when
                       this rule matches and action is
                       FWRULE_ACTION_ENRICH.

@returns: Created firewall rule.
@rtype: L{FwRule <plrule.FwRule>}

@raises PLDBUnsupportedInFirmware: If inject_divert_iface/monitor_label/divert_label arguments are used and firmware doesn't support them.

@attention: divert_iface parameter is replaced with divert_label in firmware v14.1 and newer.
@attention: monitor_label parameter requires v14.1 firmware or newer.
@attention: divert_label parameter requires v14.1 firmware or newer.

Find a firewallrule by name

>>> r.fwrule_find("allow all")
<PacketLogic Rule 'allow all'>

Find a firewallrule by id

>>> r.fwrule_find_id(14)
<PacketLogic Rule 'allow all'>

Return a list of all firewall rules.

>>> r.fwrule_list()
[<PacketLogic Rule '<PacketLogic Rule 'allow all'>, <PacketLogic Rule 'nxs_accept'>, <PacketLogic Rule 'Allow all DHCP'>, <PacketLogic Rule 'Netaccess redirect'>, <PacketLogic Rule 'Netaccess DHCP'>, <PacketLogic Rule 'Netaccess'>]

Remove firewall rule

>>> r.fwrule_add('Example', r.FWRULE_ACTION_ACCEPT, quick=True)
<PacketLogic Rule 'Example'>
>>> r.fwrule_remove('Example')

>>> rule = r.fwrule_add('Example', r.FWRULE_ACTION_ACCEPT, quick=True)
>>> r.fwrule_remove(rule)

Create a new IpfixObject in pldb

>>> r.ipfixobject_add('Test Ipfix', '7,8,11,12,85', '[192.168.0.1]:2055,[192.168.0.2]:2055')
<PacketLogic IpfixObject 'Test Ipfix'>

• This function requires v15.0 firmware or newer.

• collectors parameter requires v16.0 firmware or newer.

Find a ipfix object by its name

>>> r.ipfixobject_find('Test Ipfix')
<PacketLogic IpfixObject>

• This function requires v15.0 firmware or newer.

Find a ipfix object by its id

>>> r.ipfixobject_find_id(83)
<PacketLogic IpfixObject>

• This function requires v15.0 firmware or newer.

Return a list of all ipfix objects.

>>> r.ipfixobject_list()
[<PacketLogic IpfixObject>,
 <PacketLogic IpfixObject>]

• This function requires v15.0 firmware or newer.

Return a list of all ipfix fields

>>> r.ipfixobject_list_field()
[<PacketLogic IpfixObject Field 'protocolIdentifier'>,
 <PacketLogic IpfixObject Field 'sourceTransportPort'>,
 <PacketLogic IpfixObject Field 'sourceIPv4Address'>,
 ...]

• This function requires v15.0 firmware or newer.

Remove ipfix object

>>> r.ipfixobject_add("Example")
<PacketLogic IpfixObject ('Example')>
>>> r.ipfixobject_remove("Example")

>>> object = r.ipfixobject_add("Example")
>>> r.ipfixobject_remove(object)

• This function requires v15.0 firmware or newer.

Return a list of all monitor interfaces.

>>> r.monitor_iface_list()
[<PacketLogic Monitor Interface 'PCAP Writer'>, <PacketLogic Monitor Interface 'DHCP Snooper'>, <PacketLogic Monitor Interface 'RADIUS Snooper'>, <PacketLogic Monitor Interface 'PCAP-2 Writer'>]

Add an Object to the object-tree. The type and name of the Object is determined by the path.

This method finds an object by type and name.

>>> r.object_find('/NetObjects/TestObject')
<PacketLogic NetObject 'TestObject' '/NetObjects'>

>>> print r.object_find('/NetObjects/DoesNotExist')
None

It is a synonym for object_get, that soon will be deprecated.

This method finds a object by type and id number.

>>> r.object_find_id('/NetObjects', 31573)
<PacketLogic NetObject 'TestObject' '/NetObjects'>

>>> print r.object_find_id('/NetObjects', 7777777)
None

This method gets an object by type and name.

>>> r.object_get('/NetObjects/TestObject')
<PacketLogic NetObject 'TestObject' '/NetObjects'>

>>> r.object_get('/NetObjects/TestObject')
<PacketLogic NetObject 'TestObject' '/NetObjects'>

It will soon be deprecated in favour for the synonym object_find.

Lists all the Objects that match the path.

>>> r.object_list('/NetObjects')
[<PacketLogic NetObject 'Netaccess Kunder' '/NetObjects'>, <PacketLogic NetObject 'Netaccess allowed servers' '/NetObjects'>,
<PacketLogic NetObject 'nxs' '/NetObjects'>, <PacketLogic NetObject 'DummyPlaceholder' '/NetObjects'>,
<PacketLogic NetObject 'nxs_Bandbredd 2000' '/NetObjects/nxs'>, <PacketLogic NetObject 'TestObject' '/NetObjects'>,
<PacketLogic NetObject 'TestNetobject' '/NetObjects'>, <PacketLogic NetObject 'TestNetobject-Deuxe' '/NetObjects'>,
<PacketLogic NetObject 'NetintactTest' '/NetObjects'>, <PacketLogic NetObject 'Kruken' '/NetObjects/nxs'>,
<PacketLogic NetObject 'nxs_1M [3]' '/NetObjects/nxs'>, <PacketLogic NetObject 'nxs_4Mbit [2]' '/NetObjects/nxs'>,
<PacketLogic NetObject 'nxs_256kbit [1]' '/NetObjects/nxs'>]

Removes an Object and all its children.

Note that object_unlink only unlinks the current object, while object_remove also removes children. To both unlink and remove and object, you will need to call unlink for all children too.

>>> r.object_add("/NetObjects/Example")
>>> r.object_remove("/NetObjects/Example")

>>> obj = r.object_add("/NetObjects/Example")
>>> r.object_remove(obj)

Removes an Object for all firewall and shapingrules.

Note that object_unlink only unlinks the current object, while object_remove also removes children. To both unlink and remove and object, you will need to call unlink for all children too.

This method replaces unlink that will soon be deprecated.

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.

Check for any pending "New data was committed" signals, and invalidate cached objects and rules if it occurs, or force them to be invalidated with force=True. Returns True if such an exception occured (and was trapped), otherwise false. Any other exception than the PLDBError "New data comitted" or timeout will not be trapped.

>>> rs.refresh(); rs.object_add('/NetObjects/TestObject'); rs.commit()
True
<PacketLogic NetObject 'TestObject' '/NetObjects'>

Removes an Object and all its children.

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.

Create a new RuleCondition in pldb

>>> rs.rulecondition_add(rs.RULECONDITION_AND, "tesla")
<PacketLogic RuleCondition '11' 'tesla'>

• This function requires v16.0 firmware or newer.

Find a rulecondition by name

>>> rs.rulecondition_find("nisse")
<PacketLogic RuleCondition '1' 'nisse'>

• This function requires v16.0 firmware or newer.

Find a rulecondition by id

>>> rs.rulecondition_find_id(1)
<PacketLogic RuleCondition '1' 'nisse'>

• This function requires v16.0 firmware or newer.

Returns a list of ruleconditions

>>> rs.rulecondition_list()
[<PacketLogic RuleCondition '2' 'polgara'>,
<PacketLogic RuleCondition '1' 'nisse'>]

• This function requires v16.0 firmware or newer.

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.

Create a new ShapingObject in pldb

>>> r.shapingobject_add("Unlimited")
<PacketLogic ShapingObject ('Unlimited', limits=<inbound=<Unlimited>, outbound=<Unlimited>, bidir=<Unlimited>>, split=0, max_connections=0, flags=[])>
>>> so = r.shapingobject_add("Per host 1Mbps", split=r.SPLIT_LOCALHOST)
>>> so.limits.inbound.bps = 1000000
>>> so.limits.outbound.bps = 1000000
>>> so
<PacketLogic ShapingObject ('Per host 1Mbps', limits=<inbound=<bps=1000000>, outbound=<bps=1000000>, bidir=<Unlimited>>, split=1, max_connections=0, flags=[])>

• split_argument parameter requires v13.1 firmware or newer.

Find a shaping object by its name

>>> r.shapingobject_find('Unlimited')
<PacketLogic ShapingObject ('Unlimited', limits=<inbound=<Unlimited>, outbound=<Unlimited>, bidir=<Unlimited>>, split=0, max_connections=0, flags=[])>

Find a shaping object by its id

>>> r.shapingobject_find_id(83)
<PacketLogic ShapingObject ('Unlimited', limits=<inbound=<Unlimited>, outbound=<Unlimited>, bidir=<Unlimited>>, split=0, max_connections=0, flags=[])>

Return a list of all shaping objects.

>>> r.shapingobject_list()
[<PacketLogic ShapingObject ('Unlimited', limits=<inbound=<Unlimited>, outbound=<Unlimited>, bidir=<Unlimited>>, split=0, max_connections=0, flags=[])>,
 <PacketLogic ShapingObject ('Per host 1Mbps', limits=<inbound=<bps=1000000>, outbound=<bps=1000000>, bidir=<Unlimited>>, split=1, max_connections=0, flags=[])>]

Remove shaping object

>>> r.shapingobject_add("Example")
<PacketLogic ShapingObject ('Example', limits=<inbound=<Unlimited>, outbound=<Unlimited>, bidir=<Unlimited>>, split=0, max_connections=0, flags=[])>
>>> r.shapingobject_remove("Example")

>>> object = r.shapingobject_add("Example")
>>> r.shapingobject_remove(object)

Create a new shapingrule in pldb

>>> r.shapingrule_add('Example')
<PacketLogic Rule 'Example'>

>>> r.shapingrule_add('Example2', priority=9)
<PacketLogic Rule 'Example2'>

Find a shapingrule by name

>>> r.shapingrule_find('Example')
<PacketLogic Rule 'Example'>

Find a shapingrule by id

>>> r.shapingrule_find(27)
<PacketLogic Rule 'Example'>

Return a list of all shaping rules.

>>> r.shapingrule_list()
[<PacketLogic Rule 'Example'>, <PacketLogic Rule 'Example2'>]

Remove shaping rule

>>> r.shapingrule_add('Example')
<PacketLogic Rule 'Example'>
>>> r.shapingrule_remove('Example')

>>> rule = r.shapingrule_add('Example')
>>> r.shapingrule_remove(rule)

Create a new StatisticsObject in pldb

>>> s = pl.Statistics()
>>> r.statisticsobject_add('Test Statistics', 
    s.TOTALFIELD_BYTES_IN | s.TOTALFIELD_BYTES_OUT,
    s.GRAPHFIELD_BPS_IN | s.GRAPHFIELD_BPS_OUT | s.GRAPHFIELD_CPS,
    "(NEO:2(SEO))")
<PacketLogic StatisticsObject 'Test Statistics'>

• This function requires v12.0 firmware or newer.

Find a statistics object by its name

>>> r.statisticsobject_find('Test Statistics')
<PacketLogic StatisticsObject>

• This function requires v12.0 firmware or newer.

Find a statistics object by its id

>>> r.statisticsobject_find_id(83)
<PacketLogic StatisticsObject>

• This function requires v12.0 firmware or newer.

Return a list of all statistics objects.

>>> r.statisticsobject_list()
[<PacketLogic StatisticsObject>,
 <PacketLogic StatisticsObject>]

• This function requires v12.0 firmware or newer.

Remove statistics object

>>> r.statisticsobject_add("Example")
<PacketLogic StatisticsObject ('Example')>
>>> r.statisticsobject_remove("Example")

>>> object = r.statisticsobject_add("Example")
>>> r.statisticsobject_remove(object)

• This function requires v12.0 firmware or newer.

Create a new statisticsrule in pldb

>>> r.statisticsrule_add('Example')
<PacketLogic Rule 'Example'>

>>> r.statisticsrule_add('Example2', priority=20)
<PacketLogic Rule 'Example2'>

• This function requires v12.0 firmware or newer.

Find a statisticsrule by name

>>> r.statisticsrule_find('Example')
<PacketLogic Rule 'Example'>

• This function requires v12.0 firmware or newer.

Find a statisticsrule by id

>>> r.statisticsrule_find(27)
<PacketLogic Rule 'Example'>

• This function requires v12.0 firmware or newer.

Return a list of all statistics rules.

>>> r.statisticsrule_list()
[<PacketLogic Rule 'Example'>, <PacketLogic Rule 'Example2'>]

• This function requires v12.0 firmware or newer.

Remove statistics rule

>>> r.statisticsrule_add('Example')
<PacketLogic Rule 'Example'>
>>> r.statisticsrule_remove('Example')

>>> rule = r.statisticsrule_add('Example')
>>> r.statisticsrule_remove(rule)

• This function requires v12.0 firmware or newer.

Create a new TrafficObject in pldb

>>> r.trafficobject_add('Test TrafficObject', 'stats', 'service', 'bytes_in, bytes_out', ['insights', 'kafka', 'dump_to_disk'], partition_key='service', r.EXPORT_FORMAT_JSON)
<PacketLogic TrafficObject 'Test TrafficObject'>

Find a TrafficObject by its name

>>> r.trafficobject_find('Test TrafficObject')
<PacketLogic TrafficObject>

Find a TrafficObject by its id

>>> r.trafficobject_find_id(83)
<PacketLogic TrafficObject>

Return a list of all TrafficObjects.

>>> r.trafficobject_list()
[<PacketLogic TrafficObject>,
 <PacketLogic TrafficObject>]

Return a list of all TrafficObject dimensions

>>> r.trafficobject_list_dimensions()
[<PacketLogic TrafficObject Dimension 'service'>,
 ...]

Return a list of all TrafficObject metrics

>>> r.trafficobject_list_metrics()
[<PacketLogic TrafficObject Metrics 'bytes_in'>,
 ...]

Remove TrafficObject

>>> r.trafficobject_add("Example")
<PacketLogic TrafficObject ('Example')>
>>> r.trafficobject_remove("Example")

>>> object = r.trafficobject_add("Example")
>>> r.trafficobject_remove(object)

Removes an Object for all firewall and shapingrules.

This method will soon be deprecated. Use synonym object_unlink instead.

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.