Documentation for PythonAPI
15.0.2py0

Attributes on Objects and Rules

Objects and rules can have attributes defined.

Attributes are arbitrary key/value pairs associated with an object/rule.

Attributes on objects/rules do not affect ruleset evaluation, and are designed to be used by integrations to assign integration specific data to objects/rules.

General recommedations for use

  • When adding attributes for integration/automation purposes, add a name prefix specific to the integration/automation prefix to avoid conflicts. E.g. to let OSS system XYZ manage an attribute called treeid, name the attribute oss-xyz-treeid.
  • When handling the objects themselves by means of integration/automation and the integration depends on objects not being handled manually, set the "automatic" attribute (see below) to True.
  • When changing existing attributes, review the information for preexisting attributes below.
  • When adding new attributes the client can be made aware of the type and long description by adding an xml file in the "Attributes" area in Fileserv.

Reserved attributes

Certain attribute names are reserved for special handling, shown below. The name is as it is displayed in the Objects & Rules editor in the client, the name to use in PythonAPI calls is in parentheses.

This object should be hidden in client (hidden)

  • Type: boolean
  • Applicability: Any object/rule

The object shall not be shown in the client interface.

Display warning when object is edited (automatic)

  • Type: boolean
  • Applicability: Any object/rule

A warning is displayed when the object is opened in the client, informing the user that the object is handled by integration/automation and may be changed without warning. This is typically used for objects managed by the PSM in integrated deployments, and is recommended to use for any object managed by an automated process.

Comments (Comments)

  • Type: string
  • Applicability: Any object/rule

Free text containing comments relevant for the object.

Procera assigned object id for service object categorization (treeid)

  • Type: string
  • Applicability: ServiceObjects

Assigned object ID for ServiceObject categorization. This is handled by the system and shall not be manually altered.

PropertyObject item decryption key index (encrypted)

  • Type: integer
  • Applicability: PropertyObjects (when encryption is used)

An index (range 1-256) to select a decryption key in a table of keys for encrypted objects.

Object should be considered a 'Subscriber' in Statistics (stats-is-subscriber)

  • Type: boolean
  • Applicability: NetObjects

This object is considered a subscriber for the purposes of accounting subscribers in statistics.

Linkspeed, Incoming (stats-linkspeed-in)

  • Type: integer
  • Applicability: NetObjects

Integer value in bps (range 1-40000000000) stating the inbound linkspeed for the object. This is used to show linkspeed related statistics.

Linkspeed, Outgoing (stats-linkspeed-out)

  • Type: integer
  • Applicability: NetObjects

Integer value in bps (range 1-40000000000) stating the outbound linkspeed for the object. This is used to show linkspeed related statistics.

VBS duration (vbs-duration)

  • Type: integer
  • Applicability: ShapingObjects (handled by internal VBS)

Integer value in seconds (range 1-5184000) stating the length of the sliding time window in VBS (only applicable for internal VBS).

VBS inbound transfer limit (x) (vbs-x-in-xfer)

  • Type: integer
  • Applicability: ShapingObjects (handled by internal VBS)

Integer value in bytes (range 0-1099511627776 with increments of 1024) stating the inbound VBS limit of the object. x is a sequence number in the set of objects that are created to implement a VBS object with multiple limits.

VBS inbound bandwidth limit (x) (vbs-x-in-speed)

  • Type: integer
  • Applicability: ShapingObjects (handled by internal VBS)

Integer value in bps (range 0-40000000000) stating the inbound speed of the VBS object when the corresponding transfer limit has been reached. x is a sequence number in the set of objects that are created to implement a VBS object with multiple limits.

VBS outbound transfer limit (x) (vbs-x-out-xfer)

  • Type: integer
  • Applicability: ShapingObjects (handled by internal VBS)

Integer value in bytes (range 0-1099511627776 with increments of 1024) stating the outbound VBS limit of the object. x is a sequence number in the set of objects that are created to implement a VBS object with multiple limits.

VBS outbound bandwidth limit (x) (vbs-x-out-speed)

  • Type: integer
  • Applicability: ShapingObjects (handled by internal VBS)

Integer value in bps (range 0-40000000000) stating the outbound speed of the VBS object when the corresponding transfer limit has been reached. x is a sequence number in the set of objects that are created to implement a VBS object with multiple limits.